repicea.stats.model.glm.copula

Class CopulaExpression

java.lang.Object

repicea.math.AbstractMathematicalFunction

repicea.math.AbstractMathematicalFunctionWrapper

repicea.stats.model.glm.copula.CopulaExpression

All Implemented Interfaces:

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

Direct Known Subclasses:

CopulaLibrary.DistanceLinkFunctionCopulaExpression, CopulaLibrary.SimpleCopulaExpression, CopulaLibrary.SimpleLogisticCopulaExpression

public abstract class CopulaExpression
extends AbstractMathematicalFunctionWrapper

This class is a basic class for all the copula expressions contained in the CopulaLibrary class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	levels

Fields inherited from class repicea.math.AbstractMathematicalFunction

parameterBounds

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CopulaExpression(java.lang.String hierarchicalLevels)

Method Summary

Modifier and Type	Method and Description
Matrix	getBeta() This method returns the vector of parameters.
protected java.util.List<java.lang.String>	getHierarchicalLevelSpecifications()
LinearStatisticalExpression	getOriginalFunction() This method returns the original function.
protected void	initialize(StatisticalModel<?> model, HierarchicalStatisticalDataStructure data)
void	setBeta(Matrix beta) This method sets the vector of parameters.
protected abstract void	setX(int indexFirstObservation, int indexSecondObservation)
void	setX(Matrix x) This method sets the vector of explanatory variables.

Methods inherited from class repicea.math.AbstractMathematicalFunctionWrapper

getGradient, getHessian, getNumberOfParameters, getNumberOfVariables, getParameterValue, getValue, getVariableValue, setBounds, setParameterValue, setVariableValue

Methods inherited from class java.lang.Object

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

Field Detail

levels

protected java.util.List<java.lang.String> levels

Constructor Detail

CopulaExpression

protected CopulaExpression(java.lang.String hierarchicalLevels)

Method Detail

getOriginalFunction

public LinearStatisticalExpression getOriginalFunction()

Description copied from class: AbstractMathematicalFunctionWrapper

This method returns the original function.

Overrides:

getOriginalFunction in class AbstractMathematicalFunctionWrapper

Returns:

an AbstractMathematicalFunction instance

getHierarchicalLevelSpecifications

protected java.util.List<java.lang.String> getHierarchicalLevelSpecifications()

setX

protected abstract void setX(int indexFirstObservation,
                             int indexSecondObservation)

initialize

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

Throws:

StatisticalDataException

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 AbstractMathematicalFunctionWrapper

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 AbstractMathematicalFunctionWrapper

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 AbstractMathematicalFunctionWrapper

Returns:

a Matrix instance