Package org.hipparchus.analysis.solvers
Enum AllowedSolution
 All Implemented Interfaces:
Serializable
,Comparable<AllowedSolution>
,java.lang.constant.Constable
The kinds of solutions that a
(bracketed univariate real) rootfinding algorithm
may accept as solutions.
This basically controls whether or not underapproximations and
overapproximations are allowed.
If all solutions are accepted (ANY_SIDE
), then the solution
that the rootfinding 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. Rootfinding algorithms generally
only guarantee that the returned solution is within the requested
tolerances. In certain cases however, it may be necessary to guarantee
that a solution is returned that lies on a specific side the solution.
 See Also:

Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary
Enum ConstantDescriptionOnly solutions for which values are greater than or equal to zero are acceptable as solutions for rootfinding.There are no additional side restriction on the solutions for rootfinding.Only solutions for which values are less than or equal to zero are acceptable as solutions for rootfinding.Only solutions that are less than or equal to the actual root are acceptable as solutions for rootfinding.Only solutions that are greater than or equal to the actual root are acceptable as solutions for rootfinding. 
Method Summary
Modifier and TypeMethodDescriptionstatic AllowedSolution
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.

Enum Constant Details

ANY_SIDE
There are no additional side restriction on the solutions for rootfinding. That is, both underapproximations and overapproximations are allowed. So, if a function f(x) has a root at x = x0, then the rootfinding result s may be smaller than x0, equal to x0, or greater than x0. 
LEFT_SIDE
Only solutions that are less than or equal to the actual root are acceptable as solutions for rootfinding. In other words, overapproximations are not allowed. So, if a function f(x) has a root at x = x0, then the rootfinding result s must satisfy s <= x0. 
RIGHT_SIDE
Only solutions that are greater than or equal to the actual root are acceptable as solutions for rootfinding. In other words, underapproximations are not allowed. So, if a function f(x) has a root at x = x0, then the rootfinding result s must satisfy s >= x0. 
BELOW_SIDE
Only solutions for which values are less than or equal to zero are acceptable as solutions for rootfinding. So, if a function f(x) has a root at x = x0, then the rootfinding result s must satisfy f(s) <= 0. 
ABOVE_SIDE
Only solutions for which values are greater than or equal to zero are acceptable as solutions for rootfinding. So, if a function f(x) has a root at x = x0, then the rootfinding result s must satisfy f(s) >= 0.


Method Details

values
Returns an array containing the constants of this enum type, in the order they are declared. Returns:
 an array containing the constants of this enum type, in the order they are declared

valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Parameters:
name
 the name of the enum constant to be returned. Returns:
 the enum constant with the specified name
 Throws:
IllegalArgumentException
 if this enum type has no constant with the specified nameNullPointerException
 if the argument is null
