repicea.stats.data

Class GenericStatisticalDataStructure

java.lang.Object

repicea.stats.data.GenericStatisticalDataStructure

All Implemented Interfaces:

StatisticalDataStructure

Direct Known Subclasses:

GenericHierarchicalStatisticalDataStructure

public class GenericStatisticalDataStructure
extends java.lang.Object
implements StatisticalDataStructure

The StatisticalDataStructure class is an abstract class that implements all the features to be able to fit a statistical model. The structure includes a vector of dependent variables (vectorY), a matrix of covariates (matrixX) and a possible hierarchical data structure (hierarchicalStructure).

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSet	dataSet
protected boolean	isInterceptModel
protected Matrix	matrixX
protected Matrix	vectorY

Constructor Summary

Constructors

Constructor and Description
GenericStatisticalDataStructure(DataSet dataSet) General constructor.

Method Summary

Modifier and Type	Method and Description
protected Matrix	computeDummyVariables(int fieldIndex, java.lang.String refClass)
void	constructMatrices(java.lang.String modelDefinition) This method builds the matrices that are required to fit the model.
DataSet	getDataSet() This method returns the DataSet instance behind the StatisticalDataStructure.
Matrix	getMatrixX() Return the design matrix of the fixed effects.
int	getNumberOfObservations() Returns the number of observations in the data structure.
Matrix	getVectorY() Return the vector of response variables.
boolean	isInterceptModel() This method returns true if the model has an intercept or false otherwise.
void	setInterceptModel(boolean isInterceptModel) This method determines whether the model has an intercept

Methods inherited from class java.lang.Object

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

Field Detail

dataSet

protected DataSet dataSet

isInterceptModel

protected boolean isInterceptModel

vectorY

protected Matrix vectorY

matrixX

protected Matrix matrixX

Constructor Detail

GenericStatisticalDataStructure

public GenericStatisticalDataStructure(DataSet dataSet)

General constructor.

Parameters:

dataSet - the DataSet instance from which the structure is going to be extracted

Method Detail

computeDummyVariables

protected Matrix computeDummyVariables(int fieldIndex,
                                       java.lang.String refClass)
                                throws StatisticalDataException

Throws:

StatisticalDataException

isInterceptModel

public boolean isInterceptModel()

Description copied from interface: StatisticalDataStructure

This method returns true if the model has an intercept or false otherwise.

Specified by:

isInterceptModel in interface StatisticalDataStructure

Returns:

a boolean instance

setInterceptModel

public void setInterceptModel(boolean isInterceptModel)

Description copied from interface: StatisticalDataStructure

This method determines whether the model has an intercept

Specified by:

setInterceptModel in interface StatisticalDataStructure

Parameters:

isInterceptModel - true if the model has an intercept or false otherwise

getMatrixX

public Matrix getMatrixX()

Description copied from interface: StatisticalDataStructure

Return the design matrix of the fixed effects.

Specified by:

getMatrixX in interface StatisticalDataStructure

Returns:

a Matrix instance

getVectorY

public Matrix getVectorY()

Description copied from interface: StatisticalDataStructure

Return the vector of response variables.

Specified by:

getVectorY in interface StatisticalDataStructure

Returns:

a Matrix instance

constructMatrices

public void constructMatrices(java.lang.String modelDefinition)
                       throws StatisticalDataException

Description copied from interface: StatisticalDataStructure

This method builds the matrices that are required to fit the model.

Specified by:

constructMatrices in interface StatisticalDataStructure

Parameters:

modelDefinition - the definition of the model that serves to design the matrices

Throws:

StatisticalDataException

getNumberOfObservations

public int getNumberOfObservations()

Description copied from interface: StatisticalDataStructure

Returns the number of observations in the data structure.

Specified by:

getNumberOfObservations in interface StatisticalDataStructure

Returns:

an integer

getDataSet

public DataSet getDataSet()

Description copied from interface: StatisticalDataStructure

This method returns the DataSet instance behind the StatisticalDataStructure.

Specified by:

getDataSet in interface StatisticalDataStructure

Returns:

a DataSet instance