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

pack-priv sealed Enum Transformer

extends Enum<Transformer>
Class Inheritance
Imports
org.apache.commons.math3.util.FastMath, .Precision

Transformer for g functions.
Since
3.2
See Also
EventFilter, FilterType

Field Summary

Modifier and TypeField and Description
public static final Transformer
MAX

Transformer computing transformed = max(+Precision#SAFE_MIN, -g, +g).

public static final Transformer
MIN

Transformer computing transformed = min(-Precision#SAFE_MIN, -g, +g).

public static final Transformer
MINUS

Transformer computing transformed = -g.

public static final Transformer
PLUS

Transformer computing transformed = g.

public static final Transformer
UNINITIALIZED

Transformer computing transformed = 0.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
protected abstract double

Returns:

transformed value of function g
transformed
(double
raw value of function g
g
)

Transform value of function g.

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

Field Detail

MAXback to summary
public static final Transformer MAX

Transformer computing transformed = max(+Precision#SAFE_MIN, -g, +g).

When this transformer is applied, the transformed function is guaranteed to be always strictly positive (i.e. there are no roots).

MINback to summary
public static final Transformer MIN

Transformer computing transformed = min(-Precision#SAFE_MIN, -g, +g).

When this transformer is applied, the transformed function is guaranteed to be always strictly negative (i.e. there are no roots).

MINUSback to summary
public static final Transformer MINUS

Transformer computing transformed = -g.

When this transformer is applied, the roots of the original function are preserved, with reversed increasing/decreasing status.

PLUSback to summary
public static final Transformer PLUS

Transformer computing transformed = g.

When this transformer is applied, the roots of the original function are preserved, with the same increasing/decreasing status.

UNINITIALIZEDback to summary
public static final Transformer UNINITIALIZED

Transformer computing transformed = 0.

This transformer is used when we initialize the filter, until we get at least one non-zero value to select the proper transformer.

Constructor Detail

Transformerback to summary
private Transformer()

Method Detail

transformedback to summary
protected abstract double transformed(double g)

Transform value of function g.

Parameters
g:double

raw value of function g

Returns:double

transformed value of function g

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