org.bytedeco.javacpp.indexer

Class UByteIndexer

java.lang.Object

org.bytedeco.javacpp.indexer.Indexer

org.bytedeco.javacpp.indexer.UByteIndexer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

UByteArrayIndexer, UByteBufferIndexer, UByteRawIndexer

public abstract class UByteIndexer
extends Indexer

Abstract indexer for the byte primitive type, treated as unsigned.

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	UByteIndexer(long[] sizes, long[] strides)

Method Summary

Modifier and Type	Method and Description
static UByteIndexer	create(byte[] array) Returns new ByteArrayIndexer(array)
static UByteIndexer	create(byte[] array, long[] sizes, long[] strides) Returns new ByteArrayIndexer(array, sizes, strides)
static UByteIndexer	create(ByteBuffer buffer) Returns new ByteBufferIndexer(buffer)
static UByteIndexer	create(ByteBuffer buffer, long[] sizes, long[] strides) Returns new ByteBufferIndexer(buffer, sizes, strides)
static UByteIndexer	create(BytePointer pointer) Returns create(pointer, { pointer.limit() - pointer.position() }, { 1 }, true)
static UByteIndexer	create(BytePointer pointer, long[] sizes, long[] strides) Returns create(pointer, sizes, strides, true)
static UByteIndexer	create(BytePointer pointer, long[] sizes, long[] strides, boolean direct) Creates a byte indexer to access efficiently the data of a pointer.
abstract int	get(long... indices) Returns array/buffer[index(indices)]
abstract int	get(long i) Returns array/buffer[i]
UByteIndexer	get(long[] indices, int[] b) Returns this where b = array/buffer[index(indices)]
abstract UByteIndexer	get(long[] indices, int[] b, int offset, int length) Returns this where b[offset:offset + length] = array/buffer[index(indices)]
UByteIndexer	get(long i, int[] b) Returns this where b = array/buffer[i]
abstract UByteIndexer	get(long i, int[] b, int offset, int length) Returns this where b[offset:offset + length] = array/buffer[i]
abstract int	get(long i, long j) Returns array/buffer[i * strides[0] + j]
UByteIndexer	get(long i, long j, int[] b) Returns this where b = array/buffer[i * strides[0] + j]
abstract UByteIndexer	get(long i, long j, int[] b, int offset, int length) Returns this where b[offset:offset + length] = array/buffer[i * strides[0] + j]
abstract int	get(long i, long j, long k) Returns array/buffer[i * strides[0] + j * strides[1] + k]
double	getDouble(long... indices) Calls get(int...indices) and returns the value as a double.
UByteIndexer	put(long[] indices, int... b) Returns this where array/buffer[index(indices)] = b
abstract UByteIndexer	put(long[] indices, int b) Returns this where array/buffer[index(indices)] = b
abstract UByteIndexer	put(long[] indices, int[] b, int offset, int length) Returns this where array/buffer[index(indices)] = b[offset:offset + length]
UByteIndexer	put(long i, int... b) Returns this where array/buffer[i] = b
abstract UByteIndexer	put(long i, int b) Returns this where array/buffer[i] = b
abstract UByteIndexer	put(long i, int[] b, int offset, int length) Returns this where array/buffer[i] = b[offset:offset + length]
UByteIndexer	put(long i, long j, int... b) Returns this where array/buffer[i * strides[0] + j] = b
abstract UByteIndexer	put(long i, long j, int b) Returns this where array/buffer[i * strides[0] + j] = b
abstract UByteIndexer	put(long i, long j, int[] b, int offset, int length) Returns this where array/buffer[i * strides[0] + j] = b[offset:offset + length]
abstract UByteIndexer	put(long i, long j, long k, int b) Returns this where array/buffer[i * strides[0] + j * strides[1] + k] = b
UByteIndexer	putDouble(long[] indices, double b) Casts value to primitive type and calls put(long[] indices, <type> value).

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

UByteIndexer

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

Method Detail

create

public static UByteIndexer create(byte[] array)

Returns new ByteArrayIndexer(array)

create

public static UByteIndexer create(ByteBuffer buffer)

Returns new ByteBufferIndexer(buffer)

create

public static UByteIndexer create(BytePointer pointer)

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

create

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

Returns new ByteArrayIndexer(array, sizes, strides)

create

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

Returns new ByteBufferIndexer(buffer, sizes, strides)

create

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

Returns create(pointer, sizes, strides, true)

create

public static UByteIndexer 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 int get(long i)

Returns array/buffer[i]

get

public UByteIndexer get(long i,
                        int[] b)

Returns this where b = array/buffer[i]

get

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

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

get

public abstract int get(long i,
                        long j)

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

get

public UByteIndexer get(long i,
                        long j,
                        int[] b)

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

get

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

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

get

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

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

get

public abstract int get(long... indices)

Returns array/buffer[index(indices)]

get

public UByteIndexer get(long[] indices,
                        int[] b)

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

get

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

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

put

public abstract UByteIndexer put(long i,
                                 int b)

Returns this where array/buffer[i] = b

put

public UByteIndexer put(long i,
                        int... b)

Returns this where array/buffer[i] = b

put

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

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

put

public abstract UByteIndexer put(long i,
                                 long j,
                                 int b)

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

put

public UByteIndexer put(long i,
                        long j,
                        int... b)

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

put

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

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

put

public abstract UByteIndexer put(long i,
                                 long j,
                                 long k,
                                 int b)

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

put

public abstract UByteIndexer put(long[] indices,
                                 int b)

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

put

public UByteIndexer put(long[] indices,
                        int... b)

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

put

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

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

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 UByteIndexer 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