magpie.models.interfaces

Interface MultiModel

All Known Implementing Classes:

CompositeRegression, SplitClassifier, SplitModel, SplitRegression, StagedRegression

public interface MultiModel

Interface for models that contain submodels.

Implementations should be sure to add a call to operations from MultiModelUtility, where necessary

Method Summary

Modifier and Type	Method and Description
BaseModel	getGenericModel() Get the model template
BaseModel	getModel(int index) Get a specific submodel.
int	NModels()
void	setGenericModel(BaseModel x) Set the model template
void	setModel(int index, BaseModel x) Set a specific submodel.
void	setNumberOfModels(int n) Defines the number of models to be trained.

Method Detail

NModels

int NModels()

Returns:

number of model slots currently available

setGenericModel

void setGenericModel(BaseModel x)

Set the model template

Parameters:

x - Template model (will be cloned)

getGenericModel

BaseModel getGenericModel()

Get the model template

Returns:

Pointer to the generic model

setModel

void setModel(int index,
              BaseModel x)

Set a specific submodel. Will increase number of models if necessary.

Any implementation should not clone the model. This will allow people to construct a model used already-trained models.

Parameters:

index - Index of submodel to be set

x - Model to be used (creates a clone)

getModel

BaseModel getModel(int index)

Get a specific submodel.

Parameters:

index - Model to retrieve

Returns:

Requested model or null if index >= NModels

setNumberOfModels

void setNumberOfModels(int n)

Defines the number of models to be trained. If a generic model is set, it will automatically use it to defined any new models

Parameters:

n - Number of models to use