Package etomica.data.types

Class DataTable

java.lang.Object

etomica.data.types.DataGroup

etomica.data.types.DataTable

All Implemented Interfaces:

IData, java.io.Serializable

public class DataTable
extends DataGroup
implements IData, java.io.Serializable

Data object that holds double[] arrays as if they are columns in a table. The inner class Column wraps the array along with a descriptive String heading and a Dimension instance that indicates the physical dimensions of the data in the column. Descriptive immutable String labels can also be associated with the rows (row headers). be

The number of columns is set at construction and cannot be changed.

All columns are of equal length (i.e., the length of the double[] arrays is the same for all columns). The common length of the columns is set at construction and cannot be changed.

The label in the DataInfo for this object should be descriptive of the table as a whole; the dimension in the DataInfo will be Dimension.MIXED if the dimensions of the data in the columns are not all the same, otherwise it will be the common dimension of the data in the columns.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataTable.DataInfoTable
static class	DataTable.DataInfoTableFactory

Nested classes/interfaces inherited from class etomica.data.types.DataGroup

DataGroup.DataInfoGroup, DataGroup.DataInfoGroupFactory

Field Summary

Fields inherited from class etomica.data.types.DataGroup

data

Constructor Summary

Constructors

Constructor	Description
DataTable(int nColumns, int nRows)	Creates a new table with a specified number of columns all of a given length.
DataTable(DataDoubleArray[] columns)

Method Summary

Modifier and Type	Method	Description
void	assignTo(double[] array)	Returns a new array formed from the values held by the data instance.
int	getLength()	Returns the number of values held by the data instance.
int	getNRows()	Returns the number of rows in each and every column of the table.
double	getValue(int i)	Returns the i-th data value, where the values are numbered by counting down the first column, then the next, and so on.
protected static DataDoubleArray[]	makeData(int nColumns, int nRows)

Methods inherited from class etomica.data.types.DataGroup

DE, DE, E, E, getData, getNData, isNaN, map, ME, PE, PE, TE, TE, toString

Methods inherited from interface etomica.data.IData

DE, DE, E, E, isNaN, map, ME, PE, PE, TE, TE

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataTable

public DataTable(int nColumns,
                 int nRows)

Creates a new table with a specified number of columns all of a given length. The assigned heading for each column is its ordinal (starting from 0), e.g., the heading of the first column is '0'.

Parameters:

nColumns - the number of columns to make

nRows - the length of each and every column

DataTable

public DataTable(DataDoubleArray[] columns)

Method Detail

makeData

protected static DataDoubleArray[] makeData(int nColumns,
                                            int nRows)

getNRows

public int getNRows()

Returns the number of rows in each and every column of the table.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the DataTable has zero columns

getLength

public int getLength()

Returns the number of values held by the data instance.

Specified by:

getLength in interface IData

Overrides:

getLength in class DataGroup

getValue

public double getValue(int i)

Returns the i-th data value, where the values are numbered by counting down the first column, then the next, and so on.

Specifically, returns column[i/nRows].data[i % nRows].

Specified by:

getValue in interface IData

Overrides:

getValue in class DataGroup

Parameters:

i - index of the desired data value

Returns:

the data value

Throws:

java.lang.IllegalArgumentException - if i >= getLength()

assignTo

public void assignTo(double[] array)

Returns a new array formed from the values held by the data instance.

Specified by:

assignTo in interface IData

Overrides:

assignTo in class DataGroup

Throws:

java.lang.IllegalArgumentException - if the length of the array is not equal to getLength