Package adaa.analytics.rules.logic.representation.ruleset

Class ClassificationRuleSet

java.lang.Object

adaa.analytics.rules.logic.representation.ruleset.PredictionModel

adaa.analytics.rules.logic.representation.ruleset.RuleSetBase

adaa.analytics.rules.logic.representation.ruleset.ClassificationRuleSet

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ContrastRuleSet

public class ClassificationRuleSet
extends RuleSetBase

Class representing a set of classification rules.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adaa.analytics.rules.logic.representation.ruleset.RuleSetBase

RuleSetBase.Significance

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_VOTING_RESULTS_COUNTS	Name of the prediction attribute representing results of voting (counts).
static final String	ATTRIBUTE_VOTING_RESULTS_WEIGHTS	Name of the prediction attribute representing results of voting (weights).

Fields inherited from class adaa.analytics.rules.logic.representation.ruleset.RuleSetBase

ANNOTATION_TEST_REPORT, attributes, growingTime, isVoting, knowledge, params, pruningTime, rules, totalTime

Constructor Summary

Constructors

Constructor	Description
ClassificationRuleSet(IExampleSet exampleSet, boolean isVoting, InductionParameters params, Knowledge knowledge)	Invokes base class constructor.

Method Summary

Modifier and Type	Method	Description
IExampleSet	apply(IExampleSet exampleSet)	Applies the rule model on a given set (makes predictions for all examples).
protected IAttribute	createPredictionAttributes(IExampleSet exampleSet, IAttribute label)	Computes prediction attributes (voting results) for a given set.
double	predict(Example example)	Predicts class label for a given example.
void	setDefaultClass(String defaultClass)	Sets defaultClass

Methods inherited from class adaa.analytics.rules.logic.representation.ruleset.RuleSetBase

addRule, calculateAvgRuleCoverage, calculateAvgRulePrecision, calculateAvgRuleQuality, calculateConditionsCount, calculateInducedCondtionsCount, calculateSignificance, calculateSignificanceFDR, calculateSignificanceFWER, getGrowingTime, getIsVoting, getParams, getPruningTime, getRules, getTotalTime, performPrediction, setGrowingTime, setIsVoting, setPruningTime, setTotalTime, toString, toTable

Methods inherited from class adaa.analytics.rules.logic.representation.ruleset.PredictionModel

checkCompatibility, getLabel, getTrainingHeader, supportsConfidences

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_VOTING_RESULTS_WEIGHTS

public static final String ATTRIBUTE_VOTING_RESULTS_WEIGHTS

Name of the prediction attribute representing results of voting (weights).

See Also:

• Constant Field Values

ATTRIBUTE_VOTING_RESULTS_COUNTS

public static final String ATTRIBUTE_VOTING_RESULTS_COUNTS

Name of the prediction attribute representing results of voting (counts).

See Also:

• Constant Field Values

Constructor Details

ClassificationRuleSet

public ClassificationRuleSet(IExampleSet exampleSet,
 boolean isVoting,
 InductionParameters params,
 Knowledge knowledge)

Invokes base class constructor.

Parameters:

exampleSet - Training set.

isVoting - Voting flag.

params - Induction parameters.

knowledge - User's knowledge.

Method Details

setDefaultClass

public void setDefaultClass(String defaultClass)

Sets defaultClass

predict

public double predict(Example example)
               throws OperatorException

Predicts class label for a given example. Sets output attributes describing voting results.

Specified by:

predict in class RuleSetBase

Parameters:

example - Example to be examined.

Returns:

Predicted class label.

Throws:

OperatorException

apply

public IExampleSet apply(IExampleSet exampleSet)
                  throws OperatorException

Applies the rule model on a given set (makes predictions for all examples).

Overrides:

apply in class PredictionModel

Parameters:

exampleSet - Example set to be examined.

Returns:

Example set with filled predictions and voting attributes.

Throws:

OperatorException

createPredictionAttributes

protected IAttribute createPredictionAttributes(IExampleSet exampleSet,
 IAttribute label)

Computes prediction attributes (voting results) for a given set.

Overrides:

createPredictionAttributes in class PredictionModel

Parameters:

exampleSet - Example set to be examined.

label - Input label attribute.

Returns:

Output label attribute.