hep.aida.ref.function
Class AbstractIFunction

java.lang.Object
  hep.aida.ref.event.AIDAObservable
      hep.aida.ref.ManagedObject
          hep.aida.ref.function.AbstractIFunction

All Implemented Interfaces:

hep.aida.dev.IDevManagedObject, IFunction, IManagedObject, IModelFunction, Connectable, FunctionDispatcher, Cloneable

Direct Known Subclasses:

BreitWigner, Exponent, Gauss, Landau, NegativeBinomial, NonParametricFunction, P0, P1, P2, P3, P4, P5, P6, Poisson, Pow, PowModified, UserFunction

public abstract class AbstractIFunction
extends ManagedObject
implements IModelFunction, Cloneable, FunctionDispatcher

AbstractIFunction is implementation of the IFunction. User has to implement "value" method.

Constructor Summary

AbstractIFunction()
No-argument constructor to be used for cloning.

AbstractIFunction(String[] variableNames, String[] parameterNames)
Creates a new instance of AbstractIFunction with specified variable and parameter names.

AbstractIFunction(String title, int dimension, int numberOfParameters)
Creates a new instance of AbstractIFunction with default variable names (x0, x1, ...) and default parameter names (p0, p1, ...)

AbstractIFunction(String title, String[] variableNames, String[] parameterNames)

Method Summary

void	addFunctionListener(FunctionListener listener)
IAnnotation	annotation()
Object	clone()
String	codeletString() String describing the metatype and implementation of the function.
int	dimension() Dimensionality of the domain space.
void	excludeNormalizationAll() Set empty range in all axes.
double[]	gradient(double[] values) Gradient of the function.
void	includeNormalizationAll() Set full range in all axes.
int	indexOfParameter(String str) Return -1 if parameter not found (name undefined).
boolean	isEqual(IFunction iFunction) Compare if functions are the same.
boolean	isNormalized() Return true if normalization is currently switched on.
String	normalizationParameter() Returns the name of the normalization parameter if the function has one.
IRangeSet	normalizationRange(int iAxis) Set the normalization range from -inf to +inf in the i-th axis (dimension).
void	normalize(boolean param) Normalize by internally adjusting some of the parameters.
int	numberOfParameters() Number of parameters.
double	parameter(String str)
double[]	parameterGradient(double[] values) Compute gradient with respect to parameters.
String[]	parameterNames() Names of paramaters.
double[]	parameters() Retrieve current vector of parameters.
boolean	providesGradient() Determine whether function is able to compute gradient.
boolean	providesNormalization()
boolean	providesParameterGradient() Return true if provides parameter gradient.
void	removeFunctionListener(FunctionListener listener)
void	setCodeletString(String str)
void	setParameter(String str, double param) Set parameter's value by name.
void	setParameters(double[] pars) Set new vector of parameters.
void	setTitle(String title) Set the histogram title.
String	title() Get the Function's title.
abstract double	value(double[] v) Provide value for your function here.
String	variableName(int index) Get the symbolic name of i-th variable.
String[]	variableNames() Get all the names in a vector.

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, toString, wait, wait, wait

Methods inherited from interface hep.aida.ref.event.Connectable

isConnected, setConnected

Constructor Detail

AbstractIFunction

public AbstractIFunction()

No-argument constructor to be used for cloning. Created function can not be used directly

AbstractIFunction

public AbstractIFunction(String title,
                         int dimension,
                         int numberOfParameters)

Creates a new instance of AbstractIFunction with default variable names (x0, x1, ...) and default parameter names (p0, p1, ...)

AbstractIFunction

public AbstractIFunction(String[] variableNames,
                         String[] parameterNames)

Creates a new instance of AbstractIFunction with specified variable and parameter names. This constructor must be implemented by all subclasses in order for codelet-based creation to work properly

AbstractIFunction

public AbstractIFunction(String title,
                         String[] variableNames,
                         String[] parameterNames)

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

setCodeletString

public void setCodeletString(String str)

value

public abstract double value(double[] v)

Provide value for your function here. Something like: return p[0]+p[1]*v[0]+p[2]*v[0]*v[0];

Specified by:

value in interface IFunction

providesGradient

public boolean providesGradient()

Description copied from interface: IFunction

Determine whether function is able to compute gradient.

Specified by:

providesGradient in interface IFunction

gradient

public double[] gradient(double[] values)

Description copied from interface: IFunction

Gradient of the function. The result is valid only if providesGradient()==true. Otherwise the result is some default (empty) vector.

Specified by:

gradient in interface IFunction

codeletString

public String codeletString()

Description copied from interface: IFunction

String describing the metatype and implementation of the function. Generic format of the string: codelet:TYPE:LOCATION TYPE part contains only a 'typename' string which is a metatype identifier (used in plugins and catalogues) LOCATION may be: 'file', 'verbatim', or 'catalogue' Detailed description: codelet:typename - no location specified (using 'catalogue') codelet:typename:file:/filename.cpp - a c++ source file codelet:typename:file:/filename.py - a python source file codelet:typename:file:/filename.so - a shared library codelet:typename:catalogue - entry in a catalogue repository codelet:typename:verbatim:cpp \n - c++ source file included verbatim after \n codelet:typename:verbatim:py \n - python source file included verbatim aftern \n Comments: file:/filename is a relative path to $AIDA_FUNCTION_DEFAULT_DIR file://filename is an absolute path Examples: codelet:G:catalogue codelet:userSinus:verbatim:cpp \n { return sin(x); }

Specified by:

codeletString in interface IFunction

annotation

public IAnnotation annotation()

Specified by:

annotation in interface IFunction

dimension

public int dimension()

Description copied from interface: IFunction

Dimensionality of the domain space.

Specified by:

dimension in interface IFunction

indexOfParameter

public int indexOfParameter(String str)

Description copied from interface: IFunction

Return -1 if parameter not found (name undefined). Leave it because there are use cases - some users prefer to use numbers.

Specified by:

indexOfParameter in interface IFunction

numberOfParameters

public int numberOfParameters()

Description copied from interface: IFunction

Number of parameters.

Specified by:

numberOfParameters in interface IFunction

parameter

public double parameter(String str)

Specified by:

parameter in interface IFunction

parameterNames

public String[] parameterNames()

Description copied from interface: IFunction

Names of paramaters. Names should be unique. Case-insensitive for comparison. Case-sensitive for storage and output. All or several names may be left blank "" if the implementation does not want to provide them.

Specified by:

parameterNames in interface IFunction

parameters

public double[] parameters()

Description copied from interface: IFunction

Retrieve current vector of parameters.

Specified by:

parameters in interface IFunction

setParameter

public void setParameter(String str,
                         double param)
                  throws IllegalArgumentException

Description copied from interface: IFunction

Set parameter's value by name.

Specified by:

setParameter in interface IFunction

Parameters:

str - The name of the parameter.

param - The new value of the parameter.

Throws:

IllegalArgumentException - If name does not correspond to a parameter.

setParameters

public void setParameters(double[] pars)
                   throws IllegalArgumentException

Description copied from interface: IFunction

Set new vector of parameters.

Specified by:

setParameters in interface IFunction

Throws:

IllegalArgumentException

setTitle

public void setTitle(String title)
              throws IllegalArgumentException

Description copied from interface: IFunction

Set the histogram title.

Specified by:

setTitle in interface IFunction

Parameters:

title - The title.

Throws:

IllegalArgumentException

title

public String title()

Description copied from interface: IFunction

Get the Function's title.

Specified by:

title in interface IFunction

Returns:

The Function's title.

variableName

public String variableName(int index)

Description copied from interface: IFunction

Get the symbolic name of i-th variable.

Specified by:

variableName in interface IFunction

variableNames

public String[] variableNames()

Description copied from interface: IFunction

Get all the names in a vector.

Specified by:

variableNames in interface IFunction

excludeNormalizationAll

public void excludeNormalizationAll()

Description copied from interface: IModelFunction

Set empty range in all axes.

Specified by:

excludeNormalizationAll in interface IModelFunction

includeNormalizationAll

public void includeNormalizationAll()

Description copied from interface: IModelFunction

Set full range in all axes.

Specified by:

includeNormalizationAll in interface IModelFunction

isNormalized

public boolean isNormalized()

Description copied from interface: IModelFunction

Return true if normalization is currently switched on.

Specified by:

isNormalized in interface IModelFunction

normalizationRange

public IRangeSet normalizationRange(int iAxis)

Description copied from interface: IModelFunction

Set the normalization range from -inf to +inf in the i-th axis (dimension). Full range is the default if not set otherwise. It is still possible to evaluate function outside of the normalization range. PENDING: no methods to retrieve current range!

Specified by:

normalizationRange in interface IModelFunction

normalize

public void normalize(boolean param)

Description copied from interface: IModelFunction

Normalize by internally adjusting some of the parameters. When normalization is on then integral of the function in the normalization range equals to 1.

Specified by:

normalize in interface IModelFunction

parameterGradient

public double[] parameterGradient(double[] values)

Description copied from interface: IModelFunction

Compute gradient with respect to parameters.

Specified by:

parameterGradient in interface IModelFunction

providesNormalization

public boolean providesNormalization()

Specified by:

providesNormalization in interface IModelFunction

providesParameterGradient

public boolean providesParameterGradient()

Description copied from interface: IModelFunction

Return true if provides parameter gradient.

Specified by:

providesParameterGradient in interface IModelFunction

normalizationParameter

public String normalizationParameter()

Description copied from interface: IFunction

Returns the name of the normalization parameter if the function has one.

Specified by:

normalizationParameter in interface IFunction

Returns:

The name of the normalization parameter.null if no such parameter is available

isEqual

public boolean isEqual(IFunction iFunction)

Description copied from interface: IFunction

Compare if functions are the same. PENDING: define exactly what it means ;)

Specified by:

isEqual in interface IFunction

addFunctionListener

public void addFunctionListener(FunctionListener listener)

Specified by:

addFunctionListener in interface FunctionDispatcher

removeFunctionListener

public void removeFunctionListener(FunctionListener listener)

Specified by:

removeFunctionListener in interface FunctionDispatcher