org.shared.array

Interface Array<T extends Array<T,E>,E>

Type Parameters:

T - the parameterization lower bounded by Array itself.

E - the component type.

All Superinterfaces:

Cloneable

All Known Subinterfaces:

Matrix<T,E>

All Known Implementing Classes:

AbstractArray, AbstractComplexArray, AbstractRealArray, ComplexArray, DerivativeOfGaussian, Gabor, GaborCircular, IntegerArray, IntegerSparseArray, IntegralHistogram, IntegralImage, LaplacianOfGaussian, Mean, ObjectArray, ObjectSparseArray, ProtoArray, ProtoSparseArray, RealArray, RealSparseArray

public interface Array<T extends Array<T,E>,E>
extends Cloneable

Defines functionality that can be expected from all multidimensional arrays.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Array.IndexingOrder An enumeration of internal storage orders for Arrays.

Method Summary

Methods

Modifier and Type	Method and Description
T	clone() Copies this array.
T	concat(int opDim, T... srcs) Concatenates this array with the given arrays along the given dimension.
int[]	dims() Gets the dimensions.
Class<E>	getComponentType() Gets the component type.
T	map(T dst, int... bounds) Maps this array into a destination array.
int	nDims() Gets the number of dimensions.
Array.IndexingOrder	order() Gets the storage order of this array.
T	reshape(int... dims) Reshapes this array.
T	reverse(int... opDims) Reverses along the given dimensions.
T	reverseOrder() Creates an array where the storage order is reversed.
T	shift(int... shifts) Circularly shifts this array.
int	size(int i) Gets the size along the given dimension.
T	slice(E value, int[]... srcSlices) Slices a value into this array.
T	slice(int[]... srcSlices) Gets a subarray specified by the given slicing indices.
T	slice(int[][] srcSlices, T dst, int[][] dstSlices) Slices this array into a destination array.
T	slice(T dst, int[]... dstSlices) Slices this entire array into a destination array.
T	splice(T dst, int... slices) A primitive slicing operation.
int	stride(int i) Gets the stride along the given dimension.
int[]	strides() Gets the strides.
T	subarray(int... bounds) Gets a subarray delimited by the given bounds.
T	tile(int... repetitions) Tiles this array according to the given number repetitions along each dimension.
String	toString() Creates a human-readable representation of this array.
T	transpose(int... permutation) Transposes (permutes) the dimensions of this array.

Method Detail

order

Array.IndexingOrder order()

Gets the storage order of this array.

size

int size(int i)

Gets the size along the given dimension.

stride

int stride(int i)

Gets the stride along the given dimension.

nDims

int nDims()

Gets the number of dimensions.

dims

int[] dims()

Gets the dimensions.

strides

int[] strides()

Gets the strides.

map

T map(T dst,
    int... bounds)

Maps this array into a destination array.

Parameters:

dst - the destination array.

bounds - the mapping bounds as an array of three-tuples. Given the ith tuple, the first component denotes the source start, the second component denotes the destination start, and the third component denotes the mapping size. Is very much the multidimensional analogy to System.arraycopy(Object, int, Object, int, int).

Returns:

the destination array.

splice

T splice(T dst,
       int... slices)

A primitive slicing operation.

Parameters:

dst - the destination array.

slices - the slicing specifications as an array of three-tuples. Given the ith tuple, the first component denotes the source index, the second component denotes the destination index, and the third component denotes the dimension of interest. The sliced portion is the Cartesian product subarray delineated by these specifications.

Returns:

the destination array.

slice

T slice(int[][] srcSlices,
      T dst,
      int[][] dstSlices)

Slices this array into a destination array.

Parameters:

srcSlices - the source slicing indices along each dimension.

dst - the destination array.

dstSlices - the destination slicing indices along each dimension.

Returns:

the destination array.

slice

T slice(T dst,
      int[]... dstSlices)

Slices this entire array into a destination array.

Parameters:

dst - the destination array.

dstSlices - the destination slicing indices along each dimension.

Returns:

the destination array.

slice

T slice(E value,
      int[]... srcSlices)

Slices a value into this array.

Parameters:

value - the value.

srcSlices - the source slicing indices along each dimension.

Returns:

this array.

slice

T slice(int[]... srcSlices)

Gets a subarray specified by the given slicing indices.

Parameters:

srcSlices - the slicing indices.

Returns:

the subarray.

subarray

T subarray(int... bounds)

Gets a subarray delimited by the given bounds.

Parameters:

bounds - the subarray bounds as an array of two-tuples. Given the ith tuple, the first component is the (inclusive) lower range and the second component is the (exclusive) upper range.

Returns:

the subarray.

tile

T tile(int... repetitions)

Tiles this array according to the given number repetitions along each dimension.

Parameters:

repetitions - the number times to repeat along each dimension.

Returns:

the tiled result.

transpose

T transpose(int... permutation)

Transposes (permutes) the dimensions of this array.

Parameters:

permutation - the dimension permutation.

Returns:

the transposed result.

shift

T shift(int... shifts)

Circularly shifts this array.

Parameters:

shifts - the shift amounts.

Returns:

the shifted array.

reshape

T reshape(int... dims)

Reshapes this array.

Parameters:

dims - the reshaped dimensions.

Returns:

the reshaped array.

reverse

T reverse(int... opDims)

Reverses along the given dimensions.

Parameters:

opDims - the dimensions to reverse along.

Returns:

the reversed array.

concat

T concat(int opDim,
       T... srcs)

Concatenates this array with the given arrays along the given dimension.

Parameters:

opDim - the dimension to concatenate along.

srcs - the arrays to concatenate with.

Returns:

the concatenation result.

reverseOrder

T reverseOrder()

Creates an array where the storage order is reversed.

clone

T clone()

Copies this array.

getComponentType

Class<E> getComponentType()

Gets the component type.

toString

String toString()

Creates a human-readable representation of this array.

Overrides:

toString in class Object