Indexer (JavaCPP 1.4.2 API)

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

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ByteIndexer, CharIndexer, DoubleIndexer, FloatIndexer, HalfIndexer, IntIndexer, LongIndexer, ShortIndexer, UByteIndexer, UShortIndexer
```
public abstract class Indexer
extends Object
implements 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.

Author:

Samuel Audet

See Also:

Raw

Field Summary

Fields
Modifier and Type	Field and Description
`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
Modifier and Type	Method and Description
`Object`	`array()` Returns the backing array, or `null` if none
`Buffer`	`buffer()` Returns the backing buffer, or `null` if none
`long`	`channels()` Returns `sizes[2]`
`protected static long`	`checkIndex(long i, long size)`
`void`	`close()` Calls `release()`.
`long`	`cols()` Returns `sizes[1]`
`abstract double`	`getDouble(long... indices)` Calls `get(int...indices)` and returns the value as a double.
`long`	`height()` Returns `sizes[0]`
`long`	`index(long... indices)` Computes the linear index as the dot product of indices and strides.
`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()` Returns `sizes[0]`
`long[]`	`sizes()` Returns `sizes`
`long[]`	`strides()` Returns `strides`
`String`	`toString()`
`long`	`width()` Returns `sizes[1]`

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 must hold.
  - 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()
           throws Exception
```
    Calls release().
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - sizes
```
public long[] sizes()
```
    Returns sizes
  - strides
```
public long[] strides()
```
    Returns strides
  - rows
```
public long rows()
```
    Returns sizes[0]
  - cols
```
public long cols()
```
    Returns sizes[1]
  - width
```
public long width()
```
    Returns sizes[1]
  - height
```
public long height()
```
    Returns sizes[0]
  - channels
```
public long channels()
```
    Returns sizes[2]
  - checkIndex
```
protected static final long checkIndex(long i,
                                       long size)
```
  - index
```
public long index(long... indices)
```
    Computes the linear index as the dot product of indices and strides.
    
    Parameters:
    
    indices - of each dimension
    
    Returns:
    
    index to access array or buffer
  - indexable
```
public Indexable indexable()
```
    Returns indexable.
  - indexable
```
public Indexer indexable(Indexable indexable)
```
    Sets indexable and returns this.
  - array
```
public Object array()
```
    Returns the backing array, or null if none
  - buffer
```
public 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 String toString()
```
    Overrides:
    
    toString in class Object

Class Indexer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE_STRIDE

sizes

strides

indexable

Constructor Detail

Indexer

Method Detail

close

sizes

strides

rows

cols

width

height

channels

checkIndex

index

indexable

indexable

array

buffer

pointer

release

getDouble

putDouble

toString