Top Description Fields Constructors Methods
org.apache.commons.math3.optim.univariate

public Class SearchInterval

extends Object
implements OptimizationData
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.optim.OptimizationData
Imports
org.apache.commons.math3.optim.OptimizationData, org.apache.commons.math3.exception.NumberIsTooLargeException, .OutOfRangeException

Search interval and (optional) start value.
Immutable class.
Since
3.1

Field Summary

Modifier and TypeField and Description
private final double
lower

Lower bound.

private final double
start

Start value.

private final double
upper

Upper bound.

Constructor Summary

AccessConstructor and Description
public
SearchInterval(double
Lower bound.
lo
,
double
Upper bound.
hi
,
double
Start value.
init
)

public
SearchInterval(double
Lower bound.
lo
,
double
Upper bound.
hi
)

Method Summary

Modifier and TypeMethod and Description
public double

Returns:

the upper bound.
getMax
()

Gets the upper bound.

public double

Returns:

the lower bound.
getMin
()

Gets the lower bound.

public double

Returns:

the start value.
getStartValue
()

Gets the start value.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

lowerback to summary
private final double lower

Lower bound.

startback to summary
private final double start

Start value.

upperback to summary
private final double upper

Upper bound.

Constructor Detail

SearchIntervalback to summary
public SearchInterval(double lo, double hi, double init)
Parameters
lo:double

Lower bound.

hi:double

Upper bound.

init:double

Start value.

Exceptions
NumberIsTooLargeException:
if lo >= hi.
OutOfRangeException:
if init < lo or init > hi.
SearchIntervalback to summary
public SearchInterval(double lo, double hi)
Parameters
lo:double

Lower bound.

hi:double

Upper bound.

Exceptions
NumberIsTooLargeException:
if lo >= hi.

Method Detail

getMaxback to summary
public double getMax()

Gets the upper bound.

Returns:double

the upper bound.

getMinback to summary
public double getMin()

Gets the lower bound.

Returns:double

the lower bound.

getStartValueback to summary
public double getStartValue()

Gets the start value.

Returns:double

the start value.