org.bytedeco.javacpp.indexer

Class ByteIndexer

java.lang.Object

org.bytedeco.javacpp.indexer.Indexer

org.bytedeco.javacpp.indexer.ByteIndexer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ByteArrayIndexer, ByteBufferIndexer, ByteRawIndexer

public abstract class ByteIndexer
extends Indexer

Abstract indexer for the byte primitive type.

Author:

Samuel Audet

Field Summary

Fields

Modifier and Type	Field and Description
static int	VALUE_BYTES The number of bytes used to represent a byte.

Fields inherited from class org.bytedeco.javacpp.indexer.Indexer

indexable, ONE_STRIDE, sizes, strides

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ByteIndexer(long[] sizes, long[] strides)

Method Summary

Modifier and Type	Method and Description
static ByteIndexer	create(byte[] array) Returns new ByteArrayIndexer(array)
static ByteIndexer	create(byte[] array, long[] sizes, long[] strides) Returns new ByteArrayIndexer(array, sizes, strides)
static ByteIndexer	create(ByteBuffer buffer) Returns new ByteBufferIndexer(buffer)
static ByteIndexer	create(ByteBuffer buffer, long[] sizes, long[] strides) Returns new ByteBufferIndexer(buffer, sizes, strides)
static ByteIndexer	create(BytePointer pointer) Returns create(pointer, { pointer.limit() - pointer.position() }, { 1 }, true)
static ByteIndexer	create(BytePointer pointer, long[] sizes, long[] strides) Returns create(pointer, sizes, strides, true)
static ByteIndexer	create(BytePointer pointer, long[] sizes, long[] strides, boolean direct) Creates a byte indexer to access efficiently the data of a pointer.
abstract byte	get(long... indices) Returns array/buffer[index(indices)]
abstract byte	get(long i) Returns array/buffer[i]
ByteIndexer	get(long[] indices, byte[] b) Returns this where b = array/buffer[index(indices)]
abstract ByteIndexer	get(long[] indices, byte[] b, int offset, int length) Returns this where b[offset:offset + length] = array/buffer[index(indices)]
ByteIndexer	get(long i, byte[] b) Returns this where b = array/buffer[i]
abstract ByteIndexer	get(long i, byte[] b, int offset, int length) Returns this where b[offset:offset + length] = array/buffer[i]
abstract byte	get(long i, long j) Returns array/buffer[i * strides[0] + j]
ByteIndexer	get(long i, long j, byte[] b) Returns this where b = array/buffer[i * strides[0] + j]
abstract ByteIndexer	get(long i, long j, byte[] b, int offset, int length) Returns this where b[offset:offset + length] = array/buffer[i * strides[0] + j]
abstract byte	get(long i, long j, long k) Returns array/buffer[i * strides[0] + j * strides[1] + k]
abstract char	getChar(long i) Returns the char value at array/buffer[i]
double	getDouble(long... indices) Calls get(int...indices) and returns the value as a double.
abstract double	getDouble(long i) Returns the double value at array/buffer[i]
abstract float	getFloat(long i) Returns the float value at array/buffer[i]
abstract int	getInt(long i) Returns the int value at array/buffer[i]
abstract long	getLong(long i) Returns the long value at array/buffer[i]
abstract short	getShort(long i) Returns the short value at array/buffer[i]
ByteIndexer	put(long[] indices, byte... b) Returns this where array/buffer[index(indices)] = b
abstract ByteIndexer	put(long[] indices, byte b) Returns this where array/buffer[index(indices)] = b
abstract ByteIndexer	put(long[] indices, byte[] b, int offset, int length) Returns this where array/buffer[index(indices)] = b[offset:offset + length]
ByteIndexer	put(long i, byte... b) Returns this where array/buffer[i] = b
abstract ByteIndexer	put(long i, byte b) Returns this where array/buffer[i] = b
abstract ByteIndexer	put(long i, byte[] b, int offset, int length) Returns this where array/buffer[i] = b[offset:offset + length]
ByteIndexer	put(long i, long j, byte... b) Returns this where array/buffer[i * strides[0] + j] = b
abstract ByteIndexer	put(long i, long j, byte b) Returns this where array/buffer[i * strides[0] + j] = b
abstract ByteIndexer	put(long i, long j, byte[] b, int offset, int length) Returns this where array/buffer[i * strides[0] + j] = b[offset:offset + length]
abstract ByteIndexer	put(long i, long j, long k, byte b) Returns this where array/buffer[i * strides[0] + j * strides[1] + k] = b
abstract ByteIndexer	putChar(long i, char c) Sets the char value at array/buffer[i]
ByteIndexer	putDouble(long[] indices, double b) Casts value to primitive type and calls put(long[] indices, <type> value).
abstract ByteIndexer	putDouble(long i, double d) Sets the double value at array/buffer[i]
abstract ByteIndexer	putFloat(long i, float f) Sets the float value at array/buffer[i]
abstract ByteIndexer	putInt(long i, int j) Sets the int value at array/buffer[i]
abstract ByteIndexer	putLong(long i, long j) Sets the long value at array/buffer[i]
abstract ByteIndexer	putShort(long i, short s) Sets the short value at array/buffer[i]

Methods inherited from class org.bytedeco.javacpp.indexer.Indexer

array, buffer, channels, checkIndex, close, cols, height, index, indexable, indexable, pointer, release, rows, sizes, strides, toString, width

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_BYTES

public static final int VALUE_BYTES

The number of bytes used to represent a byte.

See Also:

Constant Field Values

Constructor Detail

ByteIndexer

protected ByteIndexer(long[] sizes,
                      long[] strides)

Method Detail

create

public static ByteIndexer create(byte[] array)

Returns new ByteArrayIndexer(array)

create

public static ByteIndexer create(ByteBuffer buffer)

Returns new ByteBufferIndexer(buffer)

create

public static ByteIndexer create(BytePointer pointer)

Returns create(pointer, { pointer.limit() - pointer.position() }, { 1 }, true)

create

public static ByteIndexer create(byte[] array,
                                 long[] sizes,
                                 long[] strides)

Returns new ByteArrayIndexer(array, sizes, strides)

create

public static ByteIndexer create(ByteBuffer buffer,
                                 long[] sizes,
                                 long[] strides)

Returns new ByteBufferIndexer(buffer, sizes, strides)

create

public static ByteIndexer create(BytePointer pointer,
                                 long[] sizes,
                                 long[] strides)

Returns create(pointer, sizes, strides, true)

create

public static ByteIndexer create(BytePointer pointer,
                                 long[] sizes,
                                 long[] strides,
                                 boolean direct)

Creates a byte indexer to access efficiently the data of a pointer.

Parameters:

pointer - data to access via a buffer or to copy to an array

direct - true to use a direct buffer, see Indexer for details

Returns:

the new byte indexer backed by the raw memory interface, a buffer, or an array

get

public abstract byte get(long i)

Returns array/buffer[i]

get

public ByteIndexer get(long i,
                       byte[] b)

Returns this where b = array/buffer[i]

get

public abstract ByteIndexer get(long i,
                                byte[] b,
                                int offset,
                                int length)

Returns this where b[offset:offset + length] = array/buffer[i]

get

public abstract byte get(long i,
                         long j)

Returns array/buffer[i * strides[0] + j]

get

public ByteIndexer get(long i,
                       long j,
                       byte[] b)

Returns this where b = array/buffer[i * strides[0] + j]

get

public abstract ByteIndexer get(long i,
                                long j,
                                byte[] b,
                                int offset,
                                int length)

Returns this where b[offset:offset + length] = array/buffer[i * strides[0] + j]

get

public abstract byte get(long i,
                         long j,
                         long k)

Returns array/buffer[i * strides[0] + j * strides[1] + k]

get

public abstract byte get(long... indices)

Returns array/buffer[index(indices)]

get

public ByteIndexer get(long[] indices,
                       byte[] b)

Returns this where b = array/buffer[index(indices)]

get

public abstract ByteIndexer get(long[] indices,
                                byte[] b,
                                int offset,
                                int length)

Returns this where b[offset:offset + length] = array/buffer[index(indices)]

put

public abstract ByteIndexer put(long i,
                                byte b)

Returns this where array/buffer[i] = b

put

public ByteIndexer put(long i,
                       byte... b)

Returns this where array/buffer[i] = b

put

public abstract ByteIndexer put(long i,
                                byte[] b,
                                int offset,
                                int length)

Returns this where array/buffer[i] = b[offset:offset + length]

put

public abstract ByteIndexer put(long i,
                                long j,
                                byte b)

Returns this where array/buffer[i * strides[0] + j] = b

put

public ByteIndexer put(long i,
                       long j,
                       byte... b)

Returns this where array/buffer[i * strides[0] + j] = b

put

public abstract ByteIndexer put(long i,
                                long j,
                                byte[] b,
                                int offset,
                                int length)

Returns this where array/buffer[i * strides[0] + j] = b[offset:offset + length]

put

public abstract ByteIndexer put(long i,
                                long j,
                                long k,
                                byte b)

Returns this where array/buffer[i * strides[0] + j * strides[1] + k] = b

put

public abstract ByteIndexer put(long[] indices,
                                byte b)

Returns this where array/buffer[index(indices)] = b

put

public ByteIndexer put(long[] indices,
                       byte... b)

Returns this where array/buffer[index(indices)] = b

put

public abstract ByteIndexer put(long[] indices,
                                byte[] b,
                                int offset,
                                int length)

Returns this where array/buffer[index(indices)] = b[offset:offset + length]

getShort

public abstract short getShort(long i)

Returns the short value at array/buffer[i]

putShort

public abstract ByteIndexer putShort(long i,
                                     short s)

Sets the short value at array/buffer[i]

getInt

public abstract int getInt(long i)

Returns the int value at array/buffer[i]

putInt

public abstract ByteIndexer putInt(long i,
                                   int j)

Sets the int value at array/buffer[i]

getLong

public abstract long getLong(long i)

Returns the long value at array/buffer[i]

putLong

public abstract ByteIndexer putLong(long i,
                                    long j)

Sets the long value at array/buffer[i]

getFloat

public abstract float getFloat(long i)

Returns the float value at array/buffer[i]

putFloat

public abstract ByteIndexer putFloat(long i,
                                     float f)

Sets the float value at array/buffer[i]

getDouble

public abstract double getDouble(long i)

Returns the double value at array/buffer[i]

putDouble

public abstract ByteIndexer putDouble(long i,
                                      double d)

Sets the double value at array/buffer[i]

getChar

public abstract char getChar(long i)

Returns the char value at array/buffer[i]

putChar

public abstract ByteIndexer putChar(long i,
                                    char c)

Sets the char value at array/buffer[i]

getDouble

public double getDouble(long... indices)

Description copied from class: Indexer

Calls get(int...indices) and returns the value as a double.

Specified by:

getDouble in class Indexer

putDouble

public ByteIndexer putDouble(long[] indices,
                             double b)

Description copied from class: Indexer

Casts value to primitive type and calls put(long[] indices, <type> value).

Specified by:

putDouble in class Indexer