hep.aida.ref.function
Class FunctionCore

java.lang.Object
  hep.aida.ref.function.FunctionCore

Direct Known Subclasses:

ExponentialCoreNorm, ExponentialCoreNotNorm, GaussianCore2DNorm, GaussianCore2DNotNorm, GaussianCoreNorm, GaussianCoreNotNorm, IFunctionCoreNotNorm, JELFunctionCore, PolynomialCoreNotNorm

public abstract class FunctionCore

extends Object

Author:

serbo

Source Code:

FunctionCore.java

Field Summary

protected int	dimension
protected int	numberOfParameters
protected double[]	p
protected String[]	parNames
protected String	title

Constructor Summary

FunctionCore(int dim, int nPar)

FunctionCore(int dim, int nPar, double[] parVal)

Method Summary

void	addCoreListener(FunctionCoreListener listener)
int	dimension()
abstract double	functionValue(double[] var)
jas.hist.Handle[]	getHandles(double xLow, double xHigh, double yLow, double yHigh)
abstract double[]	gradient(double[] x)
int	indexOfParameter(String name)
protected void	init(int dim, int nPar)
abstract double	normalizationAmplitude(double[] xMin, double[] xMax)
int	numberOfParameters()
double	parameter(String name)
abstract double[]	parameterGradient(double[] x)
String[]	parameterNames()
double[]	parameters()
abstract boolean	providesGradient()
abstract boolean	providesNormalization()
abstract boolean	providesParameterGradient()
void	setParameter(String name, double x)
boolean	setParameterNames(String[] params)
void	setParameters(double[] params)
void	setTitle(String t)
String	title()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

title

protected String title

dimension

protected int dimension

numberOfParameters

protected int numberOfParameters

p

protected double[] p

parNames

protected String[] parNames

Constructor Detail

FunctionCore

public FunctionCore(int dim,
                    int nPar)

FunctionCore

public FunctionCore(int dim,
                    int nPar,
                    double[] parVal)

Method Detail

init

protected void init(int dim,
                    int nPar)

dimension

public int dimension()

title

public String title()

setTitle

public void setTitle(String t)

functionValue

public abstract double functionValue(double[] var)

providesGradient

public abstract boolean providesGradient()

gradient

public abstract double[] gradient(double[] x)

providesParameterGradient

public abstract boolean providesParameterGradient()

parameterGradient

public abstract double[] parameterGradient(double[] x)

providesNormalization

public abstract boolean providesNormalization()

normalizationAmplitude

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

numberOfParameters

public int numberOfParameters()

parameterNames

public String[] parameterNames()

parameters

public double[] parameters()

parameter

public double parameter(String name)

setParameterNames

public boolean setParameterNames(String[] params)

indexOfParameter

public int indexOfParameter(String name)

setParameters

public void setParameters(double[] params)

setParameter

public void setParameter(String name,
                         double x)
                  throws IllegalArgumentException

Throws:

IllegalArgumentException

getHandles

public jas.hist.Handle[] getHandles(double xLow,
                                    double xHigh,
                                    double yLow,
                                    double yHigh)

addCoreListener

public void addCoreListener(FunctionCoreListener listener)