repicea.math

Class AbstractMathematicalFunction

java.lang.Object

repicea.math.AbstractMathematicalFunction

All Implemented Interfaces:

java.io.Serializable, DerivableMathematicalFunction, EvaluableFunction<java.lang.Double>

Direct Known Subclasses:

AbstractMathematicalFunctionWrapper, CATDecayFunction, LinearStatisticalExpression, MathildeMortalityPredictor.InternalMathematicalFunction

public abstract class AbstractMathematicalFunction
extends java.lang.Object
implements EvaluableFunction<java.lang.Double>, DerivableMathematicalFunction, java.io.Serializable

The AbstractMathematicalFunction class suits mathematical function that can be derived. The return value can be an complex object to enable the nesting of different mathematical functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,ParameterBound>	parameterBounds

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMathematicalFunction()

Method Summary

Modifier and Type	Method and Description
Matrix	getBeta() This method returns the vector of parameters.
abstract Matrix	getGradient() This method returns a vector that contains the first derivatives of the function with respect to its parameters.
abstract Matrix	getHessian() This method returns a matrix that contains the second derivatives of the function with respect to its parameters.
int	getNumberOfParameters() This method returns the number of parameters involved in the function.
int	getNumberOfVariables() This method returns the number of variables in the function.
double	getParameterValue(int parameterIndex) This method retrieve the parameter defined by the parameterName parameter.
abstract java.lang.Double	getValue() This method provides the result of the function evaluation.
double	getVariableValue(int variableIndex) This method returns the value of the variable at index variableIndex
void	setBeta(Matrix beta) This method sets the vector of parameters.
void	setBounds(int parameterIndex, ParameterBound bound) This method sets a bound for a particular parameter
void	setParameterValue(int parameterIndex, double parameterValue) This method sets the parameter value.
void	setVariableValue(int variableIndex, double variableValue) This method sets the variable value associated with this variable name.
void	setX(Matrix x) This method sets the vector of explanatory variables.

Methods inherited from class java.lang.Object

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

Field Detail

parameterBounds

protected java.util.Map<java.lang.Integer,ParameterBound> parameterBounds

Constructor Detail

AbstractMathematicalFunction

protected AbstractMathematicalFunction()

Method Detail

setParameterValue

public void setParameterValue(int parameterIndex,
                              double parameterValue)

This method sets the parameter value.

Parameters:

parameterIndex - the parameter index

parameterValue - the parameter value

getParameterValue

public double getParameterValue(int parameterIndex)

This method retrieve the parameter defined by the parameterName parameter.

Parameters:

parameterIndex - the index of the parameter to be retrieved

Returns:

a double

setVariableValue

public void setVariableValue(int variableIndex,
                             double variableValue)

This method sets the variable value associated with this variable name.

Parameters:

variableIndex - the index of the variable

variableValue - its value (a double)

getVariableValue

public double getVariableValue(int variableIndex)

This method returns the value of the variable at index variableIndex

Parameters:

variableIndex - an integer

Returns:

a double

getNumberOfParameters

public int getNumberOfParameters()

This method returns the number of parameters involved in the function.

Returns:

a integer

getNumberOfVariables

public int getNumberOfVariables()

This method returns the number of variables in the function.

Returns:

an integer

getValue

public abstract java.lang.Double getValue()

Description copied from interface: EvaluableFunction

This method provides the result of the function evaluation.

Specified by:

getValue in interface EvaluableFunction<java.lang.Double>

Returns:

a P instance

getGradient

public abstract Matrix getGradient()

Description copied from interface: DerivableMathematicalFunction

This method returns a vector that contains the first derivatives of the function with respect to its parameters.

Specified by:

getGradient in interface DerivableMathematicalFunction

Returns:

a Matrix instance

getHessian

public abstract Matrix getHessian()

Description copied from interface: DerivableMathematicalFunction

This method returns a matrix that contains the second derivatives of the function with respect to its parameters.

Specified by:

getHessian in interface DerivableMathematicalFunction

Returns:

a Matrix instance

setBounds

public void setBounds(int parameterIndex,
                      ParameterBound bound)

This method sets a bound for a particular parameter

Parameters:

parameterIndex - an Integer instance that defines the parameter

bound - a ParameterBound object

setX

public void setX(Matrix x)

This method sets the vector of explanatory variables. The method essentially relies on the setVariableValue() of the AbstractMathematicalFunction class.

Parameters:

x - a Matrix instance

Throws:

java.lang.IllegalArgumentException - if the parameter x is not a row vector

setBeta

public void setBeta(Matrix beta)

This method sets the vector of parameters. The method essentially relies on the setParameterValue() of the AbstractMathematicalFunction class.

Parameters:

beta - a Matrix instance

Throws:

java.lang.IllegalArgumentException - if beta is not a column vector

getBeta

public Matrix getBeta()

This method returns the vector of parameters.

Returns:

a Matrix instance