Package elki.result

Class FrequentItemsetsResult

  • All Implemented Interfaces:
    elki.result.textwriter.TextWriteable
    public class FrequentItemsetsResult
extends java.lang.Object
implements elki.result.textwriter.TextWriteable
    Result class for frequent itemset mining algorithms.
    Since:
    0.2
    Author:
    Erich Schubert

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      FrequentItemsetsResult​(java.util.List<Itemset> itemsets, elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> meta, int total)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<Itemset> getItemsets()
      Returns the frequent item sets.
      elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> getMeta()
      Get the metadata used for serialization.
      int getTotal()
      Get the total number of transactions.
      void writeToText​(elki.result.textwriter.TextWriterStream out, java.lang.String label)  

      • 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 elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> meta
        Metadata of the data relation, for item labels.

      • total

        private int total
        Total number of transactions.

    • Constructor Detail

      • FrequentItemsetsResult

        public FrequentItemsetsResult​(java.util.List<Itemset> itemsets,
                              elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> meta,
                              int total)
        Constructor.
        Parameters:
        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​(elki.result.textwriter.TextWriterStream out,
                        java.lang.String label)
        Specified by:
        writeToText in interface elki.result.textwriter.TextWriteable

      • getMeta

        public elki.data.type.VectorFieldTypeInformation<elki.data.BitVector> getMeta()
        Get the metadata used for serialization.
        Returns:
        Metadata

      • getTotal

        public int getTotal()
        Get the total number of transactions.
        Returns:
        Total transactions