org.knime.base.node.mine.subgroupminer.apriori
Interface AprioriAlgorithm

All Known Implementing Classes:
ArrayApriori, TIDApriori

public interface AprioriAlgorithm

This is an interface to hide the different implementations of the apriori algorithm to the Nodes. If a class implements this interface and the user should be able to select this type of algorithm, you should also change the AprioriAlgorithmFactory.

Author:
Fabian Dill, University of Konstanz

Method Summary
 void findFrequentItemSets(List<BitVectorValue> transactions, double minSupport, int maxDepth, FrequentItemSet.Type type, ExecutionMonitor exec)
          This is the method to start with when mining for frequent itemsets.
 List<AssociationRule> getAssociationRules(double confidence)
          Returns the association rules generated from the found frequent itemsets with the passed minimal confidence.
 List<FrequentItemSet> getFrequentItemSets(FrequentItemSet.Type type)
          Returns the found frequent itemsets according to their type, which can either be FREE, CLOSED or MAXIMAL.
 

Method Detail

findFrequentItemSets

void findFrequentItemSets(List<BitVectorValue> transactions,
                          double minSupport,
                          int maxDepth,
                          FrequentItemSet.Type type,
                          ExecutionMonitor exec)
                          throws CanceledExecutionException
This is the method to start with when mining for frequent itemsets.

Parameters:
transactions - a list of BitSets representing the bitvectors, thus, corresponding to the whole database
minSupport - the minimum support as an absolute value
maxDepth - the maximal length of an itemset
type - the desired type of the frequent itemsets
exec - the execution monitor
Throws:
CanceledExecutionException - if the execution was cancelled

getFrequentItemSets

List<FrequentItemSet> getFrequentItemSets(FrequentItemSet.Type type)
Returns the found frequent itemsets according to their type, which can either be FREE, CLOSED or MAXIMAL.

Parameters:
type - the desired type, either free, closed or maximal
Returns:
a list of the found frequent itemsets of the referring type

getAssociationRules

List<AssociationRule> getAssociationRules(double confidence)
Returns the association rules generated from the found frequent itemsets with the passed minimal confidence.

Parameters:
confidence - the desired minimal confidence of the rules
Returns:
a list of associaiton rules with the minimum confidence


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.