Package adaa.analytics.rules.logic.representation.rule

Class ClassificationRule

java.lang.Object

adaa.analytics.rules.logic.representation.rule.Rule

adaa.analytics.rules.logic.representation.rule.ClassificationRule

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ContrastRule

public class ClassificationRule
extends Rule

Class representing a classification rule.

See Also:

• Serialized Form

Field Summary

Fields inherited from class adaa.analytics.rules.logic.representation.rule.Rule

consequence, coveredNegatives, coveredPositives, inducedConditionsCount, premise, pvalue, ruleOrderNum, stats, weight, weighted_n, weighted_N, weighted_p, weighted_P

Constructor Summary

Constructors

Constructor	Description
ClassificationRule()	Creates empty classification rule.
ClassificationRule(CompoundCondition premise, ElementaryCondition consequence)	Creates classification rule with a given premise and a consequence.

Method Summary

Modifier and Type	Method	Description
Covering	covers(IExampleSet set)	Applies the rule on a specified example set.
void	covers(IExampleSet set, ContingencyTable ct)	Applies the rule on a specified example set.
void	covers(IExampleSet set, ContingencyTable ct, Set<Integer> positives, Set<Integer> negatives)	Applies the rule on a specified example set.
Covering	covers(IExampleSet set, Set<Integer> filterIds)	Applies the rule on a part of a specified example set.
String	getClassLabel()
void	updateWeightAndPValue(IExampleSet trainSet, ContingencyTable ct, IQualityMeasure votingMeasure)	Calculates Rule.weight and Rule.pvalue.

Methods inherited from class adaa.analytics.rules.logic.representation.rule.Rule

clone, copyFrom, coversUnlabelled, equals, getConsequence, getCoveredNegatives, getCoveredPositives, getCoveringInformation, getInducedConditionsCount, getPremise, getPValue, getRuleOrderNum, getStat, getTableHeader, getWeight, getWeighted_n, getWeighted_N, getWeighted_p, getWeighted_P, printStats, putStat, setConsequence, setCoveredNegatives, setCoveredPositives, setCoveringInformation, setInducedContitionsCount, setPremise, setPValue, setRuleOrderNum, setWeight, setWeighted_n, setWeighted_N, setWeighted_p, setWeighted_P, toString, toTable

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ClassificationRule

public ClassificationRule()

Creates empty classification rule.

ClassificationRule

public ClassificationRule(CompoundCondition premise,
 ElementaryCondition consequence)

Creates classification rule with a given premise and a consequence.

Parameters:

premise - Rule premise.

consequence - Rule consequence.

Method Details

getClassLabel

public String getClassLabel()

updateWeightAndPValue

public void updateWeightAndPValue(IExampleSet trainSet,
 ContingencyTable ct,
 IQualityMeasure votingMeasure)

Calculates Rule.weight and Rule.pvalue.

Specified by:

updateWeightAndPValue in class Rule

Parameters:

trainSet - Training set.

ct - Contingency table.

votingMeasure - Measure used as weight.

covers

public Covering covers(IExampleSet set,
 Set<Integer> filterIds)

Applies the rule on a part of a specified example set.

Specified by:

covers in class Rule

Parameters:

set - Example set.

filterIds - Set of identifiers to be examined.

Returns:

Information about covering.

covers

public Covering covers(IExampleSet set)

Applies the rule on a specified example set.

Specified by:

covers in class Rule

Parameters:

set - Example set.

Returns:

Information about covering.

covers

public void covers(IExampleSet set,
 ContingencyTable ct)

Applies the rule on a specified example set.

Overrides:

covers in class Rule

Parameters:

set - Example set.

ct - Output contingency table.

covers

public void covers(IExampleSet set,
 ContingencyTable ct,
 Set<Integer> positives,
 Set<Integer> negatives)

Applies the rule on a specified example set.

Overrides:

covers in class Rule

Parameters:

set - Example set.

ct - Output contingency table.

positives - Output collection of covered positive ids.

negatives - Output collection of covered negative ids.