de.lmu.ifi.dbs.elki.algorithm.itemsetmining.associationrules

Class AssociationRuleGeneration

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<AssociationRuleResult>

de.lmu.ifi.dbs.elki.algorithm.itemsetmining.associationrules.AssociationRuleGeneration

All Implemented Interfaces:

Algorithm

@Reference(authors="M. J. Zaki, W. Meira Jr.",
           title="Data mining and analysis: fundamental concepts and algorithms",
           booktitle="Cambridge University Press, 2014",
           bibkey="DBLP:books/cu/ZM2014")
public class AssociationRuleGeneration
extends AbstractAlgorithm<AssociationRuleResult>

Association rule generation from frequent itemsets

This algorithm calls a specified frequent itemset algorithm and calculates all association rules, having a interest value between then the specified boundaries form the obtained frequent itemsets

Reference:

M. J. Zaki, W. Meira Jr
Data mining and analysis: fundamental concepts and algorithms
Cambridge University Press, 2014

Since:

0.7.5

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AssociationRuleGeneration.Instance Class to run
static class	AssociationRuleGeneration.ItemsetSearcher Class to find itemsets in a sorted list.
static class	AssociationRuleGeneration.Parameterizer Parameterization class.
protected static class	AssociationRuleGeneration.PartialItemset Mutable scatch itemset for finding itemsets, based on SparseItemset.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractFrequentItemsetAlgorithm	frequentItemAlgo Frequent Itemset Algorithm to be used.
protected InterestingnessMeasure	interestingness Interestingness measure to be used.
private static Logging	LOG Class logger.
protected double	maxmeasure Parameter for maximum interestingness measure.
protected double	minmeasure Parameter for minimum interestingness measure.

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

ALGORITHM_ID

Constructor Summary

Constructors

Constructor and Description
AssociationRuleGeneration(AbstractFrequentItemsetAlgorithm frequentItemAlgo, InterestingnessMeasure interestMeasure, double minmeasure) Constructor
AssociationRuleGeneration(AbstractFrequentItemsetAlgorithm frequentItemAlgo, InterestingnessMeasure interestMeasure, double minmeasure, double maxmeasure) Constructor.

Method Summary

Modifier and Type	Method and Description
TypeInformation[]	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
protected Logging	getLogger() Get the (STATIC) logger for this class.
AssociationRuleResult	run(Database database) Run on a database

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logging LOG

Class logger.

frequentItemAlgo

protected AbstractFrequentItemsetAlgorithm frequentItemAlgo

Frequent Itemset Algorithm to be used.

interestingness

protected InterestingnessMeasure interestingness

Interestingness measure to be used.

minmeasure

protected double minmeasure

Parameter for minimum interestingness measure.

maxmeasure

protected double maxmeasure

Parameter for maximum interestingness measure.

Constructor Detail

AssociationRuleGeneration

public AssociationRuleGeneration(AbstractFrequentItemsetAlgorithm frequentItemAlgo,
                                 InterestingnessMeasure interestMeasure,
                                 double minmeasure,
                                 double maxmeasure)

Constructor.

Parameters:

frequentItemAlgo - FrequentItemset mining Algorithm

interestMeasure - Interestingness measure

minmeasure - Minimum threshold for interestingness measure

maxmeasure - Maximum threshold for interestingness measure

AssociationRuleGeneration

public AssociationRuleGeneration(AbstractFrequentItemsetAlgorithm frequentItemAlgo,
                                 InterestingnessMeasure interestMeasure,
                                 double minmeasure)

Constructor

Parameters:

frequentItemAlgo - FrequentItemset mining Algorithm

interestMeasure - Interestingness measure

minmeasure - Minimum threshold for interestingness measure

Method Detail

run

public AssociationRuleResult run(Database database)

Run on a database

Specified by:

run in interface Algorithm

Overrides:

run in class AbstractAlgorithm<AssociationRuleResult>

Parameters:

database - Database

Returns:

Association rules

getInputTypeRestriction

public TypeInformation[] getInputTypeRestriction()

Description copied from class: AbstractAlgorithm

Get the input type restriction used for negotiating the data query.

Specified by:

getInputTypeRestriction in interface Algorithm

Specified by:

getInputTypeRestriction in class AbstractAlgorithm<AssociationRuleResult>

Returns:

Type restriction

getLogger

protected Logging getLogger()

Description copied from class: AbstractAlgorithm

Get the (STATIC) logger for this class.

Specified by:

getLogger in class AbstractAlgorithm<AssociationRuleResult>

Returns:

the static logger