org.ojalgo.matrix.store
Class PrimitiveDenseStore

java.lang.Object
  org.ojalgo.array.PrimitiveArray
      org.ojalgo.matrix.store.PrimitiveDenseStore

All Implemented Interfaces:

Serializable, Access1D<Double>, Access2D<Double>, CholeskyDecomposition.Store<Double>, LUDecomposition.Store<Double>, QRDecomposition.Store<Double>, MatrixStore<Double>, PhysicalStore<Double>

public final class PrimitiveDenseStore
extends PrimitiveArray
implements PhysicalStore<Double>, CholeskyDecomposition.Store<Double>, LUDecomposition.Store<Double>, QRDecomposition.Store<Double>

A Double (actually double) implementation of PhysicalStore.

Author:

apete

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.matrix.store.PhysicalStore

PhysicalStore.Factory<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.store.MatrixStore

MatrixStore.Builder<N extends Number>

Field Summary

static PhysicalStore.Factory<Double>	FACTORY
int	length

Method Summary

Double	aggregateAll(ChainableAggregator aVisitor)
Double	aggregateAll(CollectableAggregator aVisitor)
Array1D<N>	asArray1D() A utility facade that conveniently/consistently presents the BasicArray as a one-dimensional array.
Array2D<Double>	asArray2D()
Array2D<N>	asArray2D(int aRowDim, int aColDim) A utility facade that conveniently/consistently presents the BasicArray as a two-dimensional array.
ArrayAnyD<N>	asArrayAnyD(int[] aStructure) A utility facade that conveniently/consistently presents the BasicArray as a multi-dimensional array.
Array1D<Double>	asList()
MatrixStore.Builder<Double>	builder()
void	caxpy(Double aSclrA, int aColX, int aColY, int aFirstRow) column a * x plus y
boolean	computeInPlaceCholesky(boolean checkForSPD)
LUDecomposition.Pivot	computeInPlaceLU(boolean assumeNoPivotingRequired)
void	computeInPlaceQR()
PrimitiveDenseStore	conjugate() Each call must produce a new instance.
PrimitiveDenseStore	copy() Each call must produce a new instance.
double	doubleValue(int aRow, int aCol)
boolean	equals(MatrixStore<Double> aStore, NumberContext aCntxt)
boolean	equals(Object anObj)
void	exchangeColumns(int aColA, int aColB)
void	exchangeRows(int aRowA, int aRowB)
void	extractAndTransform(MatrixStore<Double> aHouseholderColumnsStore, int aHouseholderColumnIndex, int aFirstTargetColumn, Object aWorkCopy)
Householder<Double>	extractHouseholderColumn(int aCol)
void	fillAll(Double aNmbr)
void	fillByMultiplying(MatrixStore<Double> aLeftArg, MatrixStore<Double> aRightArg)
void	fillColumn(int aRow, int aCol, Double aNmbr)
void	fillDiagonal(int aRow, int aCol, Double aNmbr)
void	fillMatching(Access2D<Double> aSource2D)
void	fillMatching(Double aLeftArg, BinaryFunction<Double> aFunc, MatrixStore<Double> aRightArg) Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:
void	fillMatching(MatrixStore<Double> aLeftArg, BinaryFunction<Double> aFunc, Double aRightArg) Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:
void	fillMatching(MatrixStore<Double> aLeftArg, BinaryFunction<Double> aFunc, MatrixStore<Double> aRightArg) Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:
void	fillRow(int aRow, int aCol, Double aNmbr)
Householder<Double>	generateHouseholderColumn(int aRow, int aCol)
Householder<Double>	generateHouseholderRow(int aRow, int aCol)
Double	get(int aRow, int aCol)
int	getColDim()
PhysicalStore.Factory<Double>	getFactory()
int	getIndexOfLargestInColumn(int aRow, int aCol)
int	getIndexOfLargestInRow(int aRow, int aCol)
int	getMinDim()
Double	getNumber(int aRow, int aCol) Deprecated. Use get(int,int) instead
int	getRowDim()
int	hashCode()
boolean	isAbsolute(int aRow, int aCol)
boolean	isLowerLeftShaded() The lower (left) triangle is shaded leaving an upper Hessenberg matrix.
boolean	isReal(int aRow, int aCol)
boolean	isShaded() Either the lower (left) or the upper (right) triangles are shaded.
boolean	isUpperRightShaded() The upper (right) triangle is shaded leaving a lower Hessenberg matrix.
boolean	isZero(int aRow, int aCol)
void	maxpy(Double aSclrA, MatrixStore<Double> aMtrxX) matrix a * x plus y
void	modifyAll(UnaryFunction<Double> aFunc)
void	modifyColumn(int aRow, int aCol, UnaryFunction<Double> aFunc)
void	modifyDiagonal(int aRow, int aCol, UnaryFunction<Double> aFunc)
void	modifyRow(int aRow, int aCol, UnaryFunction<Double> aFunc)
MatrixStore<Double>	multiplyLeft(MatrixStore<Double> aStore)
MatrixStore<Double>	multiplyRight(MatrixStore<Double> aStore)
void	raxpy(Double aSclrA, int aRowX, int aRowY, int aFirstCol) row a * x plus y
void	set(int aRow, int aCol, double aNmbr)
void	set(int aRow, int aCol, Double aNmbr)
void	shadeLowerLeft() Shades the lower (left) triangle, leaving an upper Hessenberg matrix.
void	shadeUpperRight() Shades the upper (right) triangle, leaving a lower Hessenberg matrix.
int	size()
int	size()
void	substituteBackwards(Access2D<Double> aBody, boolean assumeOne, boolean transposed) Will solve the equation system [A][X]=[B] where: [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution). [A] is upper/right triangular
void	substituteBackwards(MatrixStore<Double> aBody, boolean assumeOne) Deprecated. v29 Use substituteBackwards(Access2D,boolean,boolean) instead
void	substituteForwards(Access2D<Double> aBody, boolean assumeOne, boolean transposed) Will solve the equation system [A][X]=[B] where: [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution). [A] is lower/left triangular
void	substituteForwards(MatrixStore<Double> aBody, boolean assumeOne) Deprecated. v29 Use substituteForwards(Access2D,boolean,boolean) instead
double[][]	toRawCopy()
PrimitiveScalar	toScalar(int aRow, int aCol)
String	toString()
void	toTridiagonal(PhysicalStore<Double> aMtrxV)
void	transformLeft(Householder<Double> aTransf)
void	transformLeft(Householder<Double> aTransf, int aFirstCol)
void	transformLeft(Rotation<Double> aTransf) As in MatrixStore.multiplyLeft(MatrixStore) where the left/parameter matrix is a plane rotation.
void	transformRight(Householder<Double> aTransf)
void	transformRight(Householder<Double> aTransf, int aFirstRow)
void	transformRight(Rotation<Double> aTransf) As in MatrixStore.multiplyRight(MatrixStore) where the right/parameter matrix is a plane rotation.
PrimitiveDenseStore	transpose() Each call must produce a new instance.
void	unshade() Unshades both the lower (left) and upper (right) triangles.
void	visitAll(AggregatorFunction<Double> aVisitor)
void	visitColumn(int aRow, int aCol, AggregatorFunction<Double> aVisitor)
void	visitDiagonal(int aRow, int aCol, AggregatorFunction<Double> aVisitor)
void	visitRow(int aRow, int aCol, AggregatorFunction<Double> aVisitor)

Methods inherited from class org.ojalgo.array.PrimitiveArray

doubleValue, exchange, fill, fill, fill, fill, get, getIndexOfLargest, getNumber, isAbsolute, isReal, isZero, modify, modify, modify, modify, modify, modify, searchAscending, set, set, sortAscending, toScalar, visit

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

FACTORY

public static final PhysicalStore.Factory<Double> FACTORY

length

public final int length

Method Detail

aggregateAll

public Double aggregateAll(ChainableAggregator aVisitor)

Specified by:

aggregateAll in interface MatrixStore<Double>

aggregateAll

public Double aggregateAll(CollectableAggregator aVisitor)

Specified by:

aggregateAll in interface MatrixStore<Double>

asArray2D

public Array2D<Double> asArray2D()

asList

public Array1D<Double> asList()

Specified by:

asList in interface PhysicalStore<Double>

Returns:

The elements of the physical store as a fixed size (1 dimensional) list. The elements may be accessed either row or colomn major.

builder

public final MatrixStore.Builder<Double> builder()

Specified by:

builder in interface MatrixStore<Double>

caxpy

public void caxpy(Double aSclrA,
                  int aColX,
                  int aColY,
                  int aFirstRow)

Description copied from interface: PhysicalStore

column a * x plus y

[this(*,aColY)] = aSclrA [this(*,aColX)] + [this(*,aColY)]

Specified by:

caxpy in interface PhysicalStore<Double>

computeInPlaceCholesky

public boolean computeInPlaceCholesky(boolean checkForSPD)

Specified by:

computeInPlaceCholesky in interface CholeskyDecomposition.Store<Double>

computeInPlaceLU

public LUDecomposition.Pivot computeInPlaceLU(boolean assumeNoPivotingRequired)

Specified by:

computeInPlaceLU in interface LUDecomposition.Store<Double>

computeInPlaceQR

public void computeInPlaceQR()

Specified by:

computeInPlaceQR in interface QRDecomposition.Store<Double>

conjugate

public PrimitiveDenseStore conjugate()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

conjugate in interface MatrixStore<Double>

Returns:

A new conjugated PhysicalStore copy.

copy

public PrimitiveDenseStore copy()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

copy in interface MatrixStore<Double>

Returns:

A new PhysicalStore copy.

doubleValue

public double doubleValue(int aRow,
                          int aCol)

Specified by:

doubleValue in interface Access2D<Double>

equals

public boolean equals(MatrixStore<Double> aStore,
                      NumberContext aCntxt)

Specified by:

equals in interface MatrixStore<Double>

equals

public boolean equals(Object anObj)

Overrides:

equals in class PrimitiveArray

exchangeColumns

public void exchangeColumns(int aColA,
                            int aColB)

Specified by:

exchangeColumns in interface PhysicalStore<Double>

exchangeRows

public void exchangeRows(int aRowA,
                         int aRowB)

Specified by:

exchangeRows in interface PhysicalStore<Double>

extractAndTransform

public void extractAndTransform(MatrixStore<Double> aHouseholderColumnsStore,
                                int aHouseholderColumnIndex,
                                int aFirstTargetColumn,
                                Object aWorkCopy)

Specified by:

extractAndTransform in interface QRDecomposition.Store<Double>

Parameters:

aHouseholderColumnsStore - The MatrixStore where the householder column is stored.

aHouseholderColumnIndex - the index of the householder column in aHouseholderColumnsStore.

aFirstTargetColumn - The first column of "this" to be transformed.

aWorkCopy - An array (values not set) for internal/temporary storage of the householder column.

extractHouseholderColumn

public Householder<Double> extractHouseholderColumn(int aCol)

Specified by:

extractHouseholderColumn in interface QRDecomposition.Store<Double>

fillAll

public void fillAll(Double aNmbr)

Specified by:

fillAll in interface PhysicalStore<Double>

fillByMultiplying

public void fillByMultiplying(MatrixStore<Double> aLeftArg,
                              MatrixStore<Double> aRightArg)

Specified by:

fillByMultiplying in interface PhysicalStore<Double>

fillColumn

public void fillColumn(int aRow,
                       int aCol,
                       Double aNmbr)

Specified by:

fillColumn in interface PhysicalStore<Double>

fillDiagonal

public void fillDiagonal(int aRow,
                         int aCol,
                         Double aNmbr)

Specified by:

fillDiagonal in interface PhysicalStore<Double>

fillMatching

public void fillMatching(Access2D<Double> aSource2D)

Specified by:

fillMatching in interface PhysicalStore<Double>

fillMatching

public void fillMatching(Double aLeftArg,
                         BinaryFunction<Double> aFunc,
                         MatrixStore<Double> aRightArg)

Description copied from interface: PhysicalStore

Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:

this(i,j) = aFunc.invoke(aLeftArg,aRightArg(i,j))

Specified by:

fillMatching in interface PhysicalStore<Double>

fillMatching

public void fillMatching(MatrixStore<Double> aLeftArg,
                         BinaryFunction<Double> aFunc,
                         Double aRightArg)

Description copied from interface: PhysicalStore

Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:

this(i,j) = aFunc.invoke(aLeftArg(i,j),aRightArg))

Specified by:

fillMatching in interface PhysicalStore<Double>

fillMatching

public void fillMatching(MatrixStore<Double> aLeftArg,
                         BinaryFunction<Double> aFunc,
                         MatrixStore<Double> aRightArg)

Description copied from interface: PhysicalStore

Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:

this(i,j) = aFunc.invoke(aLeftArg(i,j),aRightArg(i,j))

Specified by:

fillMatching in interface PhysicalStore<Double>

fillRow

public void fillRow(int aRow,
                    int aCol,
                    Double aNmbr)

Specified by:

fillRow in interface PhysicalStore<Double>

generateHouseholderColumn

public Householder<Double> generateHouseholderColumn(int aRow,
                                                     int aCol)

Specified by:

generateHouseholderColumn in interface PhysicalStore<Double>

generateHouseholderRow

public Householder<Double> generateHouseholderRow(int aRow,
                                                  int aCol)

Specified by:

generateHouseholderRow in interface PhysicalStore<Double>

get

public Double get(int aRow,
                  int aCol)

Specified by:

get in interface Access2D<Double>

getColDim

public int getColDim()

getFactory

public PhysicalStore.Factory<Double> getFactory()

Specified by:

getFactory in interface MatrixStore<Double>

getIndexOfLargestInColumn

public int getIndexOfLargestInColumn(int aRow,
                                     int aCol)

Specified by:

getIndexOfLargestInColumn in interface PhysicalStore<Double>

getIndexOfLargestInRow

public int getIndexOfLargestInRow(int aRow,
                                  int aCol)

Specified by:

getIndexOfLargestInRow in interface PhysicalStore<Double>

getMinDim

public int getMinDim()

getNumber

@Deprecated
public Double getNumber(int aRow,
                                   int aCol)

Deprecated. Use get(int,int) instead

getRowDim

public int getRowDim()

hashCode

public int hashCode()

Overrides:

hashCode in class PrimitiveArray

isAbsolute

public boolean isAbsolute(int aRow,
                          int aCol)

Specified by:

isAbsolute in interface MatrixStore<Double>

See Also:

Scalar.isAbsolute()

isLowerLeftShaded

public boolean isLowerLeftShaded()

Description copied from interface: MatrixStore

The lower (left) triangle is shaded leaving an upper Hessenberg matrix.

Specified by:

isLowerLeftShaded in interface MatrixStore<Double>

See Also:

MatrixStore.isUpperRightShaded(), MatrixStore.isShaded(), PhysicalStore.shadeLowerLeft(), PhysicalStore.unshade()

isReal

public boolean isReal(int aRow,
                      int aCol)

Specified by:

isReal in interface MatrixStore<Double>

See Also:

Scalar.isReal()

isShaded

public boolean isShaded()

Description copied from interface: MatrixStore

Either the lower (left) or the upper (right) triangles are shaded.

Shading part of a MatrixStore causes that part to be ignored (as if it had zero valued elements) when doing matrix multiplication. It is possible to shade part of a PhysicalStore even though the shaded elements are not actually zero valued. Calling doubleValue(i, j), getNumber(i, j) or toScalar(i, j) will return the actual stored value.

Specified by:

isShaded in interface MatrixStore<Double>

See Also:

MatrixStore.isLowerLeftShaded(), MatrixStore.isUpperRightShaded(), PhysicalStore.unshade()

isUpperRightShaded

public boolean isUpperRightShaded()

Description copied from interface: MatrixStore

The upper (right) triangle is shaded leaving a lower Hessenberg matrix.

Specified by:

isUpperRightShaded in interface MatrixStore<Double>

See Also:

MatrixStore.isLowerLeftShaded(), MatrixStore.isShaded(), PhysicalStore.shadeUpperRight(), PhysicalStore.unshade()

isZero

public boolean isZero(int aRow,
                      int aCol)

Specified by:

isZero in interface MatrixStore<Double>

See Also:

Scalar.isZero()

maxpy

public void maxpy(Double aSclrA,
                  MatrixStore<Double> aMtrxX)

Description copied from interface: PhysicalStore

matrix a * x plus y

[this] = aSclrA [aMtrxX] + [this]

Specified by:

maxpy in interface PhysicalStore<Double>

modifyAll

public void modifyAll(UnaryFunction<Double> aFunc)

Specified by:

modifyAll in interface PhysicalStore<Double>

modifyColumn

public void modifyColumn(int aRow,
                         int aCol,
                         UnaryFunction<Double> aFunc)

Specified by:

modifyColumn in interface PhysicalStore<Double>

modifyDiagonal

public void modifyDiagonal(int aRow,
                           int aCol,
                           UnaryFunction<Double> aFunc)

Specified by:

modifyDiagonal in interface PhysicalStore<Double>

modifyRow

public void modifyRow(int aRow,
                      int aCol,
                      UnaryFunction<Double> aFunc)

Specified by:

modifyRow in interface PhysicalStore<Double>

multiplyLeft

public MatrixStore<Double> multiplyLeft(MatrixStore<Double> aStore)

Specified by:

multiplyLeft in interface MatrixStore<Double>

multiplyRight

public MatrixStore<Double> multiplyRight(MatrixStore<Double> aStore)

Specified by:

multiplyRight in interface MatrixStore<Double>

raxpy

public void raxpy(Double aSclrA,
                  int aRowX,
                  int aRowY,
                  int aFirstCol)

Description copied from interface: PhysicalStore

row a * x plus y

[this(aRowY,*)] = aSclrA [this(aRowX,*)] + [this(aRowY,*)]

Specified by:

raxpy in interface PhysicalStore<Double>

set

public void set(int aRow,
                int aCol,
                double aNmbr)

Specified by:

set in interface PhysicalStore<Double>

set

public void set(int aRow,
                int aCol,
                Double aNmbr)

Specified by:

set in interface PhysicalStore<Double>

shadeLowerLeft

public void shadeLowerLeft()

Description copied from interface: PhysicalStore

Shades the lower (left) triangle, leaving an upper Hessenberg matrix.

Specified by:

shadeLowerLeft in interface PhysicalStore<Double>

See Also:

PhysicalStore.unshade()

shadeUpperRight

public void shadeUpperRight()

Description copied from interface: PhysicalStore

Shades the upper (right) triangle, leaving a lower Hessenberg matrix.

Specified by:

shadeUpperRight in interface PhysicalStore<Double>

See Also:

PhysicalStore.unshade()

substituteBackwards

public void substituteBackwards(Access2D<Double> aBody,
                                boolean assumeOne,
                                boolean transposed)

Description copied from interface: PhysicalStore

Will solve the equation system [A][X]=[B] where:

• [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution).
• [A] is upper/right triangular

Specified by:

substituteBackwards in interface PhysicalStore<Double>

Parameters:

aBody - The equation system body parameters [A]

assumeOne - true if aBody as ones on the diagonal

transposed - true if the upper/right part of aBody is actually stored in the lower/left part of the matrix.

substituteBackwards

@Deprecated
public void substituteBackwards(MatrixStore<Double> aBody,
                                           boolean assumeOne)

Deprecated. v29 Use substituteBackwards(Access2D,boolean,boolean) instead

Specified by:

substituteBackwards in interface PhysicalStore<Double>

substituteForwards

public void substituteForwards(Access2D<Double> aBody,
                               boolean assumeOne,
                               boolean transposed)

Description copied from interface: PhysicalStore

Will solve the equation system [A][X]=[B] where:

• [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution).
• [A] is lower/left triangular

Specified by:

substituteForwards in interface PhysicalStore<Double>

Parameters:

aBody - The equation system body parameters [A]

assumeOne - true if aBody as ones on the diagonal

transposed - true if the lower/left part of aBody is actually stored in the upper/right part of the matrix.

substituteForwards

@Deprecated
public void substituteForwards(MatrixStore<Double> aBody,
                                          boolean assumeOne)

Deprecated. v29 Use substituteForwards(Access2D,boolean,boolean) instead

Specified by:

substituteForwards in interface PhysicalStore<Double>

toRawCopy

public double[][] toRawCopy()

Specified by:

toRawCopy in interface MatrixStore<Double>

toScalar

public PrimitiveScalar toScalar(int aRow,
                                int aCol)

Specified by:

toScalar in interface Access2D<Double>

toTridiagonal

public final void toTridiagonal(PhysicalStore<Double> aMtrxV)

transformLeft

public void transformLeft(Householder<Double> aTransf)

Specified by:

transformLeft in interface PhysicalStore<Double>

transformLeft

public void transformLeft(Householder<Double> aTransf,
                          int aFirstCol)

Specified by:

transformLeft in interface PhysicalStore<Double>

transformLeft

public void transformLeft(Rotation<Double> aTransf)

Description copied from interface: PhysicalStore

As in MatrixStore.multiplyLeft(MatrixStore) where the left/parameter matrix is a plane rotation.

Multiplying by a plane rotation from the left means that [this] gets two of its rows updated to new combinations of those two (current) rows.

There are two ways to transpose/invert a rotation. Either you negate the angle or you interchange the two indeces that define the rotation plane.

Specified by:

transformLeft in interface PhysicalStore<Double>

See Also:

PhysicalStore.transformRight(Rotation)

transformRight

public void transformRight(Householder<Double> aTransf)

Specified by:

transformRight in interface PhysicalStore<Double>

transformRight

public void transformRight(Householder<Double> aTransf,
                           int aFirstRow)

Specified by:

transformRight in interface PhysicalStore<Double>

transformRight

public void transformRight(Rotation<Double> aTransf)

Description copied from interface: PhysicalStore

As in MatrixStore.multiplyRight(MatrixStore) where the right/parameter matrix is a plane rotation.

Multiplying by a plane rotation from the right means that [this] gets two of its columns updated to new combinations of those two (current) columns.

There result is undefined if the two input indeces are the same (in which case the rotation plane is undefined).

Specified by:

transformRight in interface PhysicalStore<Double>

See Also:

PhysicalStore.transformLeft(Rotation)

transpose

public PrimitiveDenseStore transpose()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

transpose in interface MatrixStore<Double>

Returns:

A new transposed PhysicalStore copy.

unshade

public void unshade()

Description copied from interface: PhysicalStore

Unshades both the lower (left) and upper (right) triangles.

Specified by:

unshade in interface PhysicalStore<Double>

See Also:

PhysicalStore.shadeLowerLeft(), PhysicalStore.shadeUpperRight()

visitAll

public void visitAll(AggregatorFunction<Double> aVisitor)

Specified by:

visitAll in interface MatrixStore<Double>

visitColumn

public void visitColumn(int aRow,
                        int aCol,
                        AggregatorFunction<Double> aVisitor)

Specified by:

visitColumn in interface MatrixStore<Double>

visitDiagonal

public void visitDiagonal(int aRow,
                          int aCol,
                          AggregatorFunction<Double> aVisitor)

Specified by:

visitDiagonal in interface MatrixStore<Double>

visitRow

public void visitRow(int aRow,
                     int aCol,
                     AggregatorFunction<Double> aVisitor)

Specified by:

visitRow in interface MatrixStore<Double>

size

public int size()

asArray1D

public final Array1D<N> asArray1D()

A utility facade that conveniently/consistently presents the BasicArray as a one-dimensional array. Note that you will modify the actual array by accessing it through this facade.

Disregards the array structure, and simply treats it as one-domensional.

asArray2D

public final Array2D<N> asArray2D(int aRowDim,
                                  int aColDim)

A utility facade that conveniently/consistently presents the BasicArray as a two-dimensional array. Note that you will modify the actual array by accessing it through this facade.

If "this" has more than two dimensions then only the first plane of the first cube of the first... is used/accessed. If this only has one dimension then everything is assumed to be in the first column of the first plane of the first cube...

asArrayAnyD

public final ArrayAnyD<N> asArrayAnyD(int[] aStructure)

A utility facade that conveniently/consistently presents the BasicArray as a multi-dimensional array. Note that you will modify the actual array by accessing it through this facade.

size

public final int size()

toString

public String toString()

Overrides:

toString in class Object