repicea.math

Class LogFunctionWrapper

java.lang.Object

repicea.math.AbstractMathematicalFunction

repicea.math.AbstractMathematicalFunctionWrapper

repicea.math.LogFunctionWrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

IndividualLogLikelihood

public class LogFunctionWrapper
extends AbstractMathematicalFunctionWrapper

The LogFunctionWrapper class is a specific AbstractMathematicalFunctionWrapper for log functions.

See Also:

Serialized Form

Field Summary

Fields inherited from class repicea.math.AbstractMathematicalFunction

parameterBounds

Constructor Summary

Constructors

Constructor and Description
LogFunctionWrapper(AbstractMathematicalFunction originalFunction) Constructor.

Method Summary

Modifier and Type	Method and Description
Matrix	getGradient() This method returns a vector that contains the first derivatives of the function with respect to its parameters.
Matrix	getHessian() This method returns a matrix that contains the second derivatives of the function with respect to its parameters.
java.lang.Double	getValue() This method provides the result of the function evaluation.

Methods inherited from class repicea.math.AbstractMathematicalFunctionWrapper

getBeta, getNumberOfParameters, getNumberOfVariables, getOriginalFunction, getParameterValue, getVariableValue, setBeta, setBounds, setParameterValue, setVariableValue, setX

Methods inherited from class java.lang.Object

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

Constructor Detail

LogFunctionWrapper

public LogFunctionWrapper(AbstractMathematicalFunction originalFunction)

Constructor.

Parameters:

originalFunction - the nested AbstractMathematicalFunction instance

Method Detail

getValue

public 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 AbstractMathematicalFunctionWrapper

Returns:

a P instance

getGradient

public 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 AbstractMathematicalFunctionWrapper

Returns:

a Matrix instance

getHessian

public 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 AbstractMathematicalFunctionWrapper

Returns:

a Matrix instance