Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.AssociationRules.AssociationRule Class Reference

Inheritance diagram for kddml.Core.DataMining.AssociationRules.AssociationRule:

kddml.Core.DataMining.AssociationRules.AssociationRuleManager List of all members.

Public Member Functions

 AssociationRule (Itemset antecedent, Itemset consequent, double support, double confidence)
ItemsetManager getAntecedent ()
ItemsetManager getConsequent ()
double getSupport ()
int getAbsoluteSupport (int num_transactions)
double getConfidence ()
int getSize ()
boolean isSupported (TransactionManager transaction)
String toString ()
boolean equals (Object rule)
boolean contains (ItemsetManager itemset)

Detailed Description

Association defines a relationship between two itemsets where the antecendent implies the consequent. An association rule consists of four major parts:
  1. the antecedent itemset (A);
  2. the consequent itemset (C);
  3. the support of the rule, that is, the relative frequency of transactions that contain A and C. support(A->C) = support(A+C)
  4. The confidence of the rule. confidence(A->C) = support(A+C) / support(A)

Title: KDDML

Description: Knowledge Discovery in Database Environment

Copyright: Copyright (c) 2003-2005

Company: Universita' di Pisa - Dipartimento di Informatica

Author:
Andrea Romei (romei@di.unipi.it)
Version:
2.0.16


Constructor & Destructor Documentation

kddml.Core.DataMining.AssociationRules.AssociationRule.AssociationRule Itemset  antecedent,
Itemset  consequent,
double  support,
double  confidence
 

Constructor give the antecedent, the consequent, the support and the confidence.

Parameters:
antecedent Itemset
consequent Itemset
support double
confidence double


Member Function Documentation

ItemsetManager kddml.Core.DataMining.AssociationRules.AssociationRule.getAntecedent  )  [virtual]
 

Returns the antecedent of the association rule. Cannot return null.

Returns:
ItemsetManager

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

ItemsetManager kddml.Core.DataMining.AssociationRules.AssociationRule.getConsequent  )  [virtual]
 

Returns the consequent of the association rule. Cannot return null.

Returns:
ItemsetManager

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

double kddml.Core.DataMining.AssociationRules.AssociationRule.getSupport  )  [virtual]
 

Returns the support of this rule in the model as a percentage of the total number of transactions. It is a number between 0 and 1, inclusive.

Returns:
double

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

int kddml.Core.DataMining.AssociationRules.AssociationRule.getAbsoluteSupport int  num_transactions  ) 
 

Returns the support for this rule in terms of absolute count of transactions supporting it.

Parameters:
num_transactions int the total number of transactions used to build the rules.
Returns:
int

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

double kddml.Core.DataMining.AssociationRules.AssociationRule.getConfidence  )  [virtual]
 

Returns the confidence of this rule in the model as a percentage of the total number of transactions. It is a number between 0 and 1, inclusive.

Returns:
double

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

int kddml.Core.DataMining.AssociationRules.AssociationRule.getSize  ) 
 

Returns the size of this rule in terms of the number of items in antecedent and consequent. Returns a value >= 2.

Returns:
int

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

boolean kddml.Core.DataMining.AssociationRules.AssociationRule.isSupported TransactionManager  transaction  ) 
 

Tests if this rule satisfy an input transaction. A transaction satisfy a rule I1, ..., In --> In+1, ..., Im if every item Ii with i in [1, m] occurs in the transaction.

Parameters:
transaction TransactionManager
Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

String kddml.Core.DataMining.AssociationRules.AssociationRule.toString  ) 
 

Returns a representation of this object as string.

Returns:
String

boolean kddml.Core.DataMining.AssociationRules.AssociationRule.equals Object  rule  )  [virtual]
 

Tests if two rules are equal.

Parameters:
rule AssociationRuleManager
Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.

boolean kddml.Core.DataMining.AssociationRules.AssociationRule.contains ItemsetManager  itemset  )  [virtual]
 

Test if an association rule contains an input itemset. Return true if the association rule contains the itemset in the body or in the head.

Parameters:
itemset ItemsetManager
Returns:
boolean

Implements kddml.Core.DataMining.AssociationRules.AssociationRuleManager.


Generated on Thu Feb 23 13:04:38 2006 for kddml by  doxygen 1.4.3