etomica.data.types

Class DataDouble

java.lang.Object

etomica.data.types.DataDouble

All Implemented Interfaces:

IData, java.io.Serializable

public class DataDouble
extends java.lang.Object
implements IData, java.io.Serializable

Data object wrapping a single mutable value of type double. Value is public and can be accessed directly.

All arithmetic methods throw ClassCastException if given a Data instance that is not of this type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataDouble.DataInfoDouble
static class	DataDouble.DataInfoDoubleFactory

Field Summary

Fields

Modifier and Type	Field and Description
double	x The wrapped data value held by this object.

Constructor Summary

Constructors

Constructor and Description
DataDouble() Constructs a new instance with given descriptors.

Method Summary

Modifier and Type	Method and Description
void	assignTo(double[] array) Returns a new one-element array formed from the current value of this instance.
void	DE(double y) Divide-equals (/=) operation.
void	DE(IData y) Divide-equals (/=) operation.
void	E(double y) Sets the wrapped double to the given value.
void	E(IData y) Sets the wrapped double to the value in the given instance.
int	getLength() Returns 1, indicating that this data object holds one value.
double	getValue(int i) Returns this instance's value if argument is 0, otherwise throw exception
boolean	isNaN() Returns true if the this instance's value is NaN.
void	map(IFunction function) Maps the function on this instance's value, replacing it with the value returned by the function.
void	ME(IData y) Minus-equals (-=) operation.
void	PE(double y) Plus-equals (+=) operation.
void	PE(IData y) Plus-equals (+=) operation.
void	TE(double y) Times-equals (*=) operation.
void	TE(IData y) Times-equals (*=) operation.
java.lang.String	toString() Returns a string formed from the dataInfo label and this value.

Methods inherited from class java.lang.Object

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

Field Detail

x

public double x

The wrapped data value held by this object.

Constructor Detail

DataDouble

public DataDouble()

Constructs a new instance with given descriptors.

Parameters:

label - a phrase describing the data

dimension - the physical dimensions (e.g., mass, time) of the data

Method Detail

E

public void E(IData y)

Sets the wrapped double to the value in the given instance.

Specified by:

E in interface IData

E

public void E(double y)

Sets the wrapped double to the given value.

Specified by:

E in interface IData

ME

public void ME(IData y)

Minus-equals (-=) operation. Subtracts the value in the given instance from this instance's value.

Specified by:

ME in interface IData

PE

public void PE(IData y)

Plus-equals (+=) operation. Adds the value in the given instance to this instance's value.

Specified by:

PE in interface IData

TE

public void TE(IData y)

Times-equals (*=) operation. Replaces the value in this instance with its value times the value in the given instance.

Specified by:

TE in interface IData

DE

public void DE(IData y)

Divide-equals (/=) operation. Divides this value by the value in the given instance.

Specified by:

DE in interface IData

PE

public void PE(double y)

Plus-equals (+=) operation. Adds the given value to this instance's value.

Specified by:

PE in interface IData

TE

public void TE(double y)

Times-equals (*=) operation. Multiplies this value by that in the given instance.

Specified by:

TE in interface IData

DE

public void DE(double y)

Divide-equals (/=) operation. Divides this value by that in the given instance.

Specified by:

DE in interface IData

isNaN

public boolean isNaN()

Returns true if the this instance's value is NaN.

Specified by:

isNaN in interface IData

map

public void map(IFunction function)

Maps the function on this instance's value, replacing it with the value returned by the function.

Specified by:

map in interface IData

assignTo

public void assignTo(double[] array)

Returns a new one-element array formed from the current value of this instance.

Specified by:

assignTo in interface IData

getLength

public int getLength()

Returns 1, indicating that this data object holds one value.

Specified by:

getLength in interface IData

getValue

public double getValue(int i)

Returns this instance's value if argument is 0, otherwise throw exception

Specified by:

getValue in interface IData

Parameters:

i - index of the desired data value

Returns:

the data value

Throws:

java.lang.IllegalArgumentException - if i != 0

toString

public java.lang.String toString()

Returns a string formed from the dataInfo label and this value.

Overrides:

toString in class java.lang.Object