ch.systemsx.cisd.base.mdarray

Class MDIntArray

java.lang.Object

ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Integer>

ch.systemsx.cisd.base.mdarray.MDIntArray

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<MDAbstractArray.ArrayEntry>

public final class MDIntArray
extends MDAbstractArray<java.lang.Integer>

A multi-dimensional int array.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ch.systemsx.cisd.base.mdarray.MDAbstractArray

MDAbstractArray.ArrayEntry

Constructor Summary

Constructors

Constructor and Description
MDIntArray(int[] dimensions) Creates an empty MDIntArray with the dimensions.
MDIntArray(int[][] matrix) Creates a MDIntArray from the given matrix of rank 2.
MDIntArray(int[][] matrix, int[] dimensions) Creates a MDIntArray from the given matrix of rank 2 and the dimension which need to be less or equal the dimensions of matrix.
MDIntArray(int[] dimensions, int capacityHyperRows) Creates an empty MDIntArray with the dimensions.
MDIntArray(int[] flattenedArray, int[] dimensions) Creates a MDIntArray from the given flattenedArray and dimensions.
MDIntArray(int[] flattenedArray, int[] dimensions, boolean checkdimensions) Creates a MDIntArray from the given flattenedArray and dimensions.
MDIntArray(int[] flattenedArray, long[] dimensions) Creates a MDIntArray from the given flattenedArray and dimensions.
MDIntArray(int[] flattenedArray, long[] dimensions, boolean checkdimensions) Creates a MDIntArray from the given flattenedArray and dimensions.
MDIntArray(long[] dimensions) Creates an empty MDIntArray with the dimensions.
MDIntArray(long[] dimensions, long capacityHyperRows) Creates an empty MDIntArray with the dimensions.

Method Summary

Methods

Modifier and Type	Method and Description
int	capacity() Returns the capacity of elements in the array.
boolean	equals(java.lang.Object obj)
int	get(int... indices) Returns the value of array at the position defined by indices.
int	get(int index) Returns the value of a one-dimensional array at the position defined by index.
int	get(int indexX, int indexY) Returns the value of a two-dimensional array at the position defined by indexX and indexY.
int	get(int indexX, int indexY, int indexZ) Returns the value of a three-dimensional array at the position defined by indexX, indexY and indexZ.
int[]	getAsFlatArray() Returns the array in flattened form.
java.lang.Integer	getAsObject(int... indices) Return an object which has the same value as the element of the array specified by indices.
java.lang.Integer	getAsObject(int linearIndex) Return an object which has the same value as the element of the array specified by linearIndex.
int[]	getCopyAsFlatArray() Returns a copy of the array in flattened form.
int	hashCode()
void	set(int value, int... indices) Sets the value of array at the position defined by indices.
void	set(int value, int index) Sets the value of a one-dimension array at the position defined by index.
void	set(int value, int indexX, int indexY) Sets the value of a two-dimensional array at the position defined by indexX and indexY.
void	set(int value, int indexX, int indexY, int indexZ) Sets the value of a three-dimensional array at the position defined by indexX, indexY and indexZ.
void	setToObject(java.lang.Integer value, int... indices) Sets the element of the array specified by indices to the particular value.
void	setToObject(java.lang.Integer value, int linearIndex) Sets the element of the array specified by linearIndex to the particular value.
int[][]	toMatrix() Creates and returns a matrix from a two-dimensional array.

Methods inherited from class ch.systemsx.cisd.base.mdarray.MDAbstractArray

computeIndex, computeIndex, computeIndex, computeReverseIndex, decNumberOfHyperRows, dimensions, getLength, getLength, getLength, getLength, incNumberOfHyperRows, iterator, longDimensions, numberOfHyperRows, rank, size, size, toInt, toLong, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MDIntArray

public MDIntArray(long[] dimensions)

Creates an empty MDIntArray with the dimensions. Convenience method if dimensions are available as long[].

MDIntArray

public MDIntArray(long[] dimensions,
          long capacityHyperRows)

Creates an empty MDIntArray with the dimensions. If capacityHyperRows > dimensions[0], then it will create an array with a capacity of capacityHyperRows hyper-rows. Convenience method if dimensions are available as long[].

MDIntArray

public MDIntArray(int[] flattenedArray,
          long[] dimensions)

Creates a MDIntArray from the given flattenedArray and dimensions. It is checked that the arguments are compatible. Convenience method if dimensions are available as long[].

MDIntArray

public MDIntArray(int[] flattenedArray,
          long[] dimensions,
          boolean checkdimensions)

Creates a MDIntArray from the given flattenedArray and dimensions. If checkDimensions is true, it is checked that the arguments are compatible. Convenience method if dimensions are available as long[].

MDIntArray

public MDIntArray(int[] dimensions)

Creates an empty MDIntArray with the dimensions.

MDIntArray

public MDIntArray(int[] dimensions,
          int capacityHyperRows)

Creates an empty MDIntArray with the dimensions. If capacityHyperRows > dimensions[0], then it will create an array with a capacity of capacityHyperRows hyper-rows.

MDIntArray

public MDIntArray(int[] flattenedArray,
          int[] dimensions)

Creates a MDIntArray from the given flattenedArray and dimensions. It is checked that the arguments are compatible.

MDIntArray

public MDIntArray(int[] flattenedArray,
          int[] dimensions,
          boolean checkdimensions)

Creates a MDIntArray from the given flattenedArray and dimensions. If checkDimensions is true, it is checked that the arguments are compatible.

MDIntArray

public MDIntArray(int[][] matrix)

Creates a MDIntArray from the given matrix of rank 2. Note that the values in matrix will be copied and thus the created MDIntArray will be independent from matrix after construction.

MDIntArray

public MDIntArray(int[][] matrix,
          int[] dimensions)

Creates a MDIntArray from the given matrix of rank 2 and the dimension which need to be less or equal the dimensions of matrix. Note that the values in matrix will be copied and thus the created MDIntArray will be independent from matrix after construction.

Method Detail

capacity

public int capacity()

Description copied from class: MDAbstractArray

Returns the capacity of elements in the array.

Specified by:

capacity in class MDAbstractArray<java.lang.Integer>

getAsObject

public java.lang.Integer getAsObject(int... indices)

Description copied from class: MDAbstractArray

Return an object which has the same value as the element of the array specified by indices.

Specified by:

getAsObject in class MDAbstractArray<java.lang.Integer>

setToObject

public void setToObject(java.lang.Integer value,
               int... indices)

Description copied from class: MDAbstractArray

Sets the element of the array specified by indices to the particular value.

Specified by:

setToObject in class MDAbstractArray<java.lang.Integer>

getAsObject

public java.lang.Integer getAsObject(int linearIndex)

Description copied from class: MDAbstractArray

Return an object which has the same value as the element of the array specified by linearIndex.

Specified by:

getAsObject in class MDAbstractArray<java.lang.Integer>

Parameters:

linearIndex - The index in the linear array returned by MDAbstractArray.getAsFlatArray().

Returns:

The value at the specified index.

setToObject

public void setToObject(java.lang.Integer value,
               int linearIndex)

Description copied from class: MDAbstractArray

Sets the element of the array specified by linearIndex to the particular value.

Specified by:

setToObject in class MDAbstractArray<java.lang.Integer>

Parameters:

value - The new value to set.

linearIndex - The index in the linear array returned by MDAbstractArray.getAsFlatArray().

getAsFlatArray

public int[] getAsFlatArray()

Description copied from class: MDAbstractArray

Returns the array in flattened form. Changes to the returned object will change the multi-dimensional array directly.

Specified by:

getAsFlatArray in class MDAbstractArray<java.lang.Integer>

getCopyAsFlatArray

public int[] getCopyAsFlatArray()

Description copied from class: MDAbstractArray

Returns a copy of the array in flattened form. Changes to the returned object will not change the multi-dimensional array directly.

Specified by:

getCopyAsFlatArray in class MDAbstractArray<java.lang.Integer>

get

public int get(int... indices)

Returns the value of array at the position defined by indices.

get

public int get(int index)

Returns the value of a one-dimensional array at the position defined by index.

Do not call for arrays other than one-dimensional!

get

public int get(int indexX,
      int indexY)

Returns the value of a two-dimensional array at the position defined by indexX and indexY.

Do not call for arrays other than two-dimensional!

get

public int get(int indexX,
      int indexY,
      int indexZ)

Returns the value of a three-dimensional array at the position defined by indexX, indexY and indexZ.

Do not call for arrays other than three-dimensional!

set

public void set(int value,
       int... indices)

Sets the value of array at the position defined by indices.

set

public void set(int value,
       int index)

Sets the value of a one-dimension array at the position defined by index.

Do not call for arrays other than one-dimensional!

set

public void set(int value,
       int indexX,
       int indexY)

Sets the value of a two-dimensional array at the position defined by indexX and indexY.

Do not call for arrays other than two-dimensional!

set

public void set(int value,
       int indexX,
       int indexY,
       int indexZ)

Sets the value of a three-dimensional array at the position defined by indexX, indexY and indexZ.

Do not call for arrays other than three-dimensional!

toMatrix

public int[][] toMatrix()

Creates and returns a matrix from a two-dimensional array.

Do not call for arrays other than two-dimensional!

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object