de.gsi.math.functions

Class AbstractFunction1D

java.lang.Object

de.gsi.math.functions.AbstractFunction

de.gsi.math.functions.AbstractFunction1D

All Implemented Interfaces:

Function, Function1D

Direct Known Subclasses:

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

public abstract class AbstractFunction1D
extends AbstractFunction
implements Function1D

Field Summary

Fields inherited from class de.gsi.math.functions.AbstractFunction

fparameter, fparameterCopy, fparameterFixed, fparameterMax, fparameterMin, fparameterName, isFitterMode

Constructor Summary

Constructors

Constructor and Description
AbstractFunction1D(String name, double[] parameter)
AbstractFunction1D(String name, double[] parameters, String[] parameterNames)
AbstractFunction1D(String name, int nparm)

Method Summary

Modifier and Type	Method and Description
int	getInputDimension()
int	getOutputDimension()
boolean	isErrorEstimateComputed()
void	setErrorEstimateComputation(boolean state) sets whether error estimates is included into exports/estimates etc.

Methods inherited from class de.gsi.math.functions.AbstractFunction

addFunction, addListener, clearParameterValues, fixParameter, getFreeParameterCount, getFunctions, getID, getName, getParameterCount, getParameterName, getParameterRangeMaximum, getParameterRangeMinimum, getParameterValue, getParameterValues, invokeListener, isFitterMode, isParameterFixed, printParameters, printParameters, removeFunction, removeListener, setFitterMode, setParameterCount, setParameterName, setParameterRange, setParameterValue, setParameterValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gsi.math.functions.Function1D

getDataSetEstimate, getDataSetEstimate, getValue, getValues

Methods inherited from interface de.gsi.math.functions.Function

clearParameterValues, fixParameter, getFreeParameterCount, getID, getName, getParameterCount, getParameterName, getParameterRangeMaximum, getParameterRangeMinimum, getParameterValue, isFitterMode, isParameterFixed, setFitterMode, setParameterCount, setParameterName, setParameterRange, setParameterValue, setParameterValues

Constructor Detail

AbstractFunction1D

public AbstractFunction1D(String name,
                          double[] parameter)

Parameters:

name - function name

parameter - parameter array

AbstractFunction1D

public AbstractFunction1D(String name,
                          double[] parameters,
                          String[] parameterNames)

Parameters:

name - function name

parameters - parameter array

parameterNames - paramter names

AbstractFunction1D

public AbstractFunction1D(String name,
                          int nparm)

Parameters:

name - function name

nparm - number of free parameter

Method Detail

getInputDimension

public int getInputDimension()

Specified by:

getInputDimension in interface Function

Returns:

the input dimension of the function

getOutputDimension

public int getOutputDimension()

Specified by:

getOutputDimension in interface Function

Returns:

the output dimension of the function

isErrorEstimateComputed

public boolean isErrorEstimateComputed()

Returns:

true: error estimated is included in exports/estimates etc.

setErrorEstimateComputation

public void setErrorEstimateComputation(boolean state)

sets whether error estimates is included into exports/estimates etc.

Parameters:

state - true: compute error estimate