Package org.bytedeco.javacpp.indexer
Class Index
java.lang.Object
org.bytedeco.javacpp.indexer.Index
- Direct Known Subclasses:
OneIndex
,StrideIndex
Provides an interface for classes that compute a linear index from given array sizes.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final long[]
The number of elements in each dimension. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Index
create
(long size) Returnsnew OneIndex(size)
.static Index
create
(long... sizes) Returnsnew StrideIndex(sizes)
.static Index
create
(long[] sizes, long[] strides) Returnsnew StrideIndex(sizes, strides)
.static Index
create
(long[] sizes, long[] selectionOffsets, long[] selectionStrides, long[] selectionCounts, long[] selectionBlocks) Returnsnew HyperslabIndex(sizes, selectionOffsets, selectionStrides, selectionCounts, selectionBlocks)
.static Index
create
(long[] sizes, long[] strides, long[] selectionOffsets, long[] selectionStrides, long[] selectionCounts, long[] selectionBlocks) Returnsnew HyperslabIndex(sizes, strides, selectionOffsets, selectionStrides, selectionCounts, selectionBlocks)
.long
index
(long i) Returnsindex(new long[] {i})
.abstract long
index
(long... indices) Computes the linear index.long
index
(long i, long j) Returnsindex(new long[] {i, j})
.long
index
(long i, long j, long k) Returnsindex(new long[] {i, j, k})
.int
rank()
Returnssizes.length
.long
size
(int i) Returnssizes[i]
.long[]
sizes()
Returnssizes
.
-
Field Details
-
sizes
protected final long[] sizesThe number of elements in each dimension. These values are not typically used by the indexer.
-
-
Constructor Details
-
Index
public Index(long... sizes) Constructor to set thesizes
.
-
-
Method Details
-
create
Returnsnew OneIndex(size)
. -
create
Returnsnew StrideIndex(sizes)
. -
create
Returnsnew StrideIndex(sizes, strides)
. -
create
public static Index create(long[] sizes, long[] selectionOffsets, long[] selectionStrides, long[] selectionCounts, long[] selectionBlocks) Returnsnew HyperslabIndex(sizes, selectionOffsets, selectionStrides, selectionCounts, selectionBlocks)
. -
create
public static Index create(long[] sizes, long[] strides, long[] selectionOffsets, long[] selectionStrides, long[] selectionCounts, long[] selectionBlocks) Returnsnew HyperslabIndex(sizes, strides, selectionOffsets, selectionStrides, selectionCounts, selectionBlocks)
. -
rank
public int rank()Returnssizes.length
. -
sizes
public long[] sizes()Returnssizes
. -
size
public long size(int i) Returnssizes[i]
. -
index
public long index(long i) Returnsindex(new long[] {i})
. -
index
public long index(long i, long j) Returnsindex(new long[] {i, j})
. -
index
public long index(long i, long j, long k) Returnsindex(new long[] {i, j, k})
. -
index
public abstract long index(long... indices) Computes the linear index.- Parameters:
indices
- of each dimension- Returns:
- index to access array or buffer
-