Indexer (JavaCPP 0.10 API)

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

Direct Known Subclasses:

ByteIndexer, CharIndexer, DoubleIndexer, FloatIndexer, IntIndexer, LongIndexer, ShortIndexer
```
public abstract class Indexer
extends Object
```
Top-level class of all data indexers, providing easy-to-use and efficient multidimensional access to primitive arrays and NIO buffers.
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 double the memory usage, but is the only way to get acceptable performance on some implementations, such as Android. When direct == true, a buffer-backed indexer is returned.

Author:

Samuel Audet

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[]`	`sizes` The number of elements in each dimension.
`protected int[]`	`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(int[] sizes, int[] strides)
Constructor to set the sizes and strides.

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`array()`
`Buffer`	`buffer()`
`int`	`channels()`
`int`	`cols()`
`abstract double`	`getDouble(int... indices)` Calls `get(int...indices)` and returns the value as a double.
`int`	`height()`
`int`	`index(int... indices)` Computes the linear index as the dot product of indices and strides.
`abstract void`	`release()` Makes sure changes are reflected onto the backing memory and releases any references.
`int`	`rows()`
`int[]`	`sizes()`
`int[]`	`strides()`
`String`	`toString()`
`int`	`width()`

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

- Field Detail
  - sizes
```
protected int[] sizes
```
    The number of elements in each dimension. These values are not typically used by the indexer.
  - strides
```
protected int[] 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.
- Constructor Detail
  - Indexer
```
protected Indexer(int[] sizes,
                  int[] strides)
```
    Constructor to set the sizes and strides.
- Method Detail
  - sizes
```
public int[] sizes()
```
    Returns:
    
    sizes
  - strides
```
public int[] strides()
```
    Returns:
    
    strides
  - rows
```
public int rows()
```
    Returns:
    
    sizes[0]
  - cols
```
public int cols()
```
    Returns:
    
    sizes[1]
  - width
```
public int width()
```
    Returns:
    
    sizes[1]
  - height
```
public int height()
```
    Returns:
    
    sizes[0]
  - channels
```
public int channels()
```
    Returns:
    
    sizes[2]
  - index
```
public int index(int... 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
  - array
```
public Object array()
```
    Returns:
    
    the backing array, or null if none
  - buffer
```
public Buffer buffer()
```
    Returns:
    
    the backing buffer, or null if none
  - release
```
public abstract void release()
```
    Makes sure changes are reflected onto the backing memory and releases any references.
  - getDouble
```
public abstract double getDouble(int... indices)
```
    Calls get(int...indices) and returns the value as a double.
  - 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

sizes

strides

Constructor Detail

Indexer

Method Detail

sizes

strides

rows

cols

width

height

channels

index

array

buffer

release

getDouble

toString