org.jscience.mathematics.functions
Class DiscreteFunction<X,Y>

java.lang.Object
  javolution.context.RealtimeObject
      org.jscience.mathematics.functions.Function<X,Y>
          org.jscience.mathematics.functions.DiscreteFunction<X,Y>

All Implemented Interfaces:

java.io.Serializable, Realtime, Immutable

public final class DiscreteFunction<X,Y>
extends Function<X,Y>

This class represents a function defined from a mapping betweem two sets (points and values).

Instance of this class can be used to approximate continuous functions or to numerically solve differential systems.

Version:

3.0, February 13, 2006

Author:

Jean-Marie Dautelle

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javolution.context.RealtimeObject

RealtimeObject.Factory<T extends RealtimeObject>

Nested classes/interfaces inherited from interface javolution.context.Realtime

Realtime.ObjectSpace

Constructor Summary

DiscreteFunction(java.util.SortedMap<X,Y> pointValues, Interpolator<X,Y> interpolator, Variable<X> variable)
Creates the discrete function for the specified point-value entries.

Method Summary

Y	evaluate() Evaluates this function using its variables current values.
Interpolator<X,Y>	getInterpolator() Returns the interpolator used by this discrete function.
java.util.SortedMap<X,Y>	getPointValues() Returns the point-value entries of this discrete function.
java.util.List<Variable<X>>	getVariables() Returns a lexically ordered list of the variables (or arguments) for this function (empty list for constant functions).
boolean	move(Realtime.ObjectSpace os) Moves this real-time object to the specified object space.

Methods inherited from class org.jscience.mathematics.functions.Function

compose, differentiate, divide, equals, evaluate, evaluate, getVariable, hashCode, integrate, minus, plus, pow, times, toText

Methods inherited from class javolution.context.RealtimeObject

export, isLocal, moveHeap, preserve, toString, unpreserve

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DiscreteFunction

public DiscreteFunction(java.util.SortedMap<X,Y> pointValues,
                        Interpolator<X,Y> interpolator,
                        Variable<X> variable)

Creates the discrete function for the specified point-value entries.

Parameters:

pointValues - the point-value entries of this function.

interpolator - the interpolator.

variable - this function variable.

Method Detail

getPointValues

public java.util.SortedMap<X,Y> getPointValues()

Returns the point-value entries of this discrete function.

Returns:

the point-value mapping.

getInterpolator

public Interpolator<X,Y> getInterpolator()

Returns the interpolator used by this discrete function.

Returns:

the interpolator used to estimate the value between two points.

evaluate

public Y evaluate()

Description copied from class: Function

Evaluates this function using its variables current values.

Specified by:

evaluate in class Function<X,Y>

Returns:

the evaluation of this function.

move

public boolean move(Realtime.ObjectSpace os)

Description copied from class: Function

Moves this real-time object to the specified object space.

Specified by:

move in interface Realtime

Overrides:

move in class Function<X,Y>

Parameters:

os - the object space to move this real-time object to.

Returns:

true if the move has to be propagated to external real-time references; false otherwise.

getVariables

public java.util.List<Variable<X>> getVariables()

Description copied from class: Function

Returns a lexically ordered list of the variables (or arguments) for this function (empty list for constant functions).

Specified by:

getVariables in class Function<X,Y>

Returns:

this function current unset variables (sorted).