ca.pfv.spmf.algorithms.frequentpatterns.defme

Class AlgoDefMe

java.lang.Object

ca.pfv.spmf.algorithms.frequentpatterns.defme.AlgoDefMe

public class AlgoDefMe
extends java.lang.Object

This is a recent implementation of the DefMe algorithm that uses bitsets to represent tidsets, and is implemented to mine itemsets. Defme was proposed by Soulet et al (2014).

See this article for details about DefMe:

Soulet, A., Rioult, F. (2014). Efficiently Depth-First Minimal Pattern Mining, PAKDD 2014.

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

See Also:

TransactionDatabase, Itemset, Itemsets

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AlgoDefMe.BitSetSupport Anonymous inner class to store a bitset and its cardinality (an itemset's tidset and its support).

Constructor Summary

Constructors

Constructor and Description
AlgoDefMe() Default constructor

Method Summary

Modifier and Type	Method and Description
Itemsets	getItemsets() Get the set of frequent itemsets.
void	printStats() Print statistics about the algorithm execution to System.out.
Itemsets	runAlgorithm(java.lang.String output, TransactionDatabase database, double minsup) Run the algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgoDefMe

public AlgoDefMe()

Default constructor

Method Detail

runAlgorithm

public Itemsets runAlgorithm(java.lang.String output,
                             TransactionDatabase database,
                             double minsup)
                      throws java.io.IOException

Run the algorithm.

Parameters:

database - a transaction database

output - an output file path for writing the result or if null the result is saved into memory and returned

minsup - the minimum support

Returns:

the set of generators if the user chose to save the result to memory. Otherwise, null.

Throws:

java.io.IOException - exception if error while writing the file.

printStats

public void printStats()

Print statistics about the algorithm execution to System.out.

getItemsets

public Itemsets getItemsets()

Get the set of frequent itemsets.

Returns:

the frequent itemsets (Itemsets).