ca.pfv.spmf.algorithms.associationrules.agrawal94_association_rules

Class AlgoAgrawalFaster94

java.lang.Object

ca.pfv.spmf.algorithms.associationrules.agrawal94_association_rules.AlgoAgrawalFaster94

Direct Known Subclasses:

AlgoClosedRules

public class AlgoAgrawalFaster94
extends java.lang.Object

This is an implementation of the "faster algorithm" for generating association rules, described in Agrawal & al. 1994, IBM Research Report RJ9839, June 1994.

This implementation saves the result to a file or can alternatively keep it into memory if no output path is provided by the user when the runAlgorithm() method is called.

See Also:

AssocRule, AssocRules

Constructor Summary

Constructors

Constructor and Description
AlgoAgrawalFaster94() Default constructor

Method Summary

Modifier and Type	Method and Description
void	printStats() Print statistics about the algorithm execution to System.out.
AssocRules	runAlgorithm(Itemsets patterns, java.lang.String output, int databaseSize, double minconf) Run the algorithm
AssocRules	runAlgorithm(Itemsets patterns, java.lang.String output, int databaseSize, double minconf, double minlift) Run the algorithm

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlgoAgrawalFaster94

public AlgoAgrawalFaster94()

Default constructor

Method Detail

runAlgorithm

public AssocRules runAlgorithm(Itemsets patterns,
                               java.lang.String output,
                               int databaseSize,
                               double minconf)
                        throws java.io.IOException

Run the algorithm

Parameters:

patterns - a set of frequent itemsets

output - an output file path for writing the result or null if the user want this method to return the result

databaseSize - the number of transactions in the database

minconf - the minconf threshold

Returns:

the set of association rules if the user wished to save them into memory

Throws:

java.io.IOException - exception if error writing to the output file

runAlgorithm

public AssocRules runAlgorithm(Itemsets patterns,
                               java.lang.String output,
                               int databaseSize,
                               double minconf,
                               double minlift)
                        throws java.io.IOException

Run the algorithm

Parameters:

patterns - a set of frequent itemsets

output - an output file path for writing the result or null if the user want this method to return the result

databaseSize - the number of transactions in the database

minconf - the minconf threshold

minlift - the minlift threshold

Returns:

the set of association rules if the user wished to save them into memory

Throws:

java.io.IOException - exception if error writing to the output file

printStats

public void printStats()

Print statistics about the algorithm execution to System.out.