org.bytedeco.javacpp.indexer

Class CharIndexer

java.lang.Object

org.bytedeco.javacpp.indexer.Indexer

org.bytedeco.javacpp.indexer.CharIndexer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

CharArrayIndexer, CharBufferIndexer, CharRawIndexer

public abstract class CharIndexer
extends Indexer

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

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

indexable, ONE_STRIDE, sizes, strides

Constructor Summary

Constructors

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

Method Summary

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

See Also:

Constant Field Values

Constructor Detail

CharIndexer

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

Method Detail

create

public static CharIndexer create(char[] array)

Returns new CharArrayIndexer(array)

create

public static CharIndexer create(CharBuffer buffer)

Returns new CharBufferIndexer(buffer)

create

public static CharIndexer create(CharPointer pointer)

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

create

public static CharIndexer create(char[] array,
                                 long[] sizes,
                                 long[] strides)

Returns new CharArrayIndexer(array, sizes, strides)

create

public static CharIndexer create(CharBuffer buffer,
                                 long[] sizes,
                                 long[] strides)

Returns new CharBufferIndexer(buffer, sizes, strides)

create

public static CharIndexer create(CharPointer pointer,
                                 long[] sizes,
                                 long[] strides)

Returns create(pointer, sizes, strides, true)

create

public static CharIndexer create(CharPointer pointer,
                                 long[] sizes,
                                 long[] strides,
                                 boolean direct)

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

get

public abstract char get(long i)

Returns array/buffer[i]

get

public CharIndexer get(long i,
                       char[] c)

Returns this where c = array/buffer[i]

get

public abstract CharIndexer get(long i,
                                char[] c,
                                int offset,
                                int length)

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

get

public abstract char get(long i,
                         long j)

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

get

public CharIndexer get(long i,
                       long j,
                       char[] c)

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

get

public abstract CharIndexer get(long i,
                                long j,
                                char[] c,
                                int offset,
                                int length)

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

get

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

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

get

public abstract char get(long... indices)

Returns array/buffer[index(indices)]

get

public CharIndexer get(long[] indices,
                       char[] c)

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

get

public abstract CharIndexer get(long[] indices,
                                char[] c,
                                int offset,
                                int length)

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

put

public abstract CharIndexer put(long i,
                                char c)

Returns this where array/buffer[i] = c

put

public CharIndexer put(long i,
                       char... c)

Returns this where array/buffer[i] = c

put

public abstract CharIndexer put(long i,
                                char[] c,
                                int offset,
                                int length)

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

put

public abstract CharIndexer put(long i,
                                long j,
                                char c)

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

put

public CharIndexer put(long i,
                       long j,
                       char... c)

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

put

public abstract CharIndexer put(long i,
                                long j,
                                char[] c,
                                int offset,
                                int length)

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

put

public abstract CharIndexer put(long i,
                                long j,
                                long k,
                                char c)

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

put

public abstract CharIndexer put(long[] indices,
                                char c)

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

put

public CharIndexer put(long[] indices,
                       char... c)

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

put

public abstract CharIndexer put(long[] indices,
                                char[] c,
                                int offset,
                                int length)

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

Description copied from class: Indexer

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

Specified by:

putDouble in class Indexer