org.ddogleg.optimization.impl

Class LevenbergBase

java.lang.Object

org.ddogleg.optimization.impl.LevenbergBase

Direct Known Subclasses:

LevenbergDenseBase

public abstract class LevenbergBase
extends java.lang.Object

Base class for Levenberg type algorithms. TODO describe in more detail

Constructor Summary

Constructors

Constructor and Description
LevenbergBase(double initialDampParam) Specifies termination condition and dampening parameter

Method Summary

Modifier and Type	Method and Description
void	addToMessage(java.lang.String message)
double	getFnorm()
int	getIterationCount()
java.lang.String	getMessage()
double[]	getParameters()
void	initialize(double[] initial) Sets the initial parameter being searched.
boolean	isConverged()
boolean	isUpdatedParameters()
boolean	iterate() Performs a single step in the optimization.
void	setConvergence(double ftol, double gtol) Specify convergence tolerances
void	setInitialDampParam(double initialDampParam) Specify the initial value of the dampening parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

LevenbergBase

public LevenbergBase(double initialDampParam)

Specifies termination condition and dampening parameter

Parameters:

initialDampParam - Initial value of the dampening parameter. Tune.. try 1e-3;

Method Detail

setConvergence

public void setConvergence(double ftol,
                           double gtol)

Specify convergence tolerances

Parameters:

gtol - absolute convergence tolerance based on gradient norm. 0 ≤ gtol

setInitialDampParam

public void setInitialDampParam(double initialDampParam)

Specify the initial value of the dampening parameter.

Parameters:

initialDampParam - initial value

initialize

public void initialize(double[] initial)

Sets the initial parameter being searched.

Parameters:

initial -

getParameters

public double[] getParameters()

iterate

public boolean iterate()

Performs a single step in the optimization.

Returns:

true if the optimization has finished.

isConverged

public boolean isConverged()

getIterationCount

public int getIterationCount()

addToMessage

public void addToMessage(java.lang.String message)

getMessage

public java.lang.String getMessage()

getFnorm

public double getFnorm()

isUpdatedParameters

public boolean isUpdatedParameters()