edu.mines.jtk.opt
Class LineSearch.Result

java.lang.Object
  edu.mines.jtk.opt.LineSearch.Result

Enclosing class:

LineSearch

public static class LineSearch.Result
extends java.lang.Object

The result of a line search.

Field Summary

int	ended The condition that ended the search.
double	f The value of the function f(s).
double	g The value of the derivative f'(s).
int	neval The number of function and derivative evaluations.
double	s The step s.

Method Summary

boolean

converged() Determines whether the line search converged.

Methods inherited from class java.lang.Object

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

Field Detail

s

public final double s

The step s.

f

public final double f

The value of the function f(s).

g

public final double g

The value of the derivative f'(s).

ended

public final int ended

The condition that ended the search.

neval

public final int neval

The number of function and derivative evaluations.

Method Detail

converged

public boolean converged()

Determines whether the line search converged.

Returns:

true, if converged; false, otherwise.