org.bytedeco.javacpp.indexer

Class FloatIndexer

java.lang.Object

org.bytedeco.javacpp.indexer.Indexer

org.bytedeco.javacpp.indexer.FloatIndexer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

FloatArrayIndexer, FloatBufferIndexer, FloatRawIndexer

public abstract class FloatIndexer
extends Indexer

Abstract indexer for the float 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 float.

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

indexable, ONE_STRIDE, sizes, strides

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FloatIndexer	create(float[] array) Returns new FloatArrayIndexer(array)
static FloatIndexer	create(float[] array, long[] sizes, long[] strides) Returns new FloatArrayIndexer(array, sizes, strides)
static FloatIndexer	create(FloatBuffer buffer) Returns new FloatBufferIndexer(buffer)
static FloatIndexer	create(FloatBuffer buffer, long[] sizes, long[] strides) Returns new FloatBufferIndexer(buffer, sizes, strides)
static FloatIndexer	create(FloatPointer pointer) Returns create(pointer, { pointer.limit() - pointer.position() }, { 1 }, true)
static FloatIndexer	create(FloatPointer pointer, long[] sizes, long[] strides) Returns create(pointer, sizes, strides, true)
static FloatIndexer	create(FloatPointer pointer, long[] sizes, long[] strides, boolean direct) Creates a float indexer to access efficiently the data of a pointer.
abstract float	get(long... indices) Returns array/buffer[index(indices)]
abstract float	get(long i) Returns array/buffer[i]
FloatIndexer	get(long[] indices, float[] f) Returns this where f = array/buffer[index(indices)]
abstract FloatIndexer	get(long[] indices, float[] f, int offset, int length) Returns this where f[offset:offset + length] = array/buffer[index(indices)]
FloatIndexer	get(long i, float[] f) Returns this where f = array/buffer[i]
abstract FloatIndexer	get(long i, float[] f, int offset, int length) Returns this where f[offset:offset + length] = array/buffer[i]
abstract float	get(long i, long j) Returns array/buffer[i * strides[0] + j]
FloatIndexer	get(long i, long j, float[] f) Returns this where f = array/buffer[i * strides[0] + j]
abstract FloatIndexer	get(long i, long j, float[] f, int offset, int length) Returns this where f[offset:offset + length] = array/buffer[i * strides[0] + j]
abstract float	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.
FloatIndexer	put(long[] indices, float... f) Returns this where array/buffer[index(indices)] = f
abstract FloatIndexer	put(long[] indices, float f) Returns this where array/buffer[index(indices)] = f
abstract FloatIndexer	put(long[] indices, float[] f, int offset, int length) Returns this where array/buffer[index(indices)] = f[offset:offset + length]
FloatIndexer	put(long i, float... f) Returns this where array/buffer[i] = f
abstract FloatIndexer	put(long i, float f) Returns this where array/buffer[i] = f
abstract FloatIndexer	put(long i, float[] f, int offset, int length) Returns this where array/buffer[i] = f[offset:offset + length]
FloatIndexer	put(long i, long j, float... f) Returns this where array/buffer[i * strides[0] + j] = f
abstract FloatIndexer	put(long i, long j, float f) Returns this where array/buffer[i * strides[0] + j] = f
abstract FloatIndexer	put(long i, long j, float[] f, int offset, int length) Returns this where array/buffer[i * strides[0] + j] = f[offset:offset + length]
abstract FloatIndexer	put(long i, long j, long k, float f) Returns this where array/buffer[i * strides[0] + j * strides[1] + k] = f
FloatIndexer	putDouble(long[] indices, double f) 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 float.

See Also:

Constant Field Values

Constructor Detail

FloatIndexer

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

Method Detail

create

public static FloatIndexer create(float[] array)

Returns new FloatArrayIndexer(array)

create

public static FloatIndexer create(FloatBuffer buffer)

Returns new FloatBufferIndexer(buffer)

create

public static FloatIndexer create(FloatPointer pointer)

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

create

public static FloatIndexer create(float[] array,
                                  long[] sizes,
                                  long[] strides)

Returns new FloatArrayIndexer(array, sizes, strides)

create

public static FloatIndexer create(FloatBuffer buffer,
                                  long[] sizes,
                                  long[] strides)

Returns new FloatBufferIndexer(buffer, sizes, strides)

create

public static FloatIndexer create(FloatPointer pointer,
                                  long[] sizes,
                                  long[] strides)

Returns create(pointer, sizes, strides, true)

create

public static FloatIndexer create(FloatPointer pointer,
                                  long[] sizes,
                                  long[] strides,
                                  boolean direct)

Creates a float 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 float indexer backed by the raw memory interface, a buffer, or an array

get

public abstract float get(long i)

Returns array/buffer[i]

get

public FloatIndexer get(long i,
                        float[] f)

Returns this where f = array/buffer[i]

get

public abstract FloatIndexer get(long i,
                                 float[] f,
                                 int offset,
                                 int length)

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

get

public abstract float get(long i,
                          long j)

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

get

public FloatIndexer get(long i,
                        long j,
                        float[] f)

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

get

public abstract FloatIndexer get(long i,
                                 long j,
                                 float[] f,
                                 int offset,
                                 int length)

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

get

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

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

get

public abstract float get(long... indices)

Returns array/buffer[index(indices)]

get

public FloatIndexer get(long[] indices,
                        float[] f)

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

get

public abstract FloatIndexer get(long[] indices,
                                 float[] f,
                                 int offset,
                                 int length)

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

put

public abstract FloatIndexer put(long i,
                                 float f)

Returns this where array/buffer[i] = f

put

public FloatIndexer put(long i,
                        float... f)

Returns this where array/buffer[i] = f

put

public abstract FloatIndexer put(long i,
                                 float[] f,
                                 int offset,
                                 int length)

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

put

public abstract FloatIndexer put(long i,
                                 long j,
                                 float f)

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

put

public FloatIndexer put(long i,
                        long j,
                        float... f)

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

put

public abstract FloatIndexer put(long i,
                                 long j,
                                 float[] f,
                                 int offset,
                                 int length)

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

put

public abstract FloatIndexer put(long i,
                                 long j,
                                 long k,
                                 float f)

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

put

public abstract FloatIndexer put(long[] indices,
                                 float f)

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

put

public FloatIndexer put(long[] indices,
                        float... f)

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

put

public abstract FloatIndexer put(long[] indices,
                                 float[] f,
                                 int offset,
                                 int length)

Returns this where array/buffer[index(indices)] = f[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 FloatIndexer putDouble(long[] indices,
                              double f)

Description copied from class: Indexer

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

Specified by:

putDouble in class Indexer