lerfob.carbonbalancetool

Class CATExponentialFunction

java.lang.Object

repicea.math.AbstractMathematicalFunction

lerfob.carbonbalancetool.CATDecayFunction

lerfob.carbonbalancetool.CATExponentialFunction

All Implemented Interfaces:

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

public class CATExponentialFunction
extends CATDecayFunction

This class provides an exponential function to act as decay function in the calculation of end product lifetime.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class lerfob.carbonbalancetool.CATDecayFunction

CATDecayFunction.ParameterID, CATDecayFunction.VariableID

Field Summary

Fields inherited from class repicea.math.AbstractMathematicalFunction

parameterBounds

Constructor Summary

Constructors

Constructor and Description
CATExponentialFunction()

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.
double	getInfiniteIntegral() This method returns the value of the infinite integral of the decay function.
java.lang.Double	getValue() This method provides the result of the function evaluation.

Methods inherited from class repicea.math.AbstractMathematicalFunction

getBeta, getNumberOfParameters, getNumberOfVariables, 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

CATExponentialFunction

public CATExponentialFunction()

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 AbstractMathematicalFunction

Returns:

a P instance

getInfiniteIntegral

public double getInfiniteIntegral()

Description copied from class: CATDecayFunction

This method returns the value of the infinite integral of the decay function.

Specified by:

getInfiniteIntegral in class CATDecayFunction

Returns:

the value of the infinite integral (double)

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 AbstractMathematicalFunction

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 AbstractMathematicalFunction

Returns:

a Matrix instance