org.apache.commons.math.optimization.general
Class NonLinearConjugateGradientOptimizer.LineSearchFunction

java.lang.Object
  extended by org.apache.commons.math.optimization.general.NonLinearConjugateGradientOptimizer.LineSearchFunction
All Implemented Interfaces:
UnivariateRealFunction
Enclosing class:
NonLinearConjugateGradientOptimizer

private class NonLinearConjugateGradientOptimizer.LineSearchFunction
extends java.lang.Object
implements UnivariateRealFunction

Internal class for line search.

The function represented by this class is the dot product of the objective function gradient and the search direction. Its value is zero when the gradient is orthogonal to the search direction, i.e. when the objective function value is a local extremum along the search direction.


Field Summary
private  double[] searchDirection
          Search direction.
 
Constructor Summary
NonLinearConjugateGradientOptimizer.LineSearchFunction(double[] searchDirection)
          Simple constructor.
 
Method Summary
 double value(double x)
          Compute the value for the function.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

searchDirection

private final double[] searchDirection
Search direction.

Constructor Detail

NonLinearConjugateGradientOptimizer.LineSearchFunction

public NonLinearConjugateGradientOptimizer.LineSearchFunction(double[] searchDirection)
Simple constructor.

Parameters:
searchDirection - search direction
Method Detail

value

public double value(double x)
             throws FunctionEvaluationException
Compute the value for the function.

Specified by:
value in interface UnivariateRealFunction
Parameters:
x - the point for which the function value should be computed
Returns:
the value
Throws:
FunctionEvaluationException - if the function evaluation fails


Copyright (c) 2003-2010 Apache Software Foundation