ch.systemsx.cisd.base.mdarray

Class MDDoubleArray

java.lang.Object

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

ch.systemsx.cisd.base.mdarray.MDDoubleArray

All Implemented Interfaces:

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

public final class MDDoubleArray
extends MDAbstractArray<java.lang.Double>

A multi-dimensional double 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
MDDoubleArray(double[][] matrix) Creates a MDDoubleArray from the given matrix of rank 2.
MDDoubleArray(double[][] matrix, int[] dimensions) Creates a MDDoubleArray from the given matrix of rank 2 and the dimension which need to be less or equal the dimensions of matrix.
MDDoubleArray(double[] flattenedArray, int[] dimensions) Creates a MDDoubleArray from the given flattenedArray and dimensions.
MDDoubleArray(double[] flattenedArray, int[] dimensions, boolean checkdimensions) Creates a MDDoubleArray from the given flattenedArray and dimensions.
MDDoubleArray(double[] flattenedArray, long[] dimensions) Creates a MDDoubleArray from the given flattenedArray and dimensions.
MDDoubleArray(double[] flattenedArray, long[] dimensions, boolean checkdimensions) Creates a MDDoubleArray from the given flattenedArray and dimensions.
MDDoubleArray(int[] dimensions) Creates an empty MDDoubleArray with the dimensions.
MDDoubleArray(int[] dimensions, int capacityHyperRows) Creates an empty MDDoubleArray with the dimensions.
MDDoubleArray(long[] dimensions) Creates an empty MDIntArray with the dimensions.
MDDoubleArray(long[] dimensions, long capacityHyperRows) Creates an empty MDDoubleArray 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)
double	get(int... indices) Returns the value of array at the position defined by indices.
double	get(int index) Returns the value of a one-dimensional array at the position defined by index.
double	get(int indexX, int indexY) Returns the value of a two-dimensional array at the position defined by indexX and indexY.
double	get(int indexX, int indexY, int indexZ) Returns the value of a three-dimensional array at the position defined by indexX, indexY and indexZ.
double[]	getAsFlatArray() Returns the array in flattened form.
java.lang.Double	getAsObject(int... indices) Return an object which has the same value as the element of the array specified by indices.
java.lang.Double	getAsObject(int linearIndex) Return an object which has the same value as the element of the array specified by linearIndex.
double[]	getCopyAsFlatArray() Returns a copy of the array in flattened form.
int	hashCode()
void	set(double value, int... indices) Sets the value of array at the position defined by indices.
void	set(double value, int index) Sets the value of a one-dimension array at the position defined by index.
void	set(double value, int indexX, int indexY) Sets the value of a two-dimensional array at the position defined by indexX and indexY.
void	set(double 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.Double value, int... indices) Sets the element of the array specified by indices to the particular value.
void	setToObject(java.lang.Double value, int linearIndex) Sets the element of the array specified by linearIndex to the particular value.
double[][]	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

MDDoubleArray

public MDDoubleArray(long[] dimensions)

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

MDDoubleArray

public MDDoubleArray(long[] dimensions,
             long capacityHyperRows)

Creates an empty MDDoubleArray 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[].

MDDoubleArray

public MDDoubleArray(double[] flattenedArray,
             long[] dimensions)

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

MDDoubleArray

public MDDoubleArray(double[] flattenedArray,
             long[] dimensions,
             boolean checkdimensions)

Creates a MDDoubleArray 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[].

MDDoubleArray

public MDDoubleArray(int[] dimensions)

Creates an empty MDDoubleArray with the dimensions.

MDDoubleArray

public MDDoubleArray(int[] dimensions,
             int capacityHyperRows)

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

MDDoubleArray

public MDDoubleArray(double[] flattenedArray,
             int[] dimensions)

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

MDDoubleArray

public MDDoubleArray(double[] flattenedArray,
             int[] dimensions,
             boolean checkdimensions)

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

MDDoubleArray

public MDDoubleArray(double[][] matrix)

Creates a MDDoubleArray 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.

MDDoubleArray

public MDDoubleArray(double[][] matrix,
             int[] dimensions)

Creates a MDDoubleArray 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.Double>

getAsObject

public java.lang.Double 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.Double>

setToObject

public void setToObject(java.lang.Double 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.Double>

getAsObject

public java.lang.Double 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.Double>

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.Double 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.Double>

Parameters:

value - The new value to set.

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

getAsFlatArray

public double[] 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.Double>

getCopyAsFlatArray

public double[] 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.Double>

get

public double get(int... indices)

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

get

public double 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 double 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 double 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(double value,
       int... indices)

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

set

public void set(double 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(double 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(double 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 double[][] 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