repicea.math

Class AbstractMathematicalFunctionWrapper

java.lang.Object

repicea.math.AbstractMathematicalFunction

repicea.math.AbstractMathematicalFunctionWrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

CompositeLogLikelihood, CopulaExpression, ExponentialFunctionWrapper, IndividualLikelihood, LinkFunction, LogFunctionWrapper

public abstract class AbstractMathematicalFunctionWrapper
extends AbstractMathematicalFunction

The AbstractMathematicalFunctionWrapper class makes it possible to create a function that is based on a nested AbstractMathematicalFunction instance.

See Also:

Serialized Form

Field Summary

Fields inherited from class repicea.math.AbstractMathematicalFunction

parameterBounds

Constructor Summary

Constructors

Constructor and Description
AbstractMathematicalFunctionWrapper(AbstractMathematicalFunction originalFunction) Constructor.

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.
AbstractMathematicalFunction	getOriginalFunction() This method returns the original 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

Constructor Detail

AbstractMathematicalFunctionWrapper

public AbstractMathematicalFunctionWrapper(AbstractMathematicalFunction originalFunction)

Constructor.

Parameters:

originalFunction - the nested AbstractMathematicalFunction instance

Method Detail

getOriginalFunction

public AbstractMathematicalFunction getOriginalFunction()

This method returns the original function.

Returns:

an AbstractMathematicalFunction instance

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>

Specified by:

getValue in class AbstractMathematicalFunction

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

Specified by:

getGradient in class AbstractMathematicalFunction

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

Specified by:

getHessian in class AbstractMathematicalFunction

Returns:

a Matrix instance

setParameterValue

public void setParameterValue(int parameterIndex,
                              double parameterValue)

Description copied from class: AbstractMathematicalFunction

This method sets the parameter value.

Overrides:

setParameterValue in class AbstractMathematicalFunction

Parameters:

parameterIndex - the parameter index

parameterValue - the parameter value

getParameterValue

public double getParameterValue(int parameterIndex)

Description copied from class: AbstractMathematicalFunction

This method retrieve the parameter defined by the parameterName parameter.

Overrides:

getParameterValue in class AbstractMathematicalFunction

Parameters:

parameterIndex - the index of the parameter to be retrieved

Returns:

a double

setVariableValue

public void setVariableValue(int variableIndex,
                             double variableValue)

Description copied from class: AbstractMathematicalFunction

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

Overrides:

setVariableValue in class AbstractMathematicalFunction

Parameters:

variableIndex - the index of the variable

variableValue - its value (a double)

getVariableValue

public double getVariableValue(int variableIndex)

Description copied from class: AbstractMathematicalFunction

This method returns the value of the variable at index variableIndex

Overrides:

getVariableValue in class AbstractMathematicalFunction

Parameters:

variableIndex - an integer

Returns:

a double

getNumberOfParameters

public int getNumberOfParameters()

Description copied from class: AbstractMathematicalFunction

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

Overrides:

getNumberOfParameters in class AbstractMathematicalFunction

Returns:

a integer

getNumberOfVariables

public int getNumberOfVariables()

Description copied from class: AbstractMathematicalFunction

This method returns the number of variables in the function.

Overrides:

getNumberOfVariables in class AbstractMathematicalFunction

Returns:

an integer

setX

public void setX(Matrix x)

Description copied from class: AbstractMathematicalFunction

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

Overrides:

setX in class AbstractMathematicalFunction

Parameters:

x - a Matrix instance

setBeta

public void setBeta(Matrix beta)

Description copied from class: AbstractMathematicalFunction

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

Overrides:

setBeta in class AbstractMathematicalFunction

Parameters:

beta - a Matrix instance

getBeta

public Matrix getBeta()

Description copied from class: AbstractMathematicalFunction

This method returns the vector of parameters.

Overrides:

getBeta in class AbstractMathematicalFunction

Returns:

a Matrix instance

setBounds

public void setBounds(int parameterIndex,
                      ParameterBound bound)

Description copied from class: AbstractMathematicalFunction

This method sets a bound for a particular parameter

Overrides:

setBounds in class AbstractMathematicalFunction

Parameters:

parameterIndex - an Integer instance that defines the parameter

bound - a ParameterBound object