hep.aida.ref.pdf
Class Sum

java.lang.Object
  hep.aida.ref.pdf.Variable
      hep.aida.ref.pdf.Function
          hep.aida.ref.pdf.Sum

All Implemented Interfaces:

FunctionDispatcher, HasName, HasUnits, HasValue, hep.aida.IFunction, hep.aida.IModelFunction, VariableListener

public class Sum

extends Function

Author:

The FreeHEP team @ SLAC.

Source Code:

Sum.java

Field Summary

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

DEPENDENT, FUNCTION, PARAMETER

Constructor Summary

Sum(String name, ArrayList functionsArray)

Sum(String name, ArrayList functionsArray, ArrayList fractionsArray)

Sum(String name, Function f1, Function f2)

Sum(String name, Function f1, Function f2, Parameter p)

Method Summary

Function	addend(int index)
double	evaluateAnalyticalNormalization(Dependent dep)
double	evaluateAnalyticalVariableGradient(Variable var) To be overwritten by classes extending Function.
double	fraction(int index)
double	functionValue()
boolean	hasAnalyticalNormalization(Dependent dep) To be overwritten if Function provides analytical normalization.
boolean	hasAnalyticalVariableGradient(Variable var) To be overwritten by classes extending Function.
int	nAddend()
protected void	updateNormalization()
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, excludeNormalizationAll, functionMaxValue, functionValue, getDependent, getDependent, getNormalizationParameter, getParameter, getParameter, gradient, gradient, hasDependent, hasParameter, hasVariable, includeNormalizationAll, indexOfParameter, isComposite, isEqual, isNormalized, maxValue, normalizationParameter, normalizationRange, normalizationRangeChanged, normalize, notifyFunctionChanged, numberOfDependents, numberOfParameters, parameter, parameterGradient, parameterGradient, parameterNames, parameters, providesGradient, providesGradientWithRespectToVariable, providesNormalization, providesParameterGradient, removeFunctionListener, setCodeletString, setNormalizationParamter, setParameter, setParameters, setTitle, setValue, setVariableValue, title, value, 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

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

Constructor Detail

Sum

public Sum(String name,
           Function f1,
           Function f2)

Sum

public Sum(String name,
           Function f1,
           Function f2,
           Parameter p)

Sum

public Sum(String name,
           ArrayList functionsArray)

Sum

public Sum(String name,
           ArrayList functionsArray,
           ArrayList fractionsArray)

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

functionValue

public double functionValue()

Overrides:

functionValue 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

evaluateAnalyticalVariableGradient

public double evaluateAnalyticalVariableGradient(Variable var)

Description copied from class: Function

To be overwritten by classes extending Function. This method is used internally by this class to evaluate the derivative with respect to a given Variable.

Overrides:

evaluateAnalyticalVariableGradient 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

updateNormalization

protected void updateNormalization()

Overrides:

updateNormalization in class Function

nAddend

public int nAddend()

addend

public Function addend(int index)

fraction

public double fraction(int index)