Package elki.itemsetmining.associationrules

Class AssociationRule

java.lang.Object

elki.itemsetmining.associationrules.AssociationRule

All Implemented Interfaces:

java.lang.Comparable<AssociationRule>

public class AssociationRule
extends java.lang.Object
implements java.lang.Comparable<AssociationRule>

Association Rule

Since:

0.7.5

Author:

Frederic Sautter

Field Summary

Fields

Modifier and Type	Field	Description
private Itemset	antecedent	Consequent itemset
private Itemset	consequent	Consequent itemset
private double	measure	Measure of the Rule.
private Itemset	union	Union of consequent and consequent

Constructor Summary

Constructors

Constructor	Description
AssociationRule(Itemset union, Itemset consequent, Itemset antecedent, double measure)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.StringBuilder	appendTo(java.lang.StringBuilder buf, VectorFieldTypeInformation<BitVector> meta)	Append to a string buffer.
int	compareTo(AssociationRule o)
Itemset	getAntecedent()	Get the antecedent of the rule.
Itemset	getConsequent()	Get the consequent of the rule.
double	getMeasure()	Get the rule measure.
Itemset	getUnion()	Get the union of consequent and consequent of the rule.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

consequent

private Itemset consequent

Consequent itemset

antecedent

private Itemset antecedent

Consequent itemset

union

private Itemset union

Union of consequent and consequent

measure

private double measure

Measure of the Rule.

Constructor Detail

AssociationRule

public AssociationRule(Itemset union,
                       Itemset consequent,
                       Itemset antecedent,
                       double measure)

Constructor.

Parameters:

union - Union of consequent and consequent

consequent - Consequent of the rule

antecedent - Antecedent of the rule

measure - Value of the interest measure

Method Detail

getConsequent

public Itemset getConsequent()

Get the consequent of the rule.

Returns:

consequent

getUnion

public Itemset getUnion()

Get the union of consequent and consequent of the rule.

Returns:

union

getMeasure

public double getMeasure()

Get the rule measure.

Returns:

measure

getAntecedent

public Itemset getAntecedent()

Get the antecedent of the rule.

Returns:

antecedent

compareTo

public int compareTo(AssociationRule o)

Specified by:

compareTo in interface java.lang.Comparable<AssociationRule>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

appendTo

public java.lang.StringBuilder appendTo(java.lang.StringBuilder buf,
                                        VectorFieldTypeInformation<BitVector> meta)

Append to a string buffer.

Parameters:

buf - Buffer

meta - Relation metadata (for labels)

Returns:

String buffer for chaining.