Apache Commons Math 3.6.1 · org.apache.commons.math3.ode.FieldODEState

Modifier and Type	Field and Description
private final T[][]	secondaryState Secondary state at time.
private final T[]	state Main state at time.
private final T	time Time.

Access	Constructor and Description
public	FieldODEState(T time time, T[] state at time state) Simple constructor.
public	FieldODEState(T time time, T[] state at time state, T[][] state at time (may be null) secondaryState) Simple constructor.

Method Summary

Modifier and Type	Method and Description
protected T[][]	Returns: copied array or null if original array was null copy(final Field<T> field to which elements belong field, final T[][] original array (may be null) original) Copy a two-dimensions array.
public int	Returns: number of secondary states. getNumberOfSecondaryStates() Get the number of secondary states.
public T[]	Returns: secondary state at time getSecondaryState(final int index of the secondary set as returned by `FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations)` (beware index 0 corresponds to main state, additional states start at 1) index) Get secondary state at time.
public int	Returns: secondary state dimension getSecondaryStateDimension(final int index of the secondary set as returned by `FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations)` (beware index 0 corresponds to main state, additional states start at 1) index) Get secondary state dimension.
public T[]	Returns: main state at time getState() Get main state at time.
public int	Returns: main state dimension getStateDimension() Get main state dimension.
public T	Returns: time getTime() Get time.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

secondaryState	back to summary
private final T[][] secondaryState Secondary state at time.

state	back to summary
private final T[] state Main state at time.

time	back to summary
private final T time Time.

Constructor Detail

FieldODEState back to summary

FieldODEState	back to summary
public FieldODEState(T time, T[] state) Simple constructor. Calling this constructor is equivalent to call `FieldODEState(time, state, null)`. Parameters time:T time state:T[] state at time

public FieldODEState(T time, T[] state)

Simple constructor.

Calling this constructor is equivalent to call FieldODEState(time, state, null).

Parameters

time:T: time
state:T[]: state at time

FieldODEState	back to summary
public FieldODEState(T time, T[] state, T[][] secondaryState) Simple constructor. Parameters time:T time state:T[] state at time secondaryState:T[][] state at time (may be null)

FieldODEState

back to summary

public FieldODEState(T time, T[] state, T[][] secondaryState)

Simple constructor.

Parameters

time:T: time
state:T[]: state at time
secondaryState:T[][]: state at time (may be null)

Method Detail

copy	back to summary
protected T[][] copy(final Field<T> field, final T[][] original) Copy a two-dimensions array. Parameters field:Field<T> field to which elements belong original:T[][] original array (may be null) Returns:T[][] copied array or null if original array was null

copy

back to summary

protected T[][] copy(final Field<T> field, final T[][] original)

Copy a two-dimensions array.

Parameters

field:Field<T>: field to which elements belong
original:T[][]: original array (may be null)

Returns:T[][]

copied array or null if original array was null

getNumberOfSecondaryStates	back to summary
public int getNumberOfSecondaryStates() Get the number of secondary states. Returns:int number of secondary states.

getNumberOfSecondaryStates

back to summary

public int getNumberOfSecondaryStates()

Get the number of secondary states.

Returns:int: number of secondary states.

getSecondaryState back to summary

getSecondaryState	back to summary
public T[] getSecondaryState(final int index) Get secondary state at time. Parameters index:int index of the secondary set as returned by `FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations)` (beware index 0 corresponds to main state, additional states start at 1) Returns:T[] secondary state at time

public T[] getSecondaryState(final int index)

Get secondary state at time.

Parameters

index:int: index of the secondary set as returned by FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations) (beware index 0 corresponds to main state, additional states start at 1)

Returns:T[]

secondary state at time

getSecondaryStateDimension back to summary

getSecondaryStateDimension	back to summary
public int getSecondaryStateDimension(final int index) Get secondary state dimension. Parameters index:int index of the secondary set as returned by `FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations)` (beware index 0 corresponds to main state, additional states start at 1) Returns:int secondary state dimension

public int getSecondaryStateDimension(final int index)

Get secondary state dimension.

Parameters

index:int: index of the secondary set as returned by FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations) (beware index 0 corresponds to main state, additional states start at 1)

Returns:int

secondary state dimension

getState	back to summary
public T[] getState() Get main state at time. Returns:T[] main state at time

getState

back to summary

public T[] getState()

Get main state at time.

Returns:T[]: main state at time

getStateDimension	back to summary
public int getStateDimension() Get main state dimension. Returns:int main state dimension

getStateDimension

back to summary

public int getStateDimension()

Get main state dimension.

Returns:int: main state dimension

getTime	back to summary
public T getTime() Get time. Returns:T time

getTime

back to summary

public T getTime()

Get time.

Returns:T: time

public Class FieldODEState<T extends RealFieldElement<T>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail