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

Class ContrastRuleSet

java.lang.Object

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

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

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

adaa.analytics.rules.logic.representation.ruleset.ContrastRuleSet

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ContrastRegressionRuleSet, ContrastSurvivalRuleSet

public class ContrastRuleSet
extends ClassificationRuleSet

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	OTHER_CLASSES

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

ATTRIBUTE_VOTING_RESULTS_COUNTS, ATTRIBUTE_VOTING_RESULTS_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
ContrastRuleSet(IExampleSet exampleSet, boolean isVoting, InductionParameters params, Knowledge knowledge)	Invokes base class constructor.

Method Summary

Modifier and Type	Method	Description
void	add(String positiveClass, String negativeClass, ContrastRule rule)
IExampleSet	apply(IExampleSet exampleSet)	Applies the rule model on a given set (makes predictions for all examples).
double[]	calculateAttributeStats()
ContrastIndicators	calculateAvgContrastIndicators()	Calculates contrast sets indicators averaged within contrasts and then between contrasts.
List<ContrastRule>	getAllSets()
int	getTotalDuplicates()
double	predict(Example example)	Predicts class label for a given example.
String	toString()	Generates text representation of the rule set which contains:

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

createPredictionAttributes, setDefaultClass

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

OTHER_CLASSES

public static final String OTHER_CLASSES

See Also:

• Constant Field Values

Constructor Details

ContrastRuleSet

public ContrastRuleSet(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

getAllSets

public List<ContrastRule> getAllSets()

getTotalDuplicates

public int getTotalDuplicates()

calculateAvgContrastIndicators

public ContrastIndicators calculateAvgContrastIndicators()

Calculates contrast sets indicators averaged within contrasts and then between contrasts.

Returns:

Contrast set indicators.

calculateAttributeStats

public double[] calculateAttributeStats()

add

public void add(String positiveClass,
 String negativeClass,
 ContrastRule rule)

predict

public double predict(Example example)
               throws OperatorException

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

Overrides:

predict in class ClassificationRuleSet

Parameters:

example - Example to be examined.

Returns:

Predicted class label.

Throws:

OperatorException

apply

public IExampleSet apply(IExampleSet exampleSet)
                  throws OperatorException

Description copied from class: ClassificationRuleSet

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

Overrides:

apply in class ClassificationRuleSet

Parameters:

exampleSet - Example set to be examined.

Returns:

Example set with filled predictions and voting attributes.

Throws:

OperatorException

toString

public String toString()

Generates text representation of the rule set which contains:

• induction parameters,
• user's knowledge (if defined),
• list of rules,
• information about coverage of the training set examples.

Overrides:

toString in class RuleSetBase

Returns:

Rule set in the text form.