Indexer (gradle-javacpp-plugin 1.0.11 API)

java.lang.Object
- org.bytedeco.javacpp.indexer.Indexer

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

Bfloat16Indexer, BooleanIndexer, ByteIndexer, CharIndexer, DoubleIndexer, FloatIndexer, HalfIndexer, IntIndexer, LongIndexer, ShortIndexer, UByteIndexer, UIntIndexer, ULongIndexer, UShortIndexer
```
public abstract class Indexer
extends java.lang.Object
implements java.lang.AutoCloseable
```
Top-level class of all data indexers, providing easy-to-use and efficient multidimensional access to primitive arrays, NIO buffers, and the raw memory interface.
Subclasses have create() factory methods for arrays, buffers, and pointers. The latter ones feature a direct argument that, when set to false, instructs the method to create a large enough array, fill its content with the data from the pointer, and return an array-backed indexer, with the release() method overridden to write back changes to the pointer. This doubles the memory usage, but is the only way to get acceptable performance on some implementations, such as Android. When direct == true, the raw memory interface (supporting long indexing) is used if available, and if not a buffer-backed indexer is returned.

See Also:

Raw

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class Indexer.Index

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Indexer.Index`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Indexer.Index`	`index`
`protected Indexable`	`indexable` The associated (optional) `Indexable`.
`protected static long[]`	`ONE_STRIDE`
`protected long[]`	`sizes` The number of elements in each dimension.
`protected long[]`	`strides` The number of elements to skip to reach the next element in a given dimension.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Indexer(long[] sizes, long[] strides)
Constructor to set the sizes and strides.

Constructors
Modifier	Constructor and Description
`protected`	`Indexer(long[] sizes, long[] strides)` Constructor to set the `sizes` and `strides`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`array()` Returns the backing array, or `null` if none
`java.nio.Buffer`	`buffer()` Returns the backing buffer, or `null` if none
`long`	`channels()` Deprecated.
`protected static long`	`checkIndex(long i, long size)`
`void`	`close()` Calls `release()`.
`long`	`cols()` Deprecated.
`abstract double`	`getDouble(long... indices)` Calls `get(int...indices)` and returns the value as a double.
`long`	`height()` Deprecated.
`long`	`index(long... indices)` Returns `index.index(indices)`.
`long`	`index(long i)` Returns `index.index(i)`.
`long`	`index(long i, long j)` Returns `index.index(i, j)`.
`long`	`index(long i, long j, long k)` Returns `index.index(i, j, k)`.
`Indexable`	`indexable()` Returns `indexable`.
`Indexer`	`indexable(Indexable indexable)` Sets `indexable` and returns this.
`Pointer`	`pointer()` Returns the backing pointer, or `null` if none
`abstract Indexer`	`putDouble(long[] indices, double value)` Casts value to primitive type and calls `put(long[] indices, <type> value)`.
`abstract void`	`release()` Makes sure changes are reflected onto the backing memory and clears any references.
`long`	`rows()` Deprecated.
`long`	`size(int i)` Returns `sizes[i]`
`long[]`	`sizes()` Returns `sizes`
`long`	`stride(int i)` Returns `strides[i]`
`long[]`	`strides()` Returns `strides`
`static long[]`	`strides(long... sizes)` Returns default (row-major contiguous) strides for the given sizes.
`java.lang.String`	`toString()`
`long`	`width()` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ONE_STRIDE
```
protected static final long[] ONE_STRIDE
```
  - sizes
```
protected long[] sizes
```
    The number of elements in each dimension. These values are not typically used by the indexer.
  - strides
```
protected long[] strides
```
    The number of elements to skip to reach the next element in a given dimension. strides[i] > strides[i + 1] && strides[strides.length - 1] == 1 preferred.
  - index
```
protected Indexer.Index index
```
  - indexable
```
protected Indexable indexable
```
    The associated (optional) Indexable.
- Constructor Detail
  - Indexer
```
protected Indexer(long[] sizes,
                  long[] strides)
```
    Constructor to set the sizes and strides.
- Method Detail
  - close
```
public void close()
```
    Calls release().
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - sizes
```
public long[] sizes()
```
    Returns sizes
  - strides
```
public long[] strides()
```
    Returns strides
  - size
```
public long size(int i)
```
    Returns sizes[i]
  - stride
```
public long stride(int i)
```
    Returns strides[i]
  - rows
```
@Deprecated
public long rows()
```
    Deprecated.
    
    Returns sizes.length > 0 && sizes.length < 4 ? sizes[0] : -1
  - cols
```
@Deprecated
public long cols()
```
    Deprecated.
    
    Returns sizes.length > 1 && sizes.length < 4 ? sizes[1] : -1
  - width
```
@Deprecated
public long width()
```
    Deprecated.
    
    Returns sizes.length > 1 && sizes.length < 4 ? sizes[1] : -1
  - height
```
@Deprecated
public long height()
```
    Deprecated.
    
    Returns sizes.length > 0 && sizes.length < 4 ? sizes[0] : -1
  - channels
```
@Deprecated
public long channels()
```
    Deprecated.
    
    Returns sizes.length > 2 && sizes.length < 4 ? sizes[2] : -1
  - checkIndex
```
protected static final long checkIndex(long i,
                                       long size)
```
  - strides
```
public static long[] strides(long... sizes)
```
    Returns default (row-major contiguous) strides for the given sizes.
  - index
```
public long index(long i)
```
    Returns index.index(i).
  - index
```
public long index(long i,
                  long j)
```
    Returns index.index(i, j).
  - index
```
public long index(long i,
                  long j,
                  long k)
```
    Returns index.index(i, j, k).
  - index
```
public long index(long... indices)
```
    Returns index.index(indices).
  - indexable
```
public Indexable indexable()
```
    Returns indexable.
  - indexable
```
public Indexer indexable(Indexable indexable)
```
    Sets indexable and returns this.
  - array
```
public java.lang.Object array()
```
    Returns the backing array, or null if none
  - buffer
```
public java.nio.Buffer buffer()
```
    Returns the backing buffer, or null if none
  - pointer
```
public Pointer pointer()
```
    Returns the backing pointer, or null if none
  - release
```
public abstract void release()
```
    Makes sure changes are reflected onto the backing memory and clears any references.
  - getDouble
```
public abstract double getDouble(long... indices)
```
    Calls get(int...indices) and returns the value as a double.
  - putDouble
```
public abstract Indexer putDouble(long[] indices,
                                  double value)
```
    Casts value to primitive type and calls put(long[] indices, <type> value).
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Indexer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE_STRIDE

sizes

strides

index

indexable

Constructor Detail

Indexer

Method Detail

close

sizes

strides

size

stride

rows

cols

width

height

channels

checkIndex

strides

index

index

index

index

indexable

indexable

array

buffer

pointer

release

getDouble

putDouble

toString