de.gsi.math.functions

Class CauchyLorentzFunction

java.lang.Object

de.gsi.math.functions.AbstractFunction

de.gsi.math.functions.AbstractFunction1D

de.gsi.math.functions.CauchyLorentzFunction

All Implemented Interfaces:

Function, Function1D

public class CauchyLorentzFunction
extends AbstractFunction1D
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
CauchyLorentzFunction(String name) initialise the Cauchy-Lorentz distribution function parameter order: parameter[0] = location (default: 0.0) parameter[1] = scale (default: 1.0)
CauchyLorentzFunction(String name, double[] parameter) initialise the Cauchy-Lorentz distribution function parameter order: parameter[0] = location (default: 0.0) parameter[1] = scale (default: 1.0)

Method Summary

Modifier and Type	Method and Description
double	getValue(double x)

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

getInputDimension, getOutputDimension, isErrorEstimateComputed, setErrorEstimateComputation

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, getValues

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

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

Constructor Detail

CauchyLorentzFunction

public CauchyLorentzFunction(String name)

initialise the Cauchy-Lorentz distribution function parameter order: parameter[0] = location (default: 0.0) parameter[1] = scale (default: 1.0)

Parameters:

name - function name

CauchyLorentzFunction

public CauchyLorentzFunction(String name,
                             double[] parameter)

initialise the Cauchy-Lorentz distribution function parameter order: parameter[0] = location (default: 0.0) parameter[1] = scale (default: 1.0)

Parameters:

name - function name

parameter - parameter

Method Detail

getValue

public double getValue(double x)

Specified by:

getValue in interface Function1D