org.jscience.util.mapper
Class MappableScalar

java.lang.Object
  extended by org.jscience.util.mapper.MappableScalar
All Implemented Interfaces:
ArraySliceMappable

public class MappableScalar
extends java.lang.Object
implements ArraySliceMappable

Wrapper class around a scalar in order to have it implement the ArraySliceMappable interface.


Constructor Summary
MappableScalar()
          Simple constructor.
MappableScalar(double value)
          Simple constructor.
 
Method Summary
 int getStateDimension()
          Get the dimension of the internal array.
 double getValue()
          Get the value stored in the instance.
 void mapStateFromArray(int start, double[] array)
          Reinitialize internal state from the specified array slice data.
 void mapStateToArray(int start, double[] array)
          Store internal state data into the specified array slice.
 void setValue(double value)
          Set the value stored in the instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MappableScalar

public MappableScalar()
Simple constructor. Build a mappable scalar


MappableScalar

public MappableScalar(double value)
Simple constructor. Build a mappable scalar from its initial value

Parameters:
value - initial value of the scalar
Method Detail

getValue

public double getValue()
Get the value stored in the instance.

Returns:
value stored in the instance

setValue

public void setValue(double value)
Set the value stored in the instance.

Parameters:
value - value to store in the instance

getStateDimension

public int getStateDimension()
Get the dimension of the internal array.

Specified by:
getStateDimension in interface ArraySliceMappable
Returns:
dimension of the array (always 1 for this class)

mapStateFromArray

public void mapStateFromArray(int start,
                              double[] array)
Reinitialize internal state from the specified array slice data.

Specified by:
mapStateFromArray in interface ArraySliceMappable
Parameters:
start - start index in the array
array - array holding the data to extract

mapStateToArray

public void mapStateToArray(int start,
                            double[] array)
Store internal state data into the specified array slice.

Specified by:
mapStateToArray in interface ArraySliceMappable
Parameters:
start - start index in the array
array - array where data should be stored