xal.extension.fit.lsm

Class ModelFunction1D

java.lang.Object

xal.extension.fit.lsm.ModelFunction1D

All Implemented Interfaces:

ModelFunction

public abstract class ModelFunction1D
extends java.lang.Object
implements ModelFunction

This is an abstract adapter class for a model function with one independent variable. It delegates calls of getValue and getDerivative methods of interface to the abstract methods with the same names and different signatures. The signatures are different in a very simple way. The array of independent variables is replaced by a simple double value.

Constructor Summary

Constructors

Constructor and Description
ModelFunction1D()

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
abstract double	getDerivative(double x, double[] a, int a_index) Returns the partial derivative of the model function for the particular value of independent variable 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
abstract double	getValue(double x, double[] a) Returns the value of the model function for the particular value of the independent variable and parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelFunction1D

public ModelFunction1D()

Method Detail

getValue

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

Returns the value of the model function for the particular value of the independent variable and parameters

Parameters:

x - The value of independent variable

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

Returns:

The value of the function

getDerivative

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

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

Parameters:

x - The value of independent variable

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

getValue

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

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

Specified by:

getValue in interface ModelFunction

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

public final 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

Specified by:

getDerivative in interface ModelFunction

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