xal.extension.fit.lsm

Interface ModelFunction

All Known Implementing Classes:

ModelFunction1D

public interface ModelFunction

This interface define a model function and its partial derivatives that will be used in the linear least square method. Users have to implement this interface to use LSM solver from this package.

Method Summary

Modifier and Type	Method and Description
double	getDerivative(double[] x, double[] a, int a_index) Returns the partial derivative of the model function for the particular set of independent variables and parameters and the index of parameters for which the derivative is calculated
double	getValue(double[] x, double[] a) Returns the value of the model function for the particular set of independent variables and parameters

Method Detail

getValue

double getValue(double[] x,
                double[] a)

Returns the value of the model function for the particular set of independent variables and parameters

Parameters:

x - The array with the set of independent variables

a - The array with set of parameters that should be found

Returns:

The value of the function

getDerivative

double getDerivative(double[] x,
                     double[] a,
                     int a_index)

Returns the partial derivative of the model function for the particular set of independent variables and parameters and the index of parameters for which the derivative is calculated

Parameters:

x - The array with the set of independent variables

a - The array with set of parameters that should be found

a_index - The index of parameters for which the derivative is calculated

Returns:

The value of the function