hep.aida.ref.pdf
Class Step

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

All Implemented Interfaces:

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

public class Step

extends Function

Author:

The FreeHEP team @ SLAC

Source Code:

Step.java

Field Summary

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

DEPENDENT, FUNCTION, PARAMETER

Constructor Summary

Step(String name)

Step(String name, Dependent x)

Step(String name, Dependent x, Parameter a, Parameter b)

Step(String name, int type)

Step(String name, int type, Dependent x)

Step(String name, int type, Dependent x, Parameter a, Parameter b)

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

Constructor Detail

Step

public Step(String name)

Step

public Step(String name,
            int type)

Step

public Step(String name,
            Dependent x)

Step

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

Step

public Step(String name,
            Dependent x,
            Parameter a,
            Parameter b)

Step

public Step(String name,
            int type,
            Dependent x,
            Parameter a,
            Parameter b)

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