de.lmu.ifi.dbs.elki.result

Class FrequentItemsetsResult

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.result.BasicResult

de.lmu.ifi.dbs.elki.result.FrequentItemsetsResult

All Implemented Interfaces:

HierarchicalResult, Result, TextWriteable

public class FrequentItemsetsResult
extends BasicResult
implements TextWriteable

Result class for frequent itemset mining algorithms.

Since:

0.2

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<Itemset>	itemsets The supports of all frequent itemsets.
private VectorFieldTypeInformation<BitVector>	meta Metadata of the data relation, for item labels.
private int	total Total number of transactions.

Constructor Summary

Constructors

Constructor and Description
FrequentItemsetsResult(java.lang.String name, java.lang.String shortname, java.util.List<Itemset> itemsets, VectorFieldTypeInformation<BitVector> meta, int total) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<Itemset>	getItemsets() Returns the frequent item sets.
VectorFieldTypeInformation<BitVector>	getMeta() Get the metadata used for serialization.
int	getTotal() Get the total number of transactions.
void	writeToText(TextWriterStream out, java.lang.String label) Write self to the given TextWriterStream

Methods inherited from class de.lmu.ifi.dbs.elki.result.BasicResult

getLongName, getShortName

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

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

Field Detail

itemsets

private java.util.List<Itemset> itemsets

The supports of all frequent itemsets.

meta

private VectorFieldTypeInformation<BitVector> meta

Metadata of the data relation, for item labels.

total

private int total

Total number of transactions.

Constructor Detail

FrequentItemsetsResult

public FrequentItemsetsResult(java.lang.String name,
                              java.lang.String shortname,
                              java.util.List<Itemset> itemsets,
                              VectorFieldTypeInformation<BitVector> meta,
                              int total)

Constructor.

Parameters:

name - The long name (for pretty printing)

shortname - the short name (for filenames etc.)

itemsets - Frequent itemsets (sorted, by size then lexicographically)

meta - Metadata

total - Total number of transactions

Method Detail

getItemsets

public java.util.List<Itemset> getItemsets()

Returns the frequent item sets.

Returns:

the frequent item sets.

writeToText

public void writeToText(TextWriterStream out,
                        java.lang.String label)

Description copied from interface: TextWriteable

Write self to the given TextWriterStream

Specified by:

writeToText in interface TextWriteable

Parameters:

out - Output writer

label - Label

getMeta

public VectorFieldTypeInformation<BitVector> getMeta()

Get the metadata used for serialization.

Returns:

Metadata

getTotal

public int getTotal()

Get the total number of transactions.

Returns:

Total transactions