xal.extension.fit.lsm

Class SolverLM

java.lang.Object

xal.extension.fit.lsm.SolverLM

All Implemented Interfaces:

FitSolver

public class SolverLM
extends java.lang.Object
implements FitSolver

The Levenberg-Marquardt fitting solver.

Constructor Summary

Constructors

Constructor and Description
SolverLM() Constructor for the SolverLM object

Method Summary

Modifier and Type	Method and Description
int	getIterLimit() Description of the Method
double	getLambdaFactor() Gets the lambdaFactor attribute of the SolverLM object
double	getLambdaIni() Gets the lambdaIni attribute of the SolverLM object
double	getLambdaMax() Gets the lambdaMax attribute of the SolverLM object
double	getToll() Gets the toll attribute of the SolverLM object
static void	main(java.lang.String[] args) MAIN for debugging
void	setIterLimit(int total_iter_limit) Sets the iterLimit attribute of the SolverLM object
void	setLambdaFactor(double factor) Sets the lambdaFactor attribute of the SolverLM object
void	setLambdaIni(double lambda_ini) Sets the lambdaIni attribute of the SolverLM object
void	setLambdaMax(double lambda_max) Sets the lambdaMax attribute of the SolverLM object
void	setToll(double eps_toll) Sets the toll attribute of the SolverLM object
boolean	solve(DataStore ds, ModelFunction mf, double[] a_ini, double[] a_err_ini, boolean[] a_use) Solve the fitting problem.

Methods inherited from class java.lang.Object

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

Constructor Detail

SolverLM

public SolverLM()

Constructor for the SolverLM object

Method Detail

solve

public boolean solve(DataStore ds,
                     ModelFunction mf,
                     double[] a_ini,
                     double[] a_err_ini,
                     boolean[] a_use)

Solve the fitting problem.

Specified by:

solve in interface FitSolver

Parameters:

ds - The data for fitting.

a_ini - The initial values of the parameters.

a_err_ini - The parameter values' errors.

a_use - The mask array specifying if the parameter will be used in fitting.

mf - The model function

Returns:

The boolean value specifying success of fitting.

setLambdaFactor

public void setLambdaFactor(double factor)

Sets the lambdaFactor attribute of the SolverLM object

Parameters:

factor - The new lambdaFactor value

getLambdaFactor

public double getLambdaFactor()

Gets the lambdaFactor attribute of the SolverLM object

Returns:

The lambdaFactor value

setLambdaIni

public void setLambdaIni(double lambda_ini)

Sets the lambdaIni attribute of the SolverLM object

Parameters:

lambda_ini - The new lambdaIni value

getLambdaIni

public double getLambdaIni()

Gets the lambdaIni attribute of the SolverLM object

Returns:

The lambdaIni value

setLambdaMax

public void setLambdaMax(double lambda_max)

Sets the lambdaMax attribute of the SolverLM object

Parameters:

lambda_max - The new lambdaMax value

getLambdaMax

public double getLambdaMax()

Gets the lambdaMax attribute of the SolverLM object

Returns:

The lambdaMax value

setToll

public void setToll(double eps_toll)

Sets the toll attribute of the SolverLM object

Parameters:

eps_toll - The new toll value

getToll

public double getToll()

Gets the toll attribute of the SolverLM object

Returns:

The toll value

setIterLimit

public void setIterLimit(int total_iter_limit)

Sets the iterLimit attribute of the SolverLM object

Parameters:

total_iter_limit - The new iterLimit value

getIterLimit

public int getIterLimit()

Description of the Method

Returns:

Description of the Return Value

main

public static void main(java.lang.String[] args)

MAIN for debugging

Parameters:

args - The array of strings as parameters