com.rapidminer.operator.learner.functions
Class SeeminglyUnrelatedRegressionModel

java.lang.Object
  com.rapidminer.operator.AbstractIOObject
      com.rapidminer.operator.ResultObjectAdapter
          com.rapidminer.operator.AbstractModel
              com.rapidminer.operator.learner.PredictionModel
                  com.rapidminer.operator.learner.functions.SeeminglyUnrelatedRegressionModel

All Implemented Interfaces:

IOObject, Model, ResultObject, Readable, Reportable, LoggingHandler, java.io.Serializable

public class SeeminglyUnrelatedRegressionModel
extends PredictionModel

This is the model of a SUR regression. It contains the used attributes, the names of the target labels and the coefficients.

Author:

Sebastian Land

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.rapidminer.operator.AbstractIOObject

AbstractIOObject.InputStreamProvider

Constructor Summary

protected

SeeminglyUnrelatedRegressionModel(ExampleSet trainingExampleSet, java.util.ArrayList<java.lang.String[]> usedAttributeNames, java.util.ArrayList<java.lang.String> labelNames, double[] coefficients)

Method Summary

ExampleSet	apply(ExampleSet exampleSet) Applies the model by creating a predicted label attribute and setting the predicted label values.
double[]	getCoefficients(java.lang.String labelName)
java.util.List<java.lang.String>	getLabelNames()
java.lang.String[]	getSelectedAttributeNames(java.lang.String labelName)
ExampleSet	performPrediction(ExampleSet exampleSet, Attribute predictedLabel) Subclasses should iterate through the given example set and set the prediction for each example.
java.lang.String	toString()

Methods inherited from class com.rapidminer.operator.learner.PredictionModel

checkCompatibility, copyPredictedLabel, createPredictedLabel, createPredictionAttributes, getLabel, removePredictedLabel, removePredictedLabel, supportsConfidences

Methods inherited from class com.rapidminer.operator.AbstractModel

getExtension, getFileDescription, getName, getTrainingHeader, isInTargetEncoding, isUpdatable, setParameter, updateModel

Methods inherited from class com.rapidminer.operator.ResultObjectAdapter

addAction, getActions, getAnnotations, getResultIcon, log, log, logError, logNote, logWarning, toHTML, toResultString

Methods inherited from class com.rapidminer.operator.AbstractIOObject

appendOperatorToHistory, copy, getLog, getProcessingHistory, getSource, initWriting, read, read, read, read, setLoggingHandler, setSource, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rapidminer.operator.ResultObject

getActions, getResultIcon, toResultString

Methods inherited from interface com.rapidminer.operator.IOObject

appendOperatorToHistory, copy, getAnnotations, getLog, getProcessingHistory, getSource, setLoggingHandler, setSource, write

Constructor Detail

SeeminglyUnrelatedRegressionModel

protected SeeminglyUnrelatedRegressionModel(ExampleSet trainingExampleSet,
                                            java.util.ArrayList<java.lang.String[]> usedAttributeNames,
                                            java.util.ArrayList<java.lang.String> labelNames,
                                            double[] coefficients)

Method Detail

apply

public ExampleSet apply(ExampleSet exampleSet)

Description copied from class: PredictionModel

Applies the model by creating a predicted label attribute and setting the predicted label values.

Specified by:

apply in interface Model

Overrides:

apply in class PredictionModel

performPrediction

public ExampleSet performPrediction(ExampleSet exampleSet,
                                    Attribute predictedLabel)
                             throws OperatorException

Description copied from class: PredictionModel

Subclasses should iterate through the given example set and set the prediction for each example. The given predicted label attribute was already be added to the example set and should be used to set the predicted values.

Specified by:

performPrediction in class PredictionModel

Throws:

OperatorException

getCoefficients

public double[] getCoefficients(java.lang.String labelName)

getSelectedAttributeNames

public java.lang.String[] getSelectedAttributeNames(java.lang.String labelName)

getLabelNames

public java.util.List<java.lang.String> getLabelNames()

toString

public java.lang.String toString()

Specified by:

toString in interface Readable

Overrides:

toString in class PredictionModel