Package ch.systemsx.cisd.base.mdarray

Class MDShortArray

java.lang.Object

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

ch.systemsx.cisd.base.mdarray.MDShortArray

All Implemented Interfaces:

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

public final class MDShortArray
extends MDAbstractArray<java.lang.Short>

A multi-dimensional short array.

See Also:

Serialized Form

Nested Class Summary

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

MDAbstractArray.ArrayEntry

Field Summary

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

capacityHyperRows, dimensions, hyperRowLength, size

Constructor Summary

Constructors

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

Method Summary

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

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

computeHyperRowLength, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MDShortArray

public MDShortArray(long[] dimensions)

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

MDShortArray

public MDShortArray(long[] dimensions,
                    long capacityHyperRows)

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

MDShortArray

public MDShortArray(short[] flattenedArray,
                    long[] dimensions)

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

MDShortArray

public MDShortArray(short[] flattenedArray,
                    long[] dimensions,
                    boolean checkdimensions)

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

MDShortArray

public MDShortArray(int[] dimensions)

Creates an empty MDShortArray with the dimensions.

MDShortArray

public MDShortArray(int[] dimensions,
                    int capacityHyperRows)

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

MDShortArray

public MDShortArray(short[] flattenedArray,
                    int[] dimensions)

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

MDShortArray

public MDShortArray(short[] flattenedArray,
                    int[] dimensions,
                    boolean checkdimensions)

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

MDShortArray

public MDShortArray(short[][] matrix)

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

MDShortArray

public MDShortArray(short[][] matrix,
                    int[] dimensions)

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

MDShortArray

public MDShortArray(MDShortArray template)

Creates an independent copy (clone) of the template provided.

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

getAsObject

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

setToObject

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

getAsObject

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

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

Parameters:

value - The new value to set.

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

getAsFlatArray

public short[] 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.Short>

getCopyAsFlatArray

public short[] 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.Short>

adaptCapacityHyperRows

protected void adaptCapacityHyperRows()

Specified by:

adaptCapacityHyperRows in class MDAbstractArray<java.lang.Short>

get

public short get(int... indices)

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

get

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

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

set

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

clone

public MDShortArray clone()

Overrides:

clone in class java.lang.Object