FreeHEP API
Version current

hep.aida.ref.pdf
Class Exponential

java.lang.Object
  extended byhep.aida.ref.pdf.Variable
      extended byhep.aida.ref.pdf.Function
          extended byhep.aida.ref.pdf.Exponential
All Implemented Interfaces:
FunctionDispatcher, HasName, HasUnits, HasValue, hep.aida.IFunction, hep.aida.IModelFunction, VariableListener

public class Exponential
extends Function

Author:
The FreeHEP team @ SLAC.
Source Code:
Exponential.java

Field Summary
static int DECAY
           
static int NORMAL
           
 
Fields inherited from class hep.aida.ref.pdf.Variable
DEPENDENT, FUNCTION, PARAMETER
 
Constructor Summary
Exponential(String name)
           
Exponential(String name, Dependent x)
           
Exponential(String name, Dependent x, int type)
           
Exponential(String name, Dependent x, Parameter alpha)
           
Exponential(String name, Dependent x, Parameter alpha, int type)
           
Exponential(String name, int type)
           
 
Method Summary
 double evaluateAnalyticalNormalization(Dependent dep)
           
 double evaluateAnalyticalVariableGradient(Variable var)
          To be overwritten by classes extending Function.
 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.
 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, updateNormalization, 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
 

Field Detail

NORMAL

public static int NORMAL

DECAY

public static int DECAY
Constructor Detail

Exponential

public Exponential(String name)

Exponential

public Exponential(String name,
                   int type)

Exponential

public Exponential(String name,
                   Dependent x)

Exponential

public Exponential(String name,
                   Dependent x,
                   int type)

Exponential

public Exponential(String name,
                   Dependent x,
                   Parameter alpha)

Exponential

public Exponential(String name,
                   Dependent x,
                   Parameter alpha,
                   int type)
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

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.