org.thegalactic.rule

Class AssociationRule

java.lang.Object

org.thegalactic.rule.Rule

org.thegalactic.rule.AssociationRule

All Implemented Interfaces:

Comparable<Rule>

public class AssociationRule
extends Rule

This class gives a representation for an association rule.

A rule is composed of a premise and a conclusion that are comparable sets, i.e. sets of elements that can be sorted by the lectic order defined by class ComparableSet. An association rule extends regular rule with the notion of support and confidence. The confidence represents the number of observations for which the rule is true. The support represents the minimum number of observations for the rule to be relevant.

To Do#1

do we use composition over inheritance?

Constructor Summary

Constructors

Constructor and Description
AssociationRule() Constructs a new empty Rule with a empty premise and an empty conclusion.
AssociationRule(SortedSet<Comparable> premise, SortedSet<Comparable> conclusion) Constructs a new Rule with the premise and the conclusion given in parameters.
AssociationRule(SortedSet<Comparable> premise, SortedSet<Comparable> conclusion, double support, double confidence) Constructs a new Rule with the premise, the conclusion, the confidence and the support given in parameters.

Method Summary

Modifier and Type	Method and Description
double	getConfidence() Returns the confidence value of the rule.
double	getSupport() Returns the support value of the rule.
void	setConfidence(double confidence) Set the confidence value of the rule.
void	setSupport(double support) Set the support value of the rule.
String	toString() Returns a String representation of this component.

Methods inherited from class org.thegalactic.rule.Rule

addAllToConclusion, addAllToPremise, addToConclusion, addToPremise, compareTo, equals, getConclusion, getPremise, hashCode, removeAllFromConclusion, removeAllFromPremise, removeFromConclusion, removeFromPremise

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssociationRule

public AssociationRule()

Constructs a new empty Rule with a empty premise and an empty conclusion.

AssociationRule

public AssociationRule(SortedSet<Comparable> premise,
                       SortedSet<Comparable> conclusion)

Constructs a new Rule with the premise and the conclusion given in parameters.

Parameters:

premise - a set of indexed elements

conclusion - a set of indexed elements

AssociationRule

public AssociationRule(SortedSet<Comparable> premise,
                       SortedSet<Comparable> conclusion,
                       double support,
                       double confidence)

Constructs a new Rule with the premise, the conclusion, the confidence and the support given in parameters.

Parameters:

premise - a set of indexed elements

conclusion - a set of indexed elements

support - a support value

confidence - a confidence value

Method Detail

getConfidence

public final double getConfidence()

Returns the confidence value of the rule.

Returns:

confidence value

getSupport

public final double getSupport()

Returns the support value of the rule.

Returns:

support value

setConfidence

public final void setConfidence(double confidence)

Set the confidence value of the rule.

Parameters:

confidence - the confidence value

setSupport

public final void setSupport(double support)

Set the support value of the rule.

Parameters:

support - the support value

toString

public String toString()

Returns a String representation of this component.

The following format is used:

[premise] -> [conclusion] : s:support/c:confidence

Overrides:

toString in class Rule

Returns:

a string made of premises followed by -> and the conclusions.