hep.aida.ref.function
Class BaseModelFunction

java.lang.Object
  extended by hep.aida.ref.event.AIDAObservable
      extended by hep.aida.ref.ManagedObject
          extended by hep.aida.ref.function.BaseModelFunction
All Implemented Interfaces:
hep.aida.dev.IDevManagedObject, hep.aida.IFunction, hep.aida.IManagedObject, hep.aida.IModelFunction, Connectable, FunctionDispatcher
Direct Known Subclasses:
JELBaseModelFunction

public class BaseModelFunction
extends ManagedObject
implements hep.aida.IModelFunction, FunctionDispatcher


Constructor Summary
BaseModelFunction(java.lang.String name, java.lang.String title, FunctionCore notNorm, FunctionCore norm)
           
BaseModelFunction(java.lang.String name, java.lang.String tit, hep.aida.IFunction func)
           
 
Method Summary
 void addFunctionListener(FunctionListener listener)
           
 hep.aida.IAnnotation annotation()
           
 void calculateNormalizationAmplitude()
           
 java.lang.String codeletString()
           
 FunctionCore core()
           
 int dimension()
           
 void excludeNormalizationAll()
           
 double functionValue(double[] var)
           
 double getNormalizationAmplitude()
           
 RangeSet[] getRangeSet()
           
 double[] gradient(double[] x)
           
 void includeNormalizationAll()
           
 int indexOfParameter(java.lang.String name)
           
 boolean isEqual(hep.aida.IFunction f)
           
 boolean isNormalized()
           
 java.lang.String normalizationParameter()
           
 hep.aida.IRangeSet normalizationRange(int iAxis)
           
 void normalize(boolean on)
           
 int numberOfParameters()
           
 double[] numericGradient(double[] x)
           
 double[] numericParameterGradient(double[] x)
           
 double parameter(java.lang.String name)
           
 double[] parameterGradient(double[] x)
           
 java.lang.String[] parameterNames()
           
 double[] parameters()
           
 boolean providesGradient()
           
 boolean providesNormalization()
           
 boolean providesParameterGradient()
           
 void removeFunctionListener(FunctionListener listener)
           
 void setCodeletString(java.lang.String codelet)
           
 void setParameter(java.lang.String name, double x)
           
 boolean setParameterNames(java.lang.String[] params)
           
 void setParameters(double[] params)
           
 void setTitle(java.lang.String t)
           
 java.lang.String title()
           
 java.lang.String toString()
           
 double value(double[] var)
           
 java.lang.String variableName(int i)
           
 java.lang.String[] variableNames()
           
 
Methods inherited from class hep.aida.ref.ManagedObject
isFillable, name, setFillable, setName, type, typeForClass
 
Methods inherited from class hep.aida.ref.event.AIDAObservable
addListener, isConnected, removeAllListeners, removeListener, setConnected, setValid, setValidForAll
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface hep.aida.ref.event.Connectable
isConnected, setConnected
 

Constructor Detail

BaseModelFunction

public BaseModelFunction(java.lang.String name,
                         java.lang.String tit,
                         hep.aida.IFunction func)

BaseModelFunction

public BaseModelFunction(java.lang.String name,
                         java.lang.String title,
                         FunctionCore notNorm,
                         FunctionCore norm)
Method Detail

core

public FunctionCore core()

dimension

public int dimension()
Specified by:
dimension in interface hep.aida.IFunction

numberOfParameters

public int numberOfParameters()
Specified by:
numberOfParameters in interface hep.aida.IFunction

functionValue

public double functionValue(double[] var)

value

public final double value(double[] var)
Specified by:
value in interface hep.aida.IFunction

annotation

public hep.aida.IAnnotation annotation()
Specified by:
annotation in interface hep.aida.IFunction

variableName

public java.lang.String variableName(int i)
Specified by:
variableName in interface hep.aida.IFunction

variableNames

public java.lang.String[] variableNames()
Specified by:
variableNames in interface hep.aida.IFunction

parameterNames

public java.lang.String[] parameterNames()
Specified by:
parameterNames in interface hep.aida.IFunction

indexOfParameter

public int indexOfParameter(java.lang.String name)
Specified by:
indexOfParameter in interface hep.aida.IFunction

setParameters

public void setParameters(double[] params)
Specified by:
setParameters in interface hep.aida.IFunction

setParameter

public void setParameter(java.lang.String name,
                         double x)
                  throws java.lang.IllegalArgumentException
Specified by:
setParameter in interface hep.aida.IFunction
Throws:
java.lang.IllegalArgumentException

parameters

public double[] parameters()
Specified by:
parameters in interface hep.aida.IFunction

parameter

public double parameter(java.lang.String name)
Specified by:
parameter in interface hep.aida.IFunction

isEqual

public boolean isEqual(hep.aida.IFunction f)
Specified by:
isEqual in interface hep.aida.IFunction

providesGradient

public boolean providesGradient()
Specified by:
providesGradient in interface hep.aida.IFunction

gradient

public double[] gradient(double[] x)
Specified by:
gradient in interface hep.aida.IFunction

codeletString

public java.lang.String codeletString()
Specified by:
codeletString in interface hep.aida.IFunction

setCodeletString

public void setCodeletString(java.lang.String codelet)

normalizationParameter

public java.lang.String normalizationParameter()
Specified by:
normalizationParameter in interface hep.aida.IFunction

providesNormalization

public boolean providesNormalization()
Specified by:
providesNormalization in interface hep.aida.IModelFunction

normalize

public void normalize(boolean on)
Specified by:
normalize in interface hep.aida.IModelFunction

isNormalized

public boolean isNormalized()
Specified by:
isNormalized in interface hep.aida.IModelFunction

parameterGradient

public double[] parameterGradient(double[] x)
Specified by:
parameterGradient in interface hep.aida.IModelFunction

providesParameterGradient

public boolean providesParameterGradient()
Specified by:
providesParameterGradient in interface hep.aida.IModelFunction

normalizationRange

public hep.aida.IRangeSet normalizationRange(int iAxis)
Specified by:
normalizationRange in interface hep.aida.IModelFunction

includeNormalizationAll

public void includeNormalizationAll()
Specified by:
includeNormalizationAll in interface hep.aida.IModelFunction

excludeNormalizationAll

public void excludeNormalizationAll()
Specified by:
excludeNormalizationAll in interface hep.aida.IModelFunction

getNormalizationAmplitude

public double getNormalizationAmplitude()

calculateNormalizationAmplitude

public void calculateNormalizationAmplitude()

title

public java.lang.String title()
Specified by:
title in interface hep.aida.IFunction

setTitle

public void setTitle(java.lang.String t)
Specified by:
setTitle in interface hep.aida.IFunction

setParameterNames

public boolean setParameterNames(java.lang.String[] params)

numericGradient

public double[] numericGradient(double[] x)

numericParameterGradient

public double[] numericParameterGradient(double[] x)

getRangeSet

public RangeSet[] getRangeSet()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

addFunctionListener

public void addFunctionListener(FunctionListener listener)
Specified by:
addFunctionListener in interface FunctionDispatcher

removeFunctionListener

public void removeFunctionListener(FunctionListener listener)
Specified by:
removeFunctionListener in interface FunctionDispatcher


jHepWork 2.8 (©) S.Chekanov