dlib/dlib/java/java_array.h at master · ShuiShengYe/dlib · GitHub

Repository navigation

History

605 lines (492 loc) · 23.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

// License: Boost Software License See LICENSE.txt for the full license.

#ifndef DLIB_SWIG_JAVA_ARRAY_H_

#define DLIB_SWIG_JAVA_ARRAY_H_

This file defines three special classes: array, array_view, and array_view_crit. An

array is a simple opaque handle to a java array, like a double[] array. The array_view

and array_view_crit objects allow you to access the contents of an array. The

interfaces of these objects is shown below, but for an example use, suppose you had an

array of int in java and you wanted to pass it to C++. You could create a C++ function

like this:

void my_function(const array_view<int32_t>& array);

and then within java you could call it with code like this:

int[] array = new int[100];

my_function(array);

and it will work just like you would expect. The array_view<int32_t> will usually result in

the JVM doing a copy in the background. However, you can also declare your function

like this:

void my_function(const array_view_crit<int32_t>& array);

and still call it the same way in java, however, using array_view_crit<int32_t> will usually

not result in any copying, and is therefore very fast. array_view_crit uses the JNI

routine GetPrimitiveArrayCritical() to get a lock on the java memory underlying the

array. So it will probably prevent the garbage collector from running while your

function is executing. The JNI documentation is somewhat vague on the limitations of

GetPrimitiveArrayCritical(), saying only that you shouldn't hold the lock on the array

for "an extended period" or call back into the JVM. Deciding whether or not this

matters in your application is left as an exercise for the reader.

There are two ways you can declare your methods if they take an array_view or

array_view_crit. Taking a const reference or a non-const reference. E.g.

void my_function(const array_view<int32_t>& array);

void my_function(array_view<int32_t>& array);

You can't declare them to be by value. The non-const version allows you to modify the

contents of the array and the modifications will be visible to java, as you would

expect. You can also make functions that take array objects directly, but that's only

useful if you want to store the array handle somewhere, like in a member of a long

lived class. You can also write functions that return arrays back to java. E.g.

array<int32_t> make_an_array(size_t s)

{

array<int32_t> arr(s);

array_view<int32_t> aview(arr);

// Use aview to put data into the array and generally do something useful.

...

return arr;

}

This would create an array and return it as a java int[] array.

You can also of course use functions taking many arguments, as is normally the case

with SWIG. Finally, these classes work with the following primitive types:

- int16_t

- int32_t

- int64_t

- char (corresponding to java byte)

- float

- double

namespace java

{

template <typename T>

class array

{

/!*

WHAT THIS OBJECT REPRESENTS

This is a handle to a java array. I.e. a reference to an array instance in

java like a double[] or int[]. It doesn't do anything other than tell you

the size of the array and allow you to hold a reference to it.

To access the array contents, you need to create an array_view or

array_view_crit from the array.

*!/

public:

array();

/!*

ensures

- #size() == 0

- this array is a null reference, i.e. it doesn't reference any array.

*!/

explicit array(size_t new_size);

/!*

ensures

- #size() == new_size

- Allocates a new java array.

- This array is a reference to the newly allocated java array object.

*!/

size_t size() const;

/!*

ensures

- returns the number of elements in this java array.

*!/

void swap(array& item);

/!*

ensures

- swaps the state of *this and item.

*!/

array(const array& item);

array& operator= (const array& item)

array(array&& item);

array& operator= (array&& item);

/!*

ensures

- The array is copyable, assignable, and movable. All copies will

reference the same underlying array. So the copies are shallow, as is

normally the case with java reference semantics.

*!/

};

template <typename T>

class array_view

{

/!*

WHAT THIS OBJECT REPRESENTS

This is a view into a java array object. It allows you to access the

values stored in an array and modify them if you want to.

You should only create array_view objects locally in a function since an

array_view is only valid as long as the array it references exists. So

don't store array_view objects in the member area of a class or globally.

*!/

public:

array_view();

/!*

ensures

- #size() == 0

- #data() == nullptr

*!/

array_view(const array<T>& arr, bool might_be_modified=true);

/!*

ensures

- #size() == arr.size()

- #data() == a pointer to the beginning of the array data referenced by arr.

- When you get a view on a java array, sometimes the JVM will actually

give you a pointer to a copy of the original array. You therefore have

to tell the JVM if you modified the array when you are done using it. If

you say you modified it then the JVM will perform another copy from your

memory buffer back into the JVM. The state of might_be_modified controls

if we do this. So if you are going to modify the array via this

array_view you should set might_be_modified==true.

*!/

size_t size() const;

/!*

ensures

- returns the number of elements in this java array.

*!/

T* data();

const T* data() const;

/!*

ensures

- returns a pointer to the beginning of the array. Or nullptr if this is a

handle to null, rather than an actual array instance.

*!/

T* begin();

T* end();

const T* begin() const;

const T* end() const;

/!*

ensures

- returns iterators to the start and one-past-the-end of the array, as is

the convention for iterator ranges in C++.

*!/

T& operator[](size_t i);

const T& operator[](size_t i) const;

/!*

ensures

- returns data()[i]

*!/

private:

// this object is non-copyable.

array_view(const array_view&);

array_view& operator=(const array_view&);

};

template <typename T>

class array_view_crit

{

/!*

WHAT THIS OBJECT REPRESENTS

This is just like an array_view and has an identical interface. The only

difference is that we use the JNI call GetPrimitiveArrayCritical() to get a

critical lock on the array's memory. Therefore, using array_view_crit is

usually faster than array_view since it avoids any unnecessary copying back

and forth between the JVM.

However, this critical lock can block the JVM's garbage collector from

running. So don't create long lived array_view_crit objects.

*!/

};

}

// ----------------------------------------------------------------------------------------

// IMPLEMENTATION DETAILS

// ----------------------------------------------------------------------------------------

namespace java

{

template <typename T>

class array_view_base

{

public:

array_view_base() = default;

size_t size() const { return sz; }

T* data() { return pdata; }

const T* data() const { return pdata; }

T* begin() { return pdata; }

T* end() { return pdata+sz; }

const T* begin() const { return pdata; }

const T* end() const { return pdata+sz; }

T& operator[](size_t i) { return pdata[i]; }

const T& operator[](size_t i) const { return pdata[i]; }

protected:

T* pdata = nullptr;

size_t sz = 0;

private:

// this object is non-copyable

array_view_base(const array_view_base&);

array_view_base& operator=(const array_view_base&);

};

// ----------------------------------------------------------------------------------------

template <typename T>

struct find_java_array_type;

template <> struct find_java_array_type<int16_t> { typedef jshortArray type; };

template <> struct find_java_array_type<int32_t> { typedef jintArray type; };

template <> struct find_java_array_type<int64_t> { typedef jlongArray type; };

template <> struct find_java_array_type<char> { typedef jbyteArray type; };

template <> struct find_java_array_type<float> { typedef jfloatArray type; };

template <> struct find_java_array_type<double> { typedef jdoubleArray type; };

jshortArray create_java_array(int16_t, size_t size) { return JNI_GetEnv()->NewShortArray(size); }

jintArray create_java_array(int32_t, size_t size) { return JNI_GetEnv()->NewIntArray(size); }

jlongArray create_java_array(int64_t, size_t size) { return JNI_GetEnv()->NewLongArray(size); }

jbyteArray create_java_array(char, size_t size) { return JNI_GetEnv()->NewByteArray(size); }

jfloatArray create_java_array(float, size_t size) { return JNI_GetEnv()->NewFloatArray(size); }

jdoubleArray create_java_array(double , size_t size) { return JNI_GetEnv()->NewDoubleArray(size); }

template <typename T>

class array

{

public:

typedef typename find_java_array_type<T>::type java_type;

array() {}

explicit array(size_t size)

{

ref = create_java_array(T(),size);

is_global_ref = false;

}

array(java_type ref_)

{

if (ref_)

{

ref = (java_type)JNI_GetEnv()->NewGlobalRef(ref_);

is_global_ref = true;

}

#ifndef SWIG

array(array&& item)

{

ref = item.ref;

is_global_ref = item.is_global_ref;

item.ref = NULL;

item.is_global_ref = false;

}

array& operator= (array&& item)

{

array(std::move(item)).swap(*this);

return *this;

}

#endif

~array()

{

if (ref)

{

// Don't delete the reference if it's a local reference, since the only reason

// we will normally be using array object's that contain local references

// is because we plan on returning the newly constructed array back to the JVM,

// which automatically frees local references using the normal JVM garbage

// collection scheme.

if (is_global_ref)

JNI_GetEnv()->DeleteGlobalRef(ref);

ref = NULL;

is_global_ref = false;

}

size_t size() const

{

if (ref)

return JNI_GetEnv()->GetArrayLength(ref);

else

return 0;

}

array(const array& item)

{

array(item.ref).swap(*this);

}

array& operator= (const array& item)

{

array(item).swap(*this);

return *this;

}

operator java_type() const { return ref;}

void swap(array& item)

{

std::swap(ref, item.ref);

std::swap(is_global_ref, item.is_global_ref);

}

private:

java_type ref = NULL;

bool is_global_ref = false;

};

#ifdef SWIG

// Tell SWIG to not use it's SwigValueWrapper stuff on array objects since they aren't

// needed and it causes superfluous construction and destruction of array objects.

%feature("novaluewrapper") array<int16_t>;

%template() array<int16_t>;

%feature("novaluewrapper") array<int32_t>;

%template() array<int32_t>;

%feature("novaluewrapper") array<int64_t>;

%template() array<int64_t>;

%feature("novaluewrapper") array<char>;

%template() array<char>;

%feature("novaluewrapper") array<float>;

%template() array<float>;

%feature("novaluewrapper") array<double>;

%template() array<double>;

#endif

#ifdef SWIG

%define tostring(token)

#token

%enddef

%define define_javaObjectRef_converion(type, java_type)

// Define array conversions for non-const arrays

%typemap(jtype) (array<type>) "java_type[]"

%typemap(jstype) (array<type>) "java_type[]"

%typemap(jni) (array<type>) tostring(j##java_type##Array)

%typemap(javain) (array<type>) "$javainput"

%typemap(in) (array<type>) { $1 = java::array<type>($input); }

%typemap(javaout) (array<type>) {return $jnicall; }

%typemap(out) (array<type>) {jresult = result;}

%typemap(jtype) (array<type>&) "java_type[]"

%typemap(jstype) (array<type>&) "java_type[]"

%typemap(jni) (array<type>&) tostring(j##java_type##Array)

%typemap(javain) (array<type>&) "$javainput"

%typemap(arginit) (array<type>&) { $1 = &temp$argnum; }

%typemap(in) (array<type>&) (java::array<type> temp) { *($1) = java::array<type>($input); }

%typemap(jtype) (const array<type>&) "java_type[]"

%typemap(jstype) (const array<type>&) "java_type[]"

%typemap(jni) (const array<type>&) tostring(j##java_type##Array)

%typemap(javain) (const array<type>&) "$javainput"

%typemap(arginit) (const array<type>&) { $1 = &temp$argnum; }

%typemap(in) (const array<type>&) (java::array<type> temp) { *($1) = java::array<type>($input); }

%enddef

define_javaObjectRef_converion(int16_t,short)

define_javaObjectRef_converion(int32_t,int)

define_javaObjectRef_converion(int64_t,long)

define_javaObjectRef_converion(char,byte)

define_javaObjectRef_converion(float,float)

define_javaObjectRef_converion(double,double)

#endif

// ----------------------------------------------------------------------------------------

template <typename T> class array_view;

#define JAVA_ARRAY_CLASS_SPEC(ctype, type, Type) \

template <> class array_view<ctype> : public array_view_base<ctype> \

{ \

public: \

~array_view() { clear(); } \

array_view() {} \

array_view(const array<ctype>& arr, bool might_be_modified_=true){reset(JNI_GetEnv(),arr,might_be_modified_);} \

void reset(JNIEnv* jenv_, j##type##Array arr, bool might_be_modified_) { \

clear(); \

jenv = jenv_; \

oldArr = arr; \

if (arr) { \

pdata = (ctype*)jenv->Get##Type##ArrayElements(arr, 0); \

sz = jenv->GetArrayLength(arr); \

} \

might_be_modified = might_be_modified_; \

} \

private: \

void clear() { \

if (pdata) { \

jenv->Release##Type##ArrayElements(oldArr, (j##type*)pdata, might_be_modified?0:JNI_ABORT); \

pdata = nullptr; \

sz = 0; \

} \

JNIEnv* jenv = nullptr; \

j##type##Array oldArr; \

bool might_be_modified; \

};

JAVA_ARRAY_CLASS_SPEC(int16_t,short, Short)

JAVA_ARRAY_CLASS_SPEC(int32_t,int, Int)

JAVA_ARRAY_CLASS_SPEC(int64_t,long, Long)

JAVA_ARRAY_CLASS_SPEC(char,byte, Byte)

JAVA_ARRAY_CLASS_SPEC(float,float, Float)

JAVA_ARRAY_CLASS_SPEC(double,double, Double)

// ----------------------------------------------------------------------------------------

template <typename T, typename JARR>

class array_view_crit_base

{

public:

array_view_crit_base() = default;

size_t size() const { return sz; }

T* data() { return pdata; }

const T* data() const { return pdata; }

T* begin() { return pdata; }

T* end() { return pdata+sz; }

const T* begin() const { return pdata; }

const T* end() const { return pdata+sz; }

T& operator[](size_t i) { return pdata[i]; }

const T& operator[](size_t i) const { return pdata[i]; }

~array_view_crit_base() { clear(); }

void reset(JNIEnv* jenv_, JARR arr, bool might_be_modified_)

{

clear();

jenv = jenv_;

oldArr = arr;

if (arr)

{

pdata = (T*)jenv->GetPrimitiveArrayCritical(arr, 0);

sz = jenv->GetArrayLength(arr);

}

might_be_modified = might_be_modified_;

}

private:

void clear()

{

if (pdata) {

jenv->ReleasePrimitiveArrayCritical(oldArr, pdata, might_be_modified?0:JNI_ABORT);

pdata = nullptr;

sz = 0;

}

// this object is non-copyable

array_view_crit_base(const array_view_crit_base&);

array_view_crit_base& operator=(const array_view_crit_base&);

T* pdata = nullptr;

size_t sz = 0;

JNIEnv* jenv = nullptr;

JARR oldArr;

bool might_be_modified;

};

template <typename T> class array_view_crit;

template <> class array_view_crit<int16_t> : public array_view_crit_base<int16_t,jshortArray> { public: array_view_crit(){} array_view_crit(const array<int16_t>& arr, bool might_be_modified_=true){reset(JNI_GetEnv(),arr,might_be_modified_);} };

template <> class array_view_crit<int32_t> : public array_view_crit_base<int32_t,jintArray> { public: array_view_crit(){} array_view_crit(const array<int32_t>& arr, bool might_be_modified_=true){reset(JNI_GetEnv(),arr,might_be_modified_);} };

template <> class array_view_crit<int64_t> : public array_view_crit_base<int64_t,jlongArray> { public: array_view_crit(){} array_view_crit(const array<int64_t>& arr, bool might_be_modified_=true){reset(JNI_GetEnv(),arr,might_be_modified_);} };

template <> class array_view_crit<char> : public array_view_crit_base<char,jbyteArray> { public: array_view_crit(){} array_view_crit(const array<char>& arr, bool might_be_modified_=true){reset(JNI_GetEnv(),arr,might_be_modified_);} };

template <> class array_view_crit<float> : public array_view_crit_base<float,jfloatArray> { public: array_view_crit(){} array_view_crit(const array<float>& arr, bool might_be_modified_=true){reset(JNI_GetEnv(),arr,might_be_modified_);} };

template <> class array_view_crit<double> : public array_view_crit_base<double,jdoubleArray> { public: array_view_crit(){} array_view_crit(const array<double>& arr, bool might_be_modified_=true){reset(JNI_GetEnv(),arr,might_be_modified_);} };

// ----------------------------------------------------------------------------------------

// Define SWIG typemaps so SWIG will know what to do with the array_view and array_view_crit

// objects.

#ifdef SWIG

%define define_array_converion(type, java_type)

// Define array conversions for non-const arrays

%typemap(jtype) (array_view<type>&) "java_type[]"

%typemap(jstype) (array_view<type>&) "java_type[]"

%typemap(jni) (array_view<type>&) tostring(j##java_type##Array)

%typemap(javain) (array_view<type>&) "$javainput"

%typemap(arginit) (array_view<type>&) { $1 = &temp$argnum; }

%typemap(in) (array_view<type>&) (java::array_view<type> temp) { $1->reset(jenv, $input, true); }

%typemap(jtype) (const array_view<type>&) "java_type[]"

%typemap(jstype) (const array_view<type>&) "java_type[]"

%typemap(jni) (const array_view<type>&) tostring(j##java_type##Array)

%typemap(javain) (const array_view<type>&) "$javainput"

%typemap(arginit) (const array_view<type>&) { $1 = &temp$argnum; }

%typemap(in) (const array_view<type>&) (java::array_view<type> temp) { $1->reset(jenv, $input, false); }

%enddef

define_array_converion(int16_t,short)

define_array_converion(int32_t,int)

define_array_converion(int64_t,long)

define_array_converion(char,byte)

define_array_converion(float,float)

define_array_converion(double,double)

%define define_array_crit_converion(type, java_type)

// Define array conversions for non-const arrays

%typemap(jtype) (array_view_crit<type>&) "java_type[]"

%typemap(jstype) (array_view_crit<type>&) "java_type[]"

%typemap(jni) (array_view_crit<type>&) tostring(j##java_type##Array)

%typemap(javain) (array_view_crit<type>&) "$javainput"

%typemap(arginit) (array_view_crit<type>&) { $1 = &temp$argnum; }

%typemap(in) (array_view_crit<type>&) (java::array_view_crit<type> temp) { $1->reset(jenv, $input, true); }

%typemap(jtype) (const array_view_crit<type>&) "java_type[]"

%typemap(jstype) (const array_view_crit<type>&) "java_type[]"

%typemap(jni) (const array_view_crit<type>&) tostring(j##java_type##Array)

%typemap(javain) (const array_view_crit<type>&) "$javainput"

%typemap(arginit) (const array_view_crit<type>&) { $1 = &temp$argnum; }

%typemap(in) (const array_view_crit<type>&) (java::array_view_crit<type> temp) { $1->reset(jenv, $input, false); }

%enddef

define_array_crit_converion(int16_t,short)

define_array_crit_converion(int32_t,int)

define_array_crit_converion(int64_t,long)

define_array_crit_converion(char,byte)

define_array_crit_converion(float,float)

define_array_crit_converion(double,double)

#endif // SWIG

}

#endif // DLIB_SWIG_JAVA_ARRAY_H_

dlib/dlib/java/java_array.h at master · ShuiShengYe/dlib · GitHub

Repository navigation

Expand file tree

Breadcrumbs

java_array.h

Latest commit

History

Breadcrumbs

java_array.h

File metadata and controls