Top Description Inners Constructors Methods
org.apache.commons.math3.ode.sampling

public Class DummyStepHandler

extends Object
implements StepHandler
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.ode.sampling.StepHandler

This class is a step handler that does nothing.

This class is provided as a convenience for users who are only interested in the final state of an integration and not in the intermediate steps. Its handleStep method does nothing.

Since this class has no internal state, it is implemented using the Singleton design pattern. This means that only one instance is ever created, which can be retrieved using the getInstance method. This explains why there is no public constructor.

Since
1.2
See Also
StepHandler

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DummyStepHandler.LazyHolder

Holder for the instance.

Constructor Summary

AccessConstructor and Description
private
DummyStepHandler()

Private constructor.

Method Summary

Modifier and TypeMethod and Description
public static DummyStepHandler

Returns:

the only instance
getInstance
()

Get the only instance.

public void
handleStep(final StepInterpolator
interpolator for the last accepted step. For efficiency purposes, the various integrators reuse the same object on each call, so if the instance wants to keep it across all calls (for example to provide at the end of the integration a continuous model valid throughout the integration range), it should build a local copy using the clone method and store this copy.
interpolator
,
final boolean
true if the step is the last one
isLast
)

Implements org.apache.commons.math3.ode.sampling.StepHandler.handleStep.

Handle the last accepted step.

public void
init(double
start value of the independent time variable
t0
,
double[]
array containing the start value of the state vector
y0
,
double
target time for the integration
t
)

Implements org.apache.commons.math3.ode.sampling.StepHandler.init.

Initialize step handler at the start of an ODE integration.

private Object

Returns:

the singleton instance
readResolve
()

Handle deserialization of the singleton.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DummyStepHandlerback to summary
private DummyStepHandler()

Private constructor. The constructor is private to prevent users from creating instances (Singleton design-pattern).

Method Detail

getInstanceback to summary
public static DummyStepHandler getInstance()

Get the only instance.

Returns:DummyStepHandler

the only instance

handleStepback to summary
public void handleStep(final StepInterpolator interpolator, final boolean isLast)

Implements org.apache.commons.math3.ode.sampling.StepHandler.handleStep.

Handle the last accepted step. This method does nothing in this class.

Parameters
interpolator:StepInterpolator

interpolator for the last accepted step. For efficiency purposes, the various integrators reuse the same object on each call, so if the instance wants to keep it across all calls (for example to provide at the end of the integration a continuous model valid throughout the integration range), it should build a local copy using the clone method and store this copy.

isLast:boolean

true if the step is the last one

initback to summary
public void init(double t0, double[] y0, double t)

Implements org.apache.commons.math3.ode.sampling.StepHandler.init.

Doc from org.apache.commons.math3.ode.sampling.StepHandler.init.

Initialize step handler at the start of an ODE integration.

This method is called once at the start of the integration. It may be used by the step handler to initialize some internal data if needed.

Parameters
t0:double

start value of the independent time variable

y0:double[]

array containing the start value of the state vector

t:double

target time for the integration

readResolveback to summary
private Object readResolve()

Handle deserialization of the singleton.

Returns:Object

the singleton instance

org.apache.commons.math3.ode.sampling back to summary

private Class DummyStepHandler.LazyHolder

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.commons.math3.ode.sampling.DummyStepHandler.LazyHolder

Holder for the instance.

We use here the Initialization On Demand Holder Idiom.

Field Summary

Modifier and TypeField and Description
private static final DummyStepHandler
INSTANCE

Cached field instance.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
private static final DummyStepHandler INSTANCE

Cached field instance.

Constructor Detail

LazyHolderback to summary
private LazyHolder()