Package etomica.data.types

Class CastGroupToDoubleArray

java.lang.Object

etomica.data.DataProcessor

etomica.data.types.CastGroupToDoubleArray

All Implemented Interfaces:

DataPipe, IDataSink

public class CastGroupToDoubleArray
extends DataProcessor

A DataProcessor that converts a homogeneous DataGroup into a multidimensional DataDoubleArray. All elements in group must be of the same data type. If the group contains only one element, the effect is the same as applying CastToDoubleArray to the element. Otherwise, if d is the dimension of each grouped element, the resulting DataDoubleArray will be of dimension d+1. The added dimension corresponds to the different elements of the group.

For example:

• if the DataGroup contains 8 DataDouble instances (thus d = 0), the cast gives a one-dimensional DataDoubleArray of length 8.
• if the DataGroup contains 4 Vector3D instances (thus d = 1), the cast gives a two-dimensional DataDoubleArray of dimensions (4, 3).
• if the DataGroup contains 5 two-dimensional (d = 2) DataDoubleArray of shape (7,80), the cast gives a three-dimensional DataDoubleArray of shape (5, 7, 80).

etc.

Field Summary

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
CastGroupToDoubleArray()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
protected IData	processData(IData data)	Converts data in given group to a DataDoubleArray as described in the general comments for this class.
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Prepares processor to handle Data.

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getDataSink, getTag, putData, putDataInfo, setDataSink

Methods inherited from class java.lang.Object

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

Constructor Detail

CastGroupToDoubleArray

public CastGroupToDoubleArray()

Sole constructor.

Method Detail

processDataInfo

protected IDataInfo processDataInfo(IDataInfo inputDataInfo)

Prepares processor to handle Data. Uses given DataInfo to determine the type of Data to expect in subsequent calls to processData.

Specified by:

processDataInfo in class DataProcessor

Parameters:

inputDataInfo - the DataInfo of the Data that will be input to this DataProcessor

Returns:

the DataInfo of the Data that will be output by this DataProcessor

Throws:

java.lang.IllegalArgumentException - if DataInfo does not indicate a DataGroup, or if DataInfo indicates that expected DataGroup will not be homogeneous

processData

protected IData processData(IData data)

Converts data in given group to a DataDoubleArray as described in the general comments for this class.

Specified by:

processData in class DataProcessor

Parameters:

data - the Data for processing

Returns:

the processed Data, for sending downstream (if not null)

Throws:

java.lang.ClassCastException - if the given Data is not a DataGroup with Data elements of the type indicated by the most recent call to processDataInfo.