hep.aida.ref.function
Class AbstractDevModelFunction

java.lang.Object
  extended by hep.aida.ref.function.AbstractDevModelFunction
All Implemented Interfaces:
hep.aida.dev.IDevFunction, hep.aida.dev.IDevModelFunction, hep.aida.IFunction, hep.aida.IModelFunction
Direct Known Subclasses:
ExponentModelFunction, PolynomialModelFunction

public abstract class AbstractDevModelFunction
extends Object
implements hep.aida.dev.IDevModelFunction


Constructor Summary
AbstractDevModelFunction()
           
 
Method Summary
 hep.aida.IAnnotation annotation()
           
 String codeletString()
           
abstract  int dimension()
           
 void excludeNormalizationAll()
           
 void excludeNormalizationAll(int iAxis)
           
 void excludeNormalizationRange(double xMin, double xMax, int iAxis)
           
abstract  double functionValue(double[] var)
           
 double[] gradient(double[] x)
           
 void includeNormalizationAll()
           
 void includeNormalizationAll(int iAxis)
           
 void includeNormalizationRange(double xMin, double xMax, int iAxis)
           
 int indexOfParameter(String name)
           
 boolean isEqual(hep.aida.IFunction f)
           
 boolean isNormalized()
           
 double normalizationAmplitude()
           
 double normalizationAmplitude(ArrayList[] xMin, ArrayList[] xMax)
           
 String normalizationParameter()
           
 hep.aida.IRangeSet normalizationRange(int iAxis)
           
 void normalize(boolean on)
           
abstract  int numberOfParameters()
           
 double parameter(String name)
           
 double[] parameterGradient(double[] x)
           
 String[] parameterNames()
           
 double[] parameters()
           
 boolean providesGradient()
           
 boolean providesNormalization()
           
 boolean providesParameterGradient()
           
 void setAnnotation(hep.aida.IAnnotation ptr)
           
 void setCodeletString(String codelet)
           
 void setDimension(int dim)
           
 boolean setNormalization(boolean provides, boolean is_normalized)
           
 void setNormalizationRange(double rMin, double rMax, int iAxis)
           
 void setNumberOfParameters(int parnum)
           
 void setParameter(String name, double x)
           
 boolean setParameterNames(String[] names)
           
 void setParameters(double[] params)
           
 void setProvidesGradient(boolean yes)
           
 void setProvidesParameterGradient(boolean yes)
           
 void setTitle(String t)
           
 boolean setVariableNames(String[] names)
           
 String title()
           
 double value(double[] var)
           
 String variableName(int i)
           
 String[] variableNames()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractDevModelFunction

public AbstractDevModelFunction()
Method Detail

normalizationParameter

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

dimension

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

numberOfParameters

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

functionValue

public abstract 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 String variableName(int i)
Specified by:
variableName in interface hep.aida.IFunction

variableNames

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

parameterNames

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

indexOfParameter

public int indexOfParameter(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(String name,
                         double x)
                  throws IllegalArgumentException
Specified by:
setParameter in interface hep.aida.IFunction
Throws:
IllegalArgumentException

parameters

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

parameter

public double parameter(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 String codeletString()
Specified by:
codeletString in interface hep.aida.IFunction

setCodeletString

public void setCodeletString(String codelet)
Specified by:
setCodeletString in interface hep.aida.dev.IDevFunction

setDimension

public void setDimension(int dim)
Specified by:
setDimension in interface hep.aida.dev.IDevFunction

setProvidesGradient

public void setProvidesGradient(boolean yes)
Specified by:
setProvidesGradient in interface hep.aida.dev.IDevFunction

setVariableNames

public boolean setVariableNames(String[] names)
Specified by:
setVariableNames in interface hep.aida.dev.IDevFunction

setNumberOfParameters

public void setNumberOfParameters(int parnum)
Specified by:
setNumberOfParameters in interface hep.aida.dev.IDevFunction

setParameterNames

public boolean setParameterNames(String[] names)
Specified by:
setParameterNames in interface hep.aida.dev.IDevFunction

setAnnotation

public void setAnnotation(hep.aida.IAnnotation ptr)
Specified by:
setAnnotation in interface hep.aida.dev.IDevFunction

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

setNormalizationRange

public void setNormalizationRange(double rMin,
                                  double rMax,
                                  int iAxis)

includeNormalizationRange

public void includeNormalizationRange(double xMin,
                                      double xMax,
                                      int iAxis)

excludeNormalizationRange

public void excludeNormalizationRange(double xMin,
                                      double xMax,
                                      int iAxis)

includeNormalizationAll

public void includeNormalizationAll(int iAxis)

excludeNormalizationAll

public void excludeNormalizationAll(int iAxis)

includeNormalizationAll

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

excludeNormalizationAll

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

normalizationRange

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

setNormalization

public boolean setNormalization(boolean provides,
                                boolean is_normalized)
Specified by:
setNormalization in interface hep.aida.dev.IDevModelFunction

setProvidesParameterGradient

public void setProvidesParameterGradient(boolean yes)
Specified by:
setProvidesParameterGradient in interface hep.aida.dev.IDevModelFunction

normalizationAmplitude

public final double normalizationAmplitude()

normalizationAmplitude

public double normalizationAmplitude(ArrayList[] xMin,
                                     ArrayList[] xMax)

title

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

setTitle

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


jHepWork 3.0 ©