com.rapidminer.operator.learner.subgroups
Class RuleSet

java.lang.Object
  com.rapidminer.operator.AbstractIOObject
      com.rapidminer.operator.ResultObjectAdapter
          com.rapidminer.operator.AbstractModel
              com.rapidminer.operator.learner.PredictionModel
                  com.rapidminer.operator.learner.SimplePredictionModel
                      com.rapidminer.operator.learner.subgroups.RuleSet

All Implemented Interfaces:

IOObject, Model, ResultObject, Readable, Reportable, LoggingHandler, java.io.Serializable, java.lang.Iterable<Rule>

public class RuleSet
extends SimplePredictionModel
implements java.lang.Iterable<Rule>

A model consisting of rules which are scored by utility values. Only the best rule (according to its utility) is used for prediction at the moment.

Author:

Tobias Malbrecht

See Also:

Serialized Form

Nested Class Summary

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

AbstractIOObject.InputStreamProvider

Constructor Summary

RuleSet(ExampleSet exampleSet)

Method Summary

void	addRule(Rule rule)
java.util.LinkedList<Rule>	getNegativeRules()
int	getNumberOfRules()
java.util.LinkedList<Rule>	getPositiveRules()
Rule	getRule(int index)
UtilityFunction[]	getUtilityFunctions()
java.util.Iterator<Rule>	iterator()
double	predict(Example example) Applies the model to a single example and returns the predicted class value.
int	size()
java.lang.String	toString()

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

performPrediction

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

apply, 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

RuleSet

public RuleSet(ExampleSet exampleSet)

Method Detail

addRule

public void addRule(Rule rule)

getRule

public Rule getRule(int index)

getNumberOfRules

public int getNumberOfRules()

iterator

public java.util.Iterator<Rule> iterator()

Specified by:

iterator in interface java.lang.Iterable<Rule>

getPositiveRules

public java.util.LinkedList<Rule> getPositiveRules()

getNegativeRules

public java.util.LinkedList<Rule> getNegativeRules()

size

public int size()

predict

public double predict(Example example)
               throws OperatorException

Description copied from class: SimplePredictionModel

Applies the model to a single example and returns the predicted class value.

Specified by:

predict in class SimplePredictionModel

Throws:

OperatorException

getUtilityFunctions

public UtilityFunction[] getUtilityFunctions()

toString

public java.lang.String toString()

Specified by:

toString in interface Readable

Overrides:

toString in class PredictionModel