repicea.stats

Class LinearStatisticalExpression

java.lang.Object

repicea.math.AbstractMathematicalFunction

repicea.stats.LinearStatisticalExpression

All Implemented Interfaces:

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

public final class LinearStatisticalExpression
extends AbstractMathematicalFunction
implements java.io.Serializable

This class specifies a linear term in the form x * beta.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Matrix	gradient
protected Matrix	hessian

Fields inherited from class repicea.math.AbstractMathematicalFunction

parameterBounds

Constructor Summary

Constructors

Constructor and Description
LinearStatisticalExpression()

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.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

Field Detail

gradient

protected Matrix gradient

hessian

protected Matrix hessian

Constructor Detail

LinearStatisticalExpression

public LinearStatisticalExpression()

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

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