org.hipparchus.analysis.solvers

Class BracketedRealFieldUnivariateSolver.Interval<T extends CalculusFieldElement<T>>

java.lang.Object

org.hipparchus.analysis.solvers.BracketedRealFieldUnivariateSolver.Interval<T>

Type Parameters:

T - the element type

Enclosing interface:

BracketedRealFieldUnivariateSolver<T extends CalculusFieldElement<T>>

public static class BracketedRealFieldUnivariateSolver.Interval<T extends CalculusFieldElement<T>>
extends Object

An interval of a function that brackets a root.

Contains two end points and the value of the function at the two end points.

See Also:

BracketedRealFieldUnivariateSolver.solveInterval(int, CalculusFieldUnivariateFunction, CalculusFieldElement, CalculusFieldElement)

Constructor Summary

Constructors

Constructor and Description
Interval(T leftAbscissa, T leftValue, T rightAbscissa, T rightValue) Construct a new interval with the given end points.

Method Summary

Modifier and Type	Method and Description
T	getLeftAbscissa() Get the left abscissa.
T	getLeftValue() Get the function value at getLeftAbscissa().
T	getRightAbscissa() Get the right abscissa.
T	getRightValue() Get the function value at getRightAbscissa().
T	getSide(AllowedSolution allowed) Get the abscissa corresponding to the allowed side.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Interval

public Interval(T leftAbscissa,
                T leftValue,
                T rightAbscissa,
                T rightValue)

Construct a new interval with the given end points.

Parameters:

leftAbscissa - is the abscissa value at the left side of the interval.

leftValue - is the function value at leftAbscissa.

rightAbscissa - is the abscissa value on the right side of the interval. Must be greater than or equal to leftAbscissa.

rightValue - is the function value at rightAbscissa.

Method Detail

getLeftAbscissa

public T getLeftAbscissa()

Get the left abscissa.

Returns:

abscissa of the start of the interval.

getRightAbscissa

public T getRightAbscissa()

Get the right abscissa.

Returns:

abscissa of the end of the interval.

getLeftValue

public T getLeftValue()

Get the function value at getLeftAbscissa().

Returns:

value of the function at the start of the interval.

getRightValue

public T getRightValue()

Get the function value at getRightAbscissa().

Returns:

value of the function at the end of the interval.

getSide

public T getSide(AllowedSolution allowed)

Get the abscissa corresponding to the allowed side.

Parameters:

allowed - side of the root.

Returns:

the abscissa on the selected side of the root.