Package org.apache.commons.math4.legacy.optim.nonlinear.scalar

Class LineSearchTolerance

java.lang.Object

org.apache.commons.math4.legacy.optim.Tolerance

org.apache.commons.math4.legacy.optim.nonlinear.scalar.LineSearchTolerance

All Implemented Interfaces:

OptimizationData

public class LineSearchTolerance
extends Tolerance

Tolerances for line search.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
LineSearchTolerance(double relative, double absolute, double range)

Method Summary

Modifier and Type	Method	Description
double	getInitialBracketingRange()

Methods inherited from class org.apache.commons.math4.legacy.optim.Tolerance

getAbsoluteTolerance, getRelativeTolerance

Methods inherited from class java.lang.Object

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

Constructor Detail

LineSearchTolerance

public LineSearchTolerance(double relative,
                           double absolute,
                           double range)

Parameters:

relative - Relative tolerance.

absolute - Absolute tolerance.

range - Extent of the initial interval used to find an interval that brackets the optimum. If the optimized function varies a lot in the vicinity of the optimum, it may be necessary to provide a value lower than the distance between successive local minima.

Method Detail

getInitialBracketingRange

public double getInitialBracketingRange()

Returns:

the initial bracketing range.