ch.systemsx.cisd.hdf5

Class HDF5TimeDurationMDArray

java.lang.Object

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

ch.systemsx.cisd.hdf5.HDF5TimeDurationMDArray

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry>

public class HDF5TimeDurationMDArray
extends ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

A multi-dimensional array of time durations.

See Also:

Serialized Form

Nested Class Summary

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

ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry

Constructor Summary

Constructors

Constructor and Description
HDF5TimeDurationMDArray(HDF5TimeDuration[] timeDurations, int[] dimensions) Creates an array of timeDurations using the smallest time unit.
HDF5TimeDurationMDArray(HDF5TimeDuration[] timeDurations, int[] dimensions, HDF5TimeUnit timeUnit) Creates an array of timeDurations using a common timeUnit.
HDF5TimeDurationMDArray(int[] dimensions, HDF5TimeUnit timeUnit) Creates an array of dimension dimensions with timeUnit.
HDF5TimeDurationMDArray(long[] timeDurations, int[] dimensions, HDF5TimeUnit timeUnit) Creates an array of timeDurations using a common timeUnit.
HDF5TimeDurationMDArray(ch.systemsx.cisd.base.mdarray.MDLongArray timeDurations, HDF5TimeUnit timeUnit) Creates an array of timeDurations using a common timeUnit.

Method Summary

Modifier and Type	Method and Description
int	capacity() Returns the capacity of elements in the array.
int	computeIndex(int... indices) Computes the linear index for the multi-dimensional indices provided.
int	computeIndex(int indexX, int indexY) Computes the linear index for the two-dimensional (indexX, indexY) provided.
int	computeIndex(int indexX, int indexY, int indexZ) Computes the linear index for the three-dimensional (indexX, indexY, indexZ) provided.
int[]	computeReverseIndex(int linearIndex) Computes the multi-dimensional index from the linearIndex.
int	decNumberOfHyperRows(int count) Decrease the number of hyper-rows by count.
int[]	dimensions() Returns the number of elements.
boolean	equals(java.lang.Object obj)
HDF5TimeDuration	get(HDF5TimeUnit targetUnit, int... indices) Returns the value of array at the position defined by indices in the given targetUnit.
HDF5TimeDuration	get(HDF5TimeUnit targetUnit, int index) Returns the value of a one-dimensional array at the position defined by index in the given targetUnit.
HDF5TimeDuration	get(HDF5TimeUnit targetUnit, int indexX, int indexY) Returns the value of a two-dimensional array at the position defined by indexX and indexY in the given targetUnit.
HDF5TimeDuration	get(HDF5TimeUnit targetUnit, int indexX, int indexY, int indexZ) Returns the value of a three-dimensional array at the position defined by indexX, indexY and indexZ in the given targetUnit.
long	get(int... indices)
long	get(int index)
long	get(int indexX, int indexY)
long	get(int indexX, int indexY, int indexZ)
long[]	getAsFlatArray() Returns the time duration values as a flat array.
long[]	getAsFlatArray(HDF5TimeUnit targetUnit) Returns the time duration values as a flat array in the given targetUnit.
java.lang.Long	getAsObject(int... indices) Return an object which has the same value as the element of the array specified by indices.
java.lang.Long	getAsObject(int linearIndex) Return an object which has the same value as the element of the array specified by linearIndex.
long[]	getCopyAsFlatArray() Returns a copy of the array in flattened form.
int	getLength() Returns the number of elements.
HDF5TimeUnit	getUnit() Returns the time unit.
long	getValue(HDF5TimeUnit targetUnit, int... indices) Returns the value element index in the given targetUnit.
long	getValue(HDF5TimeUnit targetUnit, int index) Returns the value element index in the given targetUnit.
long	getValue(HDF5TimeUnit targetUnit, int indexX, int indexY) Returns the value element index in the given targetUnit.
long	getValue(HDF5TimeUnit targetUnit, int indexX, int indexY, int indexZ) Returns the value element index in the given targetUnit.
long	getValue(int... indices) Returns the value element indices.
long	getValue(int index) Returns the value element index.
long	getValue(int indexX, int indexY) Returns the value element (indexX,indexY).
long	getValue(int indexX, int indexY, int indexZ) Returns the value element (indexX,indexY,indexZ).
ch.systemsx.cisd.base.mdarray.MDLongArray	getValues() Returns the time duration values.
ch.systemsx.cisd.base.mdarray.MDLongArray	getValues(HDF5TimeUnit targetUnit) Returns the time duration values in the given targetUnit.
int	hashCode()
int	incNumberOfHyperRows(int count) Increase the number of hyper-rows by count.
java.util.Iterator<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry>	iterator()
long[]	longDimensions() Returns the number of elements.
int	numberOfHyperRows() Returns the current number of hyper rows of of this array.
int	rank() Returns the rank of the array.
void	set(long value, int... indices)
void	set(long value, int index)
void	set(long value, int indexX, int indexY)
void	set(long value, int indexX, int indexY, int indexZ)
void	setToObject(java.lang.Long value, int... indices) Sets the element of the array specified by indices to the particular value.
void	setToObject(java.lang.Long value, int linearIndex) Sets the element of the array specified by linearIndex to the particular value.
int	size() Returns the number of elements in the array.
int	size(int dim) Returns the extent of the array along its dim-th axis.
long[][]	toMatrix()
java.lang.String	toString()

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

getLength, getLength, getLength, getLength, toInt, toLong

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HDF5TimeDurationMDArray

public HDF5TimeDurationMDArray(ch.systemsx.cisd.base.mdarray.MDLongArray timeDurations,
                               HDF5TimeUnit timeUnit)

Creates an array of timeDurations using a common timeUnit.

HDF5TimeDurationMDArray

public HDF5TimeDurationMDArray(long[] timeDurations,
                               int[] dimensions,
                               HDF5TimeUnit timeUnit)

Creates an array of timeDurations using a common timeUnit.

HDF5TimeDurationMDArray

public HDF5TimeDurationMDArray(int[] dimensions,
                               HDF5TimeUnit timeUnit)

Creates an array of dimension dimensions with timeUnit.

HDF5TimeDurationMDArray

public HDF5TimeDurationMDArray(HDF5TimeDuration[] timeDurations,
                               int[] dimensions,
                               HDF5TimeUnit timeUnit)

Creates an array of timeDurations using a common timeUnit.

HDF5TimeDurationMDArray

public HDF5TimeDurationMDArray(HDF5TimeDuration[] timeDurations,
                               int[] dimensions)

Creates an array of timeDurations using the smallest time unit.

Method Detail

getUnit

public HDF5TimeUnit getUnit()

Returns the time unit.

getAsFlatArray

public long[] getAsFlatArray()

Returns the time duration values as a flat array.

Specified by:

getAsFlatArray in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

dimensions

public int[] dimensions()

Returns the number of elements.

Overrides:

dimensions in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

longDimensions

public long[] longDimensions()

Returns the number of elements.

Overrides:

longDimensions in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

getLength

public int getLength()

Returns the number of elements.

getValues

public ch.systemsx.cisd.base.mdarray.MDLongArray getValues()

Returns the time duration values.

getValues

public ch.systemsx.cisd.base.mdarray.MDLongArray getValues(HDF5TimeUnit targetUnit)

Returns the time duration values in the given targetUnit.

getAsFlatArray

public long[] getAsFlatArray(HDF5TimeUnit targetUnit)

Returns the time duration values as a flat array in the given targetUnit.

get

public HDF5TimeDuration get(HDF5TimeUnit targetUnit,
                            int index)

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

Do not call for arrays other than one-dimensional!

get

public HDF5TimeDuration get(HDF5TimeUnit targetUnit,
                            int indexX,
                            int indexY)

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

Do not call for arrays other than two-dimensional!

get

public HDF5TimeDuration get(HDF5TimeUnit targetUnit,
                            int indexX,
                            int indexY,
                            int indexZ)

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

Do not call for arrays other than three-dimensional!

get

public HDF5TimeDuration get(HDF5TimeUnit targetUnit,
                            int... indices)

Returns the value of array at the position defined by indices in the given targetUnit.

getValue

public long getValue(int index)

Returns the value element index.

Do not call for arrays other than one-dimensional!

getValue

public long getValue(int indexX,
                     int indexY)

Returns the value element (indexX,indexY).

Do not call for arrays other than two-dimensional!

getValue

public long getValue(int indexX,
                     int indexY,
                     int indexZ)

Returns the value element (indexX,indexY,indexZ).

Do not call for arrays other than three-dimensional!

getValue

public long getValue(int... indices)

Returns the value element indices.

getValue

public long getValue(HDF5TimeUnit targetUnit,
                     int index)

Returns the value element index in the given targetUnit.

Do not call for arrays other than one-dimensional!

getValue

public long getValue(HDF5TimeUnit targetUnit,
                     int indexX,
                     int indexY)

Returns the value element index in the given targetUnit.

Do not call for arrays other than one-dimensional!

getValue

public long getValue(HDF5TimeUnit targetUnit,
                     int indexX,
                     int indexY,
                     int indexZ)

Returns the value element index in the given targetUnit.

Do not call for arrays other than one-dimensional!

getValue

public long getValue(HDF5TimeUnit targetUnit,
                     int... indices)

Returns the value element index in the given targetUnit.

Do not call for arrays other than one-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

toString

public java.lang.String toString()

Overrides:

toString in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

getAsObject

public java.lang.Long getAsObject(int linearIndex)

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

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

Specified by:

getAsObject in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

Parameters:

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

Returns:

The value at the specified index.

getAsObject

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

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

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

Specified by:

getAsObject in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

setToObject

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

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

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

Specified by:

setToObject in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

setToObject

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

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

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

Specified by:

setToObject in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

Parameters:

value - The new value to set.

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

getCopyAsFlatArray

public long[] getCopyAsFlatArray()

Description copied from class: ch.systemsx.cisd.base.mdarray.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 ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

capacity

public int capacity()

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Returns the capacity of elements in the array.

Specified by:

capacity in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

incNumberOfHyperRows

public int incNumberOfHyperRows(int count)

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Increase the number of hyper-rows by count. Doubles the capacity if needed.

Overrides:

incNumberOfHyperRows in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

Returns:

The new number of rows.

rank

public int rank()

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Returns the rank of the array.

Overrides:

rank in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

size

public int size(int dim)

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Returns the extent of the array along its dim-th axis.

Overrides:

size in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

size

public int size()

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Returns the number of elements in the array.

Overrides:

size in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

numberOfHyperRows

public int numberOfHyperRows()

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Returns the current number of hyper rows of of this array.

Overrides:

numberOfHyperRows in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

decNumberOfHyperRows

public int decNumberOfHyperRows(int count)

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Decrease the number of hyper-rows by count.

Overrides:

decNumberOfHyperRows in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

Returns:

The new number of rows.

computeIndex

public int computeIndex(int... indices)

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Computes the linear index for the multi-dimensional indices provided.

Overrides:

computeIndex in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

computeReverseIndex

public int[] computeReverseIndex(int linearIndex)

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Computes the multi-dimensional index from the linearIndex.

Overrides:

computeReverseIndex in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

computeIndex

public int computeIndex(int indexX,
                        int indexY)

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Computes the linear index for the two-dimensional (indexX, indexY) provided.

Overrides:

computeIndex in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

computeIndex

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

Description copied from class: ch.systemsx.cisd.base.mdarray.MDAbstractArray

Computes the linear index for the three-dimensional (indexX, indexY, indexZ) provided.

Overrides:

computeIndex in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

iterator

public java.util.Iterator<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry> iterator()

Specified by:

iterator in interface java.lang.Iterable<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry>

Overrides:

iterator in class ch.systemsx.cisd.base.mdarray.MDAbstractArray<java.lang.Long>

get

public long get(int index)

See Also:

MDLongArray.get(int)

get

public long get(int indexX,
                int indexY)

See Also:

MDLongArray.get(int, int)

get

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

See Also:

MDLongArray.get(int, int, int)

get

public long get(int... indices)

See Also:

MDLongArray.get(int[])

set

public void set(long value,
                int index)

See Also:

MDLongArray.set(long, int)

set

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

See Also:

MDLongArray.set(long, int, int)

set

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

See Also:

MDLongArray.set(long, int, int, int)

set

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

See Also:

MDLongArray.set(long, int[])

toMatrix

public long[][] toMatrix()

See Also:

MDLongArray.toMatrix()