org.bytedeco.javacpp.indexer

Class ByteIndexer

java.lang.Object

org.bytedeco.javacpp.indexer.Indexer

org.bytedeco.javacpp.indexer.ByteIndexer

Direct Known Subclasses:

ByteArrayIndexer, ByteBufferIndexer

public abstract class ByteIndexer
extends Indexer

Abstract indexer for the byte primitive type.

Author:

Samuel Audet

Field Summary

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

sizes, strides

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ByteIndexer	create(byte[] array, int[] sizes, int[] strides)
static ByteIndexer	create(ByteBuffer buffer, int[] sizes, int[] strides)
static ByteIndexer	create(BytePointer pointer, int[] sizes, int[] strides)
static ByteIndexer	create(BytePointer pointer, int[] sizes, int[] strides, boolean direct) Creates a byte indexer to access efficiently the data of a pointer.
abstract byte	get(int... indices)
abstract byte	get(int i)
ByteIndexer	get(int[] indices, byte[] b)
abstract ByteIndexer	get(int[] indices, byte[] b, int offset, int length)
ByteIndexer	get(int i, byte[] b)
abstract ByteIndexer	get(int i, byte[] b, int offset, int length)
abstract byte	get(int i, int j)
ByteIndexer	get(int i, int j, byte[] b)
abstract ByteIndexer	get(int i, int j, byte[] b, int offset, int length)
abstract byte	get(int i, int j, int k)
double	getDouble(int... indices) Calls get(int...indices) and returns the value as a double.
ByteIndexer	put(int[] indices, byte... b)
abstract ByteIndexer	put(int[] indices, byte b)
abstract ByteIndexer	put(int[] indices, byte[] b, int offset, int length)
ByteIndexer	put(int i, byte... b)
abstract ByteIndexer	put(int i, byte b)
abstract ByteIndexer	put(int i, byte[] b, int offset, int length)
ByteIndexer	put(int i, int j, byte... b)
abstract ByteIndexer	put(int i, int j, byte b)
abstract ByteIndexer	put(int i, int j, byte[] b, int offset, int length)
abstract ByteIndexer	put(int i, int j, int k, byte b)
ByteIndexer	putDouble(int[] indices, double b) Casts value to primitive type and calls put(int[] indices, <type> value).

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

array, buffer, channels, cols, height, index, release, rows, sizes, strides, toString, width

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteIndexer

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

Method Detail

create

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

Returns:

new ByteArrayIndexer(array, sizes, strides)

create

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

Returns:

new ByteBufferIndexer(buffer, sizes, strides)

create

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

Returns:

create(pointer, sizes, strides, true)

create

public static ByteIndexer create(BytePointer pointer,
                                 int[] sizes,
                                 int[] 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 array backed by a buffer or an array

get

public abstract byte get(int i)

Returns:

array/buffer[i]

get

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

Returns:

this where b = array/buffer[i]

get

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

Returns:

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

get

public abstract byte get(int i,
                         int j)

Returns:

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

get

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

Returns:

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

get

public abstract ByteIndexer get(int i,
                                int 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(int i,
                         int j,
                         int k)

Returns:

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

get

public abstract byte get(int... indices)

Returns:

array/buffer[index(indices)]

get

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

Returns:

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

get

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

Returns:

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

put

public abstract ByteIndexer put(int i,
                                byte b)

Returns:

this where array/buffer[i] = b

put

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

Returns:

this where array/buffer[i] = b

put

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

Returns:

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

put

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

Returns:

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

put

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

Returns:

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

put

public abstract ByteIndexer put(int i,
                                int 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(int i,
                                int j,
                                int k,
                                byte b)

Returns:

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

put

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

Returns:

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

put

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

Returns:

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

put

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

Returns:

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

getDouble

public double getDouble(int... 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(int[] indices,
                             double b)

Description copied from class: Indexer

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

Specified by:

putDouble in class Indexer