public enum AllowedSolution extends Enum<AllowedSolution>
(bracketed univariate real) root-finding algorithm
may accept as solutions.
This basically controls whether or not under-approximations and
over-approximations are allowed.
If all solutions are accepted (ANY_SIDE
), then the solution
that the root-finding algorithm returns for a given root may be equal to the
actual root, but it may also be an approximation that is slightly smaller
or slightly larger than the actual root. Root-finding algorithms generally
only guarantee that the returned solution is within the requested
tolerances. In certain cases however, in particular for
state events
of
ODE solvers
, it
may be necessary to guarantee that a solution is returned that lies on a
specific side the solution.
BracketedUnivariateSolver
Enum Constant and Description |
---|
ABOVE_SIDE
Only solutions for which values are greater than or equal to zero are
acceptable as solutions for root-finding.
|
ANY_SIDE
There are no additional side restriction on the solutions for
root-finding.
|
BELOW_SIDE
Only solutions for which values are less than or equal to zero are
acceptable as solutions for root-finding.
|
LEFT_SIDE
Only solutions that are less than or equal to the actual root are
acceptable as solutions for root-finding.
|
RIGHT_SIDE
Only solutions that are greater than or equal to the actual root are
acceptable as solutions for root-finding.
|
Modifier and Type | Method and Description |
---|---|
static AllowedSolution |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static AllowedSolution[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final AllowedSolution ANY_SIDE
public static final AllowedSolution LEFT_SIDE
public static final AllowedSolution RIGHT_SIDE
public static final AllowedSolution BELOW_SIDE
public static final AllowedSolution ABOVE_SIDE
public static AllowedSolution[] values()
for (AllowedSolution c : AllowedSolution.values()) System.out.println(c);
public static AllowedSolution valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2003–2016 The Apache Software Foundation. All rights reserved.