de.gsi.math.functions

Interface Function

All Known Subinterfaces:

Function1D, FunctionND

All Known Implementing Classes:

AbstractFunction, AbstractFunction1D, AbstractFunctionND, BetaDistributionFunction, BetaFunction, BreitWignerFunction, CauchyLorentzFunction, CombFunction, EllipseFunction, GaussianFunction, HeavisideStepFunction, LogNormalFunction, PoissonFunction, PolynomialFunction, RandomFunction, RandomWalkFunction, SigmoidFunction, TrigCosineFunction, TrigSineFunction, TruncatedGaussianFunction

public interface Function

generic function interface

Author:

rstein

Method Summary

Modifier and Type	Method and Description
void	clearParameterValues() resets all parameter values to zero
void	fixParameter(int id, boolean state) sets
int	getFreeParameterCount()
String	getID()
int	getInputDimension()
String	getName()
int	getOutputDimension()
int	getParameterCount()
String	getParameterName(int id)
double	getParameterRangeMaximum(int id)
double	getParameterRangeMinimum(int id)
double	getParameterValue(int id)
boolean	isFitterMode() returns whether function is in use by fitting routine <expert function>
boolean	isParameterFixed(int id) returns whether given parameter is fixed (static) or not
void	setFitterMode(boolean state) sets whether function is in use by fitting routine <expert function>
void	setParameterCount(int count)
void	setParameterName(int id, String paramName) sets the name of a by 'id' given parameter
void	setParameterRange(int id, double minRange, double maxRange) sets the range of a by 'id' given parameter N.B.
void	setParameterValue(int id, double value) sets the value of a by 'id' given parameter
void	setParameterValues(double[] value) sets the parameter values using an array the array is required to have at most getParameterCount() indices

Method Detail

clearParameterValues

void clearParameterValues()

resets all parameter values to zero

fixParameter

void fixParameter(int id,
                  boolean state)

sets

Parameters:

id - the parameter id

state - true: parameter is fixed, false: parameter is free

getFreeParameterCount

int getFreeParameterCount()

Returns:

the number of free parameter

getID

String getID()

Returns:

unique function ID

getInputDimension

int getInputDimension()

Returns:

the input dimension of the function

getName

String getName()

Returns:

function name (e.g. brief description/Latex notation)

getOutputDimension

int getOutputDimension()

Returns:

the output dimension of the function

getParameterCount

int getParameterCount()

Returns:

the number of parameter

getParameterName

String getParameterName(int id)

Parameters:

id - the parameter id

Returns:

the name of a by 'id' given parameter

getParameterRangeMaximum

double getParameterRangeMaximum(int id)

Parameters:

id - the parameter id

Returns:

the maximum value of a by 'id' given parameter range N.B. depending on the fitter, the range may be used only as a hint

getParameterRangeMinimum

double getParameterRangeMinimum(int id)

Parameters:

id - the parameter id

Returns:

the minimum value of a by 'id' given parameter range N.B. depending on the fitter, the range may be used only as a hint

getParameterValue

double getParameterValue(int id)

Parameters:

id - parameter id

Returns:

the value of a by 'id' given parameter

isFitterMode

boolean isFitterMode()

returns whether function is in use by fitting routine <expert function>

Returns:

true: function is used within a fitting routine

isParameterFixed

boolean isParameterFixed(int id)

returns whether given parameter is fixed (static) or not

Parameters:

id - parameter id

Returns:

true: if parameter is fixed

setFitterMode

void setFitterMode(boolean state)

sets whether function is in use by fitting routine <expert function>

Parameters:

state - true: function is used within a fitting routine

setParameterCount

void setParameterCount(int count)

Parameters:

count - number of free parameter

setParameterName

void setParameterName(int id,
                      String paramName)

sets the name of a by 'id' given parameter

Parameters:

id - the parameter id

paramName - name for the given pararameter 'id'

setParameterRange

void setParameterRange(int id,
                       double minRange,
                       double maxRange)

sets the range of a by 'id' given parameter N.B. depending on the fitter, the range may be used only as a hint

Parameters:

id - the parameter id

minRange - minimum parameter range

maxRange - maximum parameter range

setParameterValue

void setParameterValue(int id,
                       double value)

sets the value of a by 'id' given parameter

Parameters:

id - the parameter id

value - new value of parameter

setParameterValues

void setParameterValues(double[] value)

sets the parameter values using an array the array is required to have at most getParameterCount() indices

Parameters:

value - new parameter values