repicea.stats.model.glm.copula

Class CopulaLibrary.DistanceLinkFunctionCopulaExpression

java.lang.Object

repicea.math.AbstractMathematicalFunction

repicea.math.AbstractMathematicalFunctionWrapper

repicea.stats.model.glm.copula.CopulaExpression

repicea.stats.model.glm.copula.CopulaLibrary.DistanceLinkFunctionCopulaExpression

All Implemented Interfaces:

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

Enclosing class:

CopulaLibrary

public static class CopulaLibrary.DistanceLinkFunctionCopulaExpression
extends CopulaExpression

A copula based on a link function and the euclidian distance between the two observations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HierarchicalSpatialDataStructure	data
protected java.lang.String	distanceFieldsEnumeration
protected LinkFunction	linkFunction
protected Matrix	matrixX

Fields inherited from class repicea.stats.model.glm.copula.CopulaExpression

levels

Fields inherited from class repicea.math.AbstractMathematicalFunction

parameterBounds

Constructor Summary

Constructors

Constructor and Description
DistanceLinkFunctionCopulaExpression(LinkFunction.Type linkFunctionType, java.lang.String hierarchicalLevelSpecifications, java.lang.String distanceFieldsEnumeration, double parameter)

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.
int	getNumberOfVariables() This method returns the number of variables in the function.
java.lang.Double	getValue() This method provides the result of the function evaluation.
protected void	initialize(StatisticalModel<?> model, HierarchicalStatisticalDataStructure data)
void	setBounds(java.lang.Integer parameterName, ParameterBound bound)
protected void	setX(int indexFirstObservation, int indexSecondObservation)
void	setX(Matrix x) Deprecated.

Methods inherited from class repicea.stats.model.glm.copula.CopulaExpression

getBeta, getHierarchicalLevelSpecifications, getOriginalFunction, setBeta

Methods inherited from class repicea.math.AbstractMathematicalFunctionWrapper

getNumberOfParameters, getParameterValue, getVariableValue, setBounds, setParameterValue, setVariableValue

Methods inherited from class java.lang.Object

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

Field Detail

linkFunction

protected LinkFunction linkFunction

matrixX

protected Matrix matrixX

distanceFieldsEnumeration

protected java.lang.String distanceFieldsEnumeration

data

protected HierarchicalSpatialDataStructure data

Constructor Detail

DistanceLinkFunctionCopulaExpression

public DistanceLinkFunctionCopulaExpression(LinkFunction.Type linkFunctionType,
                                            java.lang.String hierarchicalLevelSpecifications,
                                            java.lang.String distanceFieldsEnumeration,
                                            double parameter)
                                     throws StatisticalDataException

Throws:

StatisticalDataException

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

setX

@Deprecated
public void setX(Matrix x)

Deprecated.

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 CopulaExpression

Parameters:

x - a Matrix instance

setX

protected void setX(int indexFirstObservation,
                    int indexSecondObservation)

Specified by:

setX in class CopulaExpression

getNumberOfVariables

public int getNumberOfVariables()

Description copied from class: AbstractMathematicalFunction

This method returns the number of variables in the function.

Overrides:

getNumberOfVariables in class AbstractMathematicalFunctionWrapper

Returns:

an integer

setBounds

public void setBounds(java.lang.Integer parameterName,
                      ParameterBound bound)

initialize

protected void initialize(StatisticalModel<?> model,
                          HierarchicalStatisticalDataStructure data)
                   throws StatisticalDataException

Overrides:

initialize in class CopulaExpression

Throws:

StatisticalDataException