hep.aida.ref.pdf

Class IFunctionWrapper

java.lang.Object

hep.aida.ref.pdf.Variable

hep.aida.ref.pdf.Function

hep.aida.ref.pdf.IFunctionWrapper

All Implemented Interfaces:

IFunction, IModelFunction, FunctionDispatcher, HasName, HasUnits, HasValue, VariableListener

public class IFunctionWrapper
extends Function

Wrapper of IFunction. The result is a Function.

Field Summary

Fields inherited from class hep.aida.ref.pdf.Variable

DEPENDENT, FUNCTION, PARAMETER

Constructor Summary

Constructors

Constructor and Description
IFunctionWrapper(java.lang.String name, IFunction f)

Method Summary

Modifier and Type	Method and Description
double	evaluateAnalyticalNormalization(Dependent dep)
double	functionValue()
double[]	gradient()
boolean	hasAnalyticalNormalization(Dependent dep) To be overwritten if Function provides analytical normalization.
boolean	hasAnalyticalVariableGradient(Variable var) To be overwritten by classes extending Function.
boolean	isNormalized() Return true if normalization is currently switched on.
void	normalize(boolean normalize) Normalize by internally adjusting some of the parameters.
double[]	parameterGradient()
double	value() Get the current value.
void	variableChanged(Variable var) This method is invoked when a variable in the function has changed its value.

Methods inherited from class hep.aida.ref.pdf.Function

addFunctionListener, addVariable, addVariables, annotation, codeletString, dimension, evaluateAnalyticalVariableGradient, excludeNormalizationAll, functionMaxValue, functionValue, getDependent, getDependent, getNormalizationParameter, getParameter, getParameter, gradient, includeNormalizationAll, indexOfParameter, isComposite, isEqual, normalizationParameter, normalizationRange, normalizationRangeChanged, numberOfDependents, numberOfParameters, parameter, parameterGradient, parameterNames, parameters, providesGradient, providesGradientWithRespectToVariable, providesNormalization, providesParameterGradient, removeFunctionListener, setCodeletString, setNormalizationParamter, setParameter, setParameters, setTitle, setValue, title, value, variableChangedName, variableChangedRange, variableChangedUnits, variableChangedValue, variableChangingName, variableChangingUnits, variableChangingValue, variableName, variableNames

Methods inherited from class hep.aida.ref.pdf.Variable

addVariableListener, name, removeVariableListener, setName, setUnits, type, units

Methods inherited from class java.lang.Object

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

Constructor Detail

IFunctionWrapper

public IFunctionWrapper(java.lang.String name,
                        IFunction f)

Method Detail

variableChanged

public void variableChanged(Variable var)

Description copied from class: Function

This method is invoked when a variable in the function has changed its value.

Overrides:

variableChanged in class Function

hasAnalyticalVariableGradient

public boolean hasAnalyticalVariableGradient(Variable var)

Description copied from class: Function

To be overwritten by classes extending Function. This method is used internally by this class to determine if a function has can provide an analytical gradient with respect to a given Variable.

Overrides:

hasAnalyticalVariableGradient in class Function

functionValue

public double functionValue()

Overrides:

functionValue in class Function

value

public double value()

Description copied from interface: HasValue

Get the current value.

Specified by:

value in interface HasValue

Overrides:

value in class Function

Returns:

The current value.

gradient

public double[] gradient()

Overrides:

gradient in class Function

parameterGradient

public double[] parameterGradient()

Overrides:

parameterGradient in class Function

isNormalized

public boolean isNormalized()

Description copied from interface: IModelFunction

Return true if normalization is currently switched on.

Specified by:

isNormalized in interface IModelFunction

Overrides:

isNormalized in class Function

normalize

public void normalize(boolean normalize)

Description copied from interface: IModelFunction

Normalize by internally adjusting some of the parameters. When normalization is on then integral of the function in the normalization range equals to 1.

Specified by:

normalize in interface IModelFunction

Overrides:

normalize in class Function

hasAnalyticalNormalization

public boolean hasAnalyticalNormalization(Dependent dep)

Description copied from class: Function

To be overwritten if Function provides analytical normalization.

Overrides:

hasAnalyticalNormalization in class Function

evaluateAnalyticalNormalization

public double evaluateAnalyticalNormalization(Dependent dep)

Overrides:

evaluateAnalyticalNormalization in class Function