repicea.stats.data

Interface StatisticalDataStructure

All Known Subinterfaces:

HierarchicalSpatialDataStructure, HierarchicalStatisticalDataStructure

All Known Implementing Classes:

GenericHierarchicalSpatialDataStructure, GenericHierarchicalStatisticalDataStructure, GenericStatisticalDataStructure

public interface StatisticalDataStructure

This interface is the basic interface for any data structure.

Method Summary

Modifier and Type	Method and Description
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

Method Detail

getNumberOfObservations

int getNumberOfObservations()

Returns the number of observations in the data structure.

Returns:

an integer

constructMatrices

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

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

Parameters:

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

Throws:

StatisticalDataException

getMatrixX

Matrix getMatrixX()

Return the design matrix of the fixed effects.

Returns:

a Matrix instance

getVectorY

Matrix getVectorY()

Return the vector of response variables.

Returns:

a Matrix instance

isInterceptModel

boolean isInterceptModel()

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

Returns:

a boolean instance

setInterceptModel

void setInterceptModel(boolean isInterceptModel)

This method determines whether the model has an intercept

Parameters:

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

getDataSet

DataSet getDataSet()

This method returns the DataSet instance behind the StatisticalDataStructure.

Returns:

a DataSet instance