org.apache.commons.math.ode
Class HighamHall54StepInterpolator

java.lang.Object
  extended by org.apache.commons.math.ode.AbstractStepInterpolator
      extended by org.apache.commons.math.ode.RungeKuttaStepInterpolator
          extended by org.apache.commons.math.ode.HighamHall54StepInterpolator
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, StepInterpolator

 class HighamHall54StepInterpolator
extends RungeKuttaStepInterpolator

This class represents an interpolator over the last step during an ODE integration for the 5(4) Higham and Hall integrator.

Since:
1.2
Version:
$Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
See Also:
HighamHall54Integrator

Field Summary
private static long serialVersionUID
          Serializable version identifier
 
Fields inherited from class org.apache.commons.math.ode.RungeKuttaStepInterpolator
equations, yDotK
 
Fields inherited from class org.apache.commons.math.ode.AbstractStepInterpolator
currentState, currentTime, h, interpolatedState, interpolatedTime, previousTime
 
Constructor Summary
HighamHall54StepInterpolator()
          Simple constructor.
HighamHall54StepInterpolator(HighamHall54StepInterpolator interpolator)
          Copy constructor.
 
Method Summary
protected  void computeInterpolatedState(double theta, double oneMinusThetaH)
          Compute the state at the interpolated time.
protected  StepInterpolator doCopy()
          Really copy the finalized instance.
 
Methods inherited from class org.apache.commons.math.ode.RungeKuttaStepInterpolator
readExternal, reinitialize, writeExternal
 
Methods inherited from class org.apache.commons.math.ode.AbstractStepInterpolator
copy, doFinalize, finalizeStep, getCurrentTime, getInterpolatedState, getInterpolatedTime, getPreviousTime, isForward, readBaseExternal, reinitialize, setInterpolatedTime, shift, storeTime, writeBaseExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serializable version identifier

See Also:
Constant Field Values
Constructor Detail

HighamHall54StepInterpolator

public HighamHall54StepInterpolator()
Simple constructor. This constructor builds an instance that is not usable yet, the AbstractStepInterpolator.reinitialize(double[], boolean) method should be called before using the instance in order to initialize the internal arrays. This constructor is used only in order to delay the initialization in some cases. The EmbeddedRungeKuttaIntegrator uses the prototyping design pattern to create the step interpolators by cloning an uninitialized model and latter initializing the copy.


HighamHall54StepInterpolator

public HighamHall54StepInterpolator(HighamHall54StepInterpolator interpolator)
Copy constructor.

Parameters:
interpolator - interpolator to copy from. The copy is a deep copy: its arrays are separated from the original arrays of the instance
Method Detail

doCopy

protected StepInterpolator doCopy()
Really copy the finalized instance.

Specified by:
doCopy in class AbstractStepInterpolator
Returns:
a copy of the finalized instance

computeInterpolatedState

protected void computeInterpolatedState(double theta,
                                        double oneMinusThetaH)
                                 throws DerivativeException
Compute the state at the interpolated time.

Specified by:
computeInterpolatedState in class AbstractStepInterpolator
Parameters:
theta - normalized interpolation abscissa within the step (theta is zero at the previous time step and one at the current time step)
oneMinusThetaH - time gap between the interpolated time and the current time
Throws:
DerivativeException - this exception is propagated to the caller if the underlying user function triggers one