|
|||||||||
PREV CLASS NEXT CLASS | All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthep.aida.ref.function.AbstractIFunction
public abstract class AbstractIFunction
AbstractIFunction is implementation of the IFunction. User has to implement "value" method.
Constructor Summary | |
---|---|
AbstractIFunction()
No-argument constructor to be used for cloning. |
|
AbstractIFunction(java.lang.String[] variableNames,
java.lang.String[] parameterNames)
Creates a new instance of AbstractIFunction with specified variable and parameter names. |
|
AbstractIFunction(java.lang.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(java.lang.String title,
java.lang.String[] variableNames,
java.lang.String[] parameterNames)
|
Method Summary | |
---|---|
void |
addFunctionListener(FunctionListener listener)
|
hep.aida.IAnnotation |
annotation()
|
java.lang.Object |
clone()
|
java.lang.String |
codeletString()
|
int |
dimension()
|
void |
excludeNormalizationAll()
|
double[] |
gradient(double[] values)
|
void |
includeNormalizationAll()
|
int |
indexOfParameter(java.lang.String str)
|
boolean |
isEqual(hep.aida.IFunction iFunction)
|
boolean |
isNormalized()
|
java.lang.String |
normalizationParameter()
|
hep.aida.IRangeSet |
normalizationRange(int iAxis)
|
void |
normalize(boolean param)
|
int |
numberOfParameters()
|
double |
parameter(java.lang.String str)
|
double[] |
parameterGradient(double[] values)
|
java.lang.String[] |
parameterNames()
|
double[] |
parameters()
|
boolean |
providesGradient()
|
boolean |
providesNormalization()
|
boolean |
providesParameterGradient()
|
void |
removeFunctionListener(FunctionListener listener)
|
void |
setCodeletString(java.lang.String str)
|
void |
setParameter(java.lang.String str,
double param)
|
void |
setParameters(double[] pars)
|
void |
setTitle(java.lang.String title)
|
java.lang.String |
title()
|
abstract double |
value(double[] v)
Provide value for your function here. |
java.lang.String |
variableName(int index)
|
java.lang.String[] |
variableNames()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractIFunction()
public AbstractIFunction(java.lang.String title, int dimension, int numberOfParameters)
public AbstractIFunction(java.lang.String[] variableNames, java.lang.String[] parameterNames)
public AbstractIFunction(java.lang.String title, java.lang.String[] variableNames, java.lang.String[] parameterNames)
Method Detail |
---|
public java.lang.Object clone()
clone
in class java.lang.Object
public void setCodeletString(java.lang.String str)
public abstract double value(double[] v)
value
in interface hep.aida.IFunction
public boolean providesGradient()
providesGradient
in interface hep.aida.IFunction
public double[] gradient(double[] values)
gradient
in interface hep.aida.IFunction
public java.lang.String codeletString()
codeletString
in interface hep.aida.IFunction
public hep.aida.IAnnotation annotation()
annotation
in interface hep.aida.IFunction
public int dimension()
dimension
in interface hep.aida.IFunction
public int indexOfParameter(java.lang.String str)
indexOfParameter
in interface hep.aida.IFunction
public int numberOfParameters()
numberOfParameters
in interface hep.aida.IFunction
public double parameter(java.lang.String str)
parameter
in interface hep.aida.IFunction
public java.lang.String[] parameterNames()
parameterNames
in interface hep.aida.IFunction
public double[] parameters()
parameters
in interface hep.aida.IFunction
public void setParameter(java.lang.String str, double param) throws java.lang.IllegalArgumentException
setParameter
in interface hep.aida.IFunction
java.lang.IllegalArgumentException
public void setParameters(double[] pars) throws java.lang.IllegalArgumentException
setParameters
in interface hep.aida.IFunction
java.lang.IllegalArgumentException
public void setTitle(java.lang.String title) throws java.lang.IllegalArgumentException
setTitle
in interface hep.aida.IFunction
java.lang.IllegalArgumentException
public java.lang.String title()
title
in interface hep.aida.IFunction
public java.lang.String variableName(int index)
variableName
in interface hep.aida.IFunction
public java.lang.String[] variableNames()
variableNames
in interface hep.aida.IFunction
public void excludeNormalizationAll()
excludeNormalizationAll
in interface hep.aida.IModelFunction
public void includeNormalizationAll()
includeNormalizationAll
in interface hep.aida.IModelFunction
public boolean isNormalized()
isNormalized
in interface hep.aida.IModelFunction
public hep.aida.IRangeSet normalizationRange(int iAxis)
normalizationRange
in interface hep.aida.IModelFunction
public void normalize(boolean param)
normalize
in interface hep.aida.IModelFunction
public double[] parameterGradient(double[] values)
parameterGradient
in interface hep.aida.IModelFunction
public boolean providesNormalization()
providesNormalization
in interface hep.aida.IModelFunction
public boolean providesParameterGradient()
providesParameterGradient
in interface hep.aida.IModelFunction
public java.lang.String normalizationParameter()
normalizationParameter
in interface hep.aida.IFunction
public boolean isEqual(hep.aida.IFunction iFunction)
isEqual
in interface hep.aida.IFunction
public void addFunctionListener(FunctionListener listener)
addFunctionListener
in interface FunctionDispatcher
public void removeFunctionListener(FunctionListener listener)
removeFunctionListener
in interface FunctionDispatcher
|
|||||||||
PREV CLASS NEXT CLASS | All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |