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

public final Enum StepNormalizerBounds

extends Enum<StepNormalizerBounds>
Class Inheritance

Step normalizer bounds settings. They influence whether the underlying fixed step size step handler is called for the first and last points. Note that if the last point coincides with a normalized point, then the underlying fixed step size step handler is always called, regardless of these settings.
Since
3.0
See Also
FieldStepNormalizer, StepNormalizer, StepNormalizerMode

Field Summary

Modifier and TypeField and Description
public static final StepNormalizerBounds
BOTH

Include both the first and last points.

public static final StepNormalizerBounds
FIRST

Include the first point, but not the last point.

private final boolean
first

Whether the first point should be passed to the underlying fixed step size step handler.

public static final StepNormalizerBounds
LAST

Include the last point, but not the first point.

private final boolean
last

Whether the last point should be passed to the underlying fixed step size step handler.

public static final StepNormalizerBounds
NEITHER

Do not include the first and last points.

Constructor Summary

AccessConstructor and Description
private
StepNormalizerBounds(final boolean
Whether the first point should be passed to the underlying fixed step size step handler.
first
,
final boolean
Whether the last point should be passed to the underlying fixed step size step handler.
last
)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

value indicating whether the first point should be passed to the underlying fixed step size step handler.
firstIncluded
()

Returns a value indicating whether the first point should be passed to the underlying fixed step size step handler.

public boolean

Returns:

value indicating whether the last point should be passed to the underlying fixed step size step handler.
lastIncluded
()

Returns a value indicating whether the last point should be passed to the underlying fixed step size step handler.

public static StepNormalizerBounds
public static StepNormalizerBounds[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BOTHback to summary
public static final StepNormalizerBounds BOTH

Include both the first and last points.

FIRSTback to summary
public static final StepNormalizerBounds FIRST

Include the first point, but not the last point.

firstback to summary
private final boolean first

Whether the first point should be passed to the underlying fixed step size step handler.

LASTback to summary
public static final StepNormalizerBounds LAST

Include the last point, but not the first point.

lastback to summary
private final boolean last

Whether the last point should be passed to the underlying fixed step size step handler.

NEITHERback to summary
public static final StepNormalizerBounds NEITHER

Do not include the first and last points.

Constructor Detail

StepNormalizerBoundsback to summary
private StepNormalizerBounds(final boolean first, final boolean last)

Simple constructor.

Parameters
first:boolean

Whether the first point should be passed to the underlying fixed step size step handler.

last:boolean

Whether the last point should be passed to the underlying fixed step size step handler.

Method Detail

firstIncludedback to summary
public boolean firstIncluded()

Returns a value indicating whether the first point should be passed to the underlying fixed step size step handler.

Returns:boolean

value indicating whether the first point should be passed to the underlying fixed step size step handler.

lastIncludedback to summary
public boolean lastIncluded()

Returns a value indicating whether the last point should be passed to the underlying fixed step size step handler.

Returns:boolean

value indicating whether the last point should be passed to the underlying fixed step size step handler.

valueOfback to summary
public static StepNormalizerBounds valueOf(String name)
valuesback to summary
public static StepNormalizerBounds[] values()