org.bytedeco.javacpp.indexer

Class HyperslabIndex

java.lang.Object

org.bytedeco.javacpp.indexer.Index

org.bytedeco.javacpp.indexer.StrideIndex

org.bytedeco.javacpp.indexer.HyperslabIndex

public class HyperslabIndex
extends StrideIndex

A hyperslab is a rectangular pattern defined by four arrays.

The start defines the origin of the hyperslab in the original coordinates. The stride is the number of elements to increment between selected elements. A stride of '1' is every element, a stride of '2' is every second element, etc. The default stride is 1. The count is the number of elements in the hyperslab selection. When the stride is 1, the selection is a hyper rectangle with a corner at start and size count[0] by count[1] by ... When stride is greater than one, the hyperslab bounded by start and the corners defined by stride[n] * count[n]. The block is a count on the number of repetitions of the hyperslab. The default block size is '1', which is one hyperslab. A block of 2 would be two hyperslabs in that dimension, with the second starting at start[n]+ (count[n] * stride[n]) + 1.

Author:

Matteo Di Giovinazzo

See Also:

Reading From or Writing To a Subset of a Dataset, H5S_SELECT_HYPERSLAB, Dataspaces

Field Summary

Fields

Modifier and Type	Field and Description
protected long[]	selectionBlocks
protected long[]	selectionCounts
protected long[]	selectionOffsets
protected long[]	selectionStrides

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

strides

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

sizes

Constructor Summary

Constructors

Constructor and Description
HyperslabIndex(long[] sizes, long[] selectionOffsets, long[] selectionStrides, long[] selectionCounts, long[] selectionBlocks) Calls HyperslabIndex(sizes, defaultStrides(sizes), selectionOffsets, selectionStrides, selectionCounts, selectionBlocks).
HyperslabIndex(long[] sizes, long[] strides, long[] selectionOffsets, long[] selectionStrides, long[] selectionCounts, long[] selectionBlocks) Constructor to set the Index.sizes, StrideIndex.strides, selectionOffsets, selectionStrides, selectionCounts, and selectionBlocks.

Method Summary

Modifier and Type	Method and Description
long	index(long... indices) Computes the linear index as the dot product of indices and strides.
long	index(long i) Returns i * strides[0].
long	index(long i, long j) Returns i * strides[0] + j * strides[1].
long	index(long i, long j, long k) Returns i * strides[0] + j * strides[1] + k * strides[2].

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

defaultStrides, strides

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

create, create, create, create, create, rank, size, sizes

Methods inherited from class java.lang.Object

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

Field Detail

selectionOffsets

protected long[] selectionOffsets

selectionStrides

protected long[] selectionStrides

selectionCounts

protected long[] selectionCounts

selectionBlocks

protected long[] selectionBlocks

Constructor Detail

HyperslabIndex

public HyperslabIndex(long[] sizes,
                      long[] selectionOffsets,
                      long[] selectionStrides,
                      long[] selectionCounts,
                      long[] selectionBlocks)

Calls HyperslabIndex(sizes, defaultStrides(sizes), selectionOffsets, selectionStrides, selectionCounts, selectionBlocks).

HyperslabIndex

public HyperslabIndex(long[] sizes,
                      long[] strides,
                      long[] selectionOffsets,
                      long[] selectionStrides,
                      long[] selectionCounts,
                      long[] selectionBlocks)

Constructor to set the Index.sizes, StrideIndex.strides, selectionOffsets, selectionStrides, selectionCounts, and selectionBlocks. Also updates the Index.sizes for the resulting selection.

Method Detail

index

public long index(long i)

Description copied from class: StrideIndex

Returns i * strides[0].

Overrides:

index in class StrideIndex

index

public long index(long i,
                  long j)

Description copied from class: StrideIndex

Returns i * strides[0] + j * strides[1].

Overrides:

index in class StrideIndex

index

public long index(long i,
                  long j,
                  long k)

Description copied from class: StrideIndex

Returns i * strides[0] + j * strides[1] + k * strides[2].

Overrides:

index in class StrideIndex

index

public long index(long... indices)

Description copied from class: StrideIndex

Computes the linear index as the dot product of indices and strides.

Overrides:

index in class StrideIndex

Parameters:

indices - of each dimension

Returns:

index to access array or buffer