## org.jscience.mathematics.algebraic Interface Hypermatrix

All Known Subinterfaces:
BandedMatrix, DiagonalMatrix, Matrix, SquareMatrix, SymmetricMatrix, TriangularMatrix, TridiagonalMatrix, Vector
All Known Implementing Classes:
AbstractBandedMatrix, AbstractBooleanVector, AbstractComplexMatrix, AbstractComplexSquareMatrix, AbstractComplexVector, AbstractDiagonalMatrix, AbstractDoubleMatrix, AbstractDoubleSquareMatrix, AbstractDoubleVector, AbstractHypermatrix, AbstractIntegerMatrix, AbstractIntegerSquareMatrix, AbstractIntegerVector, AbstractMatrix, AbstractSquareMatrix, AbstractSymmetricMatrix, AbstractTriangularMatrix, AbstractTridiagonalMatrix, AbstractVector, BooleanMatrix, BooleanVector, BraVector, Complex2Vector, Complex3Vector, ComplexDiagonalMatrix, ComplexMatrix, ComplexSparseMatrix, ComplexSparseSquareMatrix, ComplexSparseVector, ComplexSquareMatrix, ComplexSymmetricMatrix, ComplexTridiagonalMatrix, ComplexVector, Double2Vector, Double3Vector, DoubleDiagonalMatrix, DoubleMatrix, DoubleSparseMatrix, DoubleSparseSquareMatrix, DoubleSparseVector, DoubleSquareMatrix, DoubleSymmetricMatrix, DoubleTridiagonalMatrix, DoubleVector, GammaMatrix, Integer2Vector, Integer3Vector, IntegerDiagonalMatrix, IntegerMatrix, IntegerSparseMatrix, IntegerSparseSquareMatrix, IntegerSparseVector, IntegerSquareMatrix, IntegerSymmetricMatrix, IntegerTridiagonalMatrix, IntegerVector, KetVector, RingHypermatrix, RingMatrix, RingVector

`public interface Hypermatrix`

The Hypermatrix superclass provides an abstract encapsulation for extended matrices. Hypermatrices are also known as MultiArrays. Please recall that 10 elements in 10 dimensions is 10 power 10 total elements, therefore probably more than your system is able to handle.

Method Summary
` int[]` `getDimensions()`
Returns the array of dimensions.
` java.lang.Number` `getElement(int[] position)`
Returns the element at position given by the array of int.
` int` `numDimensions()`
Returns the number of dimensions.
` int` `numElements()`
Returns the total number of elements.
` int` `numElements(int i)`
Returns the number of elements for the given dimension.
` java.lang.Object` `toArray()`
Converts this hypermatrix to an array of n dimensions
` java.lang.Object` `toArray(Hypermatrix m)`
Converts a hypermatrix to an array of n dimensions

Method Detail

### numDimensions

`int numDimensions()`
Returns the number of dimensions.

Returns:
DOCUMENT ME!

### getDimensions

`int[] getDimensions()`
Returns the array of dimensions.

Returns:
DOCUMENT ME!

### numElements

`int numElements(int i)`
Returns the number of elements for the given dimension.

Parameters:
`i` - DOCUMENT ME!
Returns:
DOCUMENT ME!

### numElements

`int numElements()`
Returns the total number of elements.

Returns:
DOCUMENT ME!

### getElement

```java.lang.Number getElement(int[] position)
throws IllegalDimensionException```
Returns the element at position given by the array of int.

Parameters:
`position` - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
`IllegalDimensionException` - DOCUMENT ME!

### toArray

`java.lang.Object toArray()`
Converts this hypermatrix to an array of n dimensions

Returns:
DOCUMENT ME!

### toArray

`java.lang.Object toArray(Hypermatrix m)`
Converts a hypermatrix to an array of n dimensions

Parameters:
`m` - DOCUMENT ME!
Returns:
DOCUMENT ME!