DFDecoderWithEEManagement< DF > Class Template Reference

Writes patterns (itemsets plus support count) to disk. More...

#include <DFDecoderWithEEManagement.hpp>

List of all members.

Public Types
typedef DF::params_t	params_t
Public Member Functions
	DFDecoderWithEEManagement (const params_t *par)
size_t	nrOfEEItems () const
bool	EEListEmpty () const
void	pushItem (item_t item)
	Push an item to the item stack.
void	popItem ()
	Pop an item from the item stack.
void	pushEquisupportItem (item_t item)
	Pushes a given item on the stack of equisupport items.
void	pushEquisupportItemSet (const std::vector< item_t > &itemset)
	Pushes a given itemset on the stack of equisupport items.
void	write (counter_t support)
	Writes actual itemset and all its equisupport extensions as represented by the actual stack of equisupport items.
void	pushItemWithPrevSupport (item_t item)
	Pushes an item on the item stack and writes actual itemset and all its equisupport extensions as represented by the actual stack of equisupport items.
void	pushItemWithWrite (item_t item, counter_t support)
	Pushes an item on the item stack and writes actual itemset and all its equisupport extensions as represented by the actual stack of equisupport items.
Private Member Functions
void	write1 ()
	Writes the EE extensions with the prevSupport writer of the parent.
void	popEquisupportItem ()
	Pops last item from the stack of equisupport items.
void	popEquisupportItems (int numEEItems)
	Pops given number of last items from the stack of equisupport items.
Private Attributes
std::vector< item_t >	ee_buffer
	The buffer for the equisupport extensions.
std::vector< size_t >	ee_buffer_segment_length
	size of ee-buffer segment for each item, i.e.
Classes
class	EquisupportItemOutputIterator
	An interface for writing equisupport items:. More...

---

Detailed Description

template<class DF = CacheDFDecoder< >>
class DFDecoderWithEEManagement< DF >

Writes patterns (itemsets plus support count) to disk.

• Uses CacheDFDecoder for all i/o stuff (see there).
• Can manage a stack of equisupport extension items: write outputs the actual pattern as well as all its equisupport extensions as represented by the actual ee stack (so be careful to push ee items *before* issueing the write method).
• Keeps track of the state of the ee stack for each usual item so there is no need for a method popEquisupportItem !

Usage is as follows:

1. pushItem
2. pushEEItem
3. write
4. popItem

Please note that EE items have to be pushed *after* the respective item.

It is possible to push EE items to the empty set (i.e. w.o. an initial pushItem). These item *cannot* be poped again later on.

Author:

Lars Schmidt-Thieme

Definition at line 39 of file DFDecoderWithEEManagement.hpp.

---

Member Typedef Documentation

template<class DF = CacheDFDecoder< >> typedef DF::params_t DFDecoderWithEEManagement< DF >::params_t

Definition at line 43 of file DFDecoderWithEEManagement.hpp.

---

Constructor & Destructor Documentation

template<class DF = CacheDFDecoder< >> DFDecoderWithEEManagement< DF >::DFDecoderWithEEManagement (  const params_t *  par  )  [inline]

Definition at line 45 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer_segment_length.

---

Member Function Documentation

template<class DF = CacheDFDecoder< >> bool DFDecoderWithEEManagement< DF >::EEListEmpty (   )  const [inline]

Definition at line 55 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer.

template<class DF = CacheDFDecoder< >> size_t DFDecoderWithEEManagement< DF >::nrOfEEItems (   )  const [inline]

Definition at line 51 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer.

template<class DF> void DFDecoderWithEEManagement< DF >::popEquisupportItem (   )  [inline, private]

Pops last item from the stack of equisupport items. Definition at line 200 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer, and DFDecoderWithEEManagement< DF >::ee_buffer_segment_length.

template<class DF> void DFDecoderWithEEManagement< DF >::popEquisupportItems (  int  numEEItems  )  [inline, private]

Pops given number of last items from the stack of equisupport items. Definition at line 211 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer, and DFDecoderWithEEManagement< DF >::ee_buffer_segment_length. Referenced by DFDecoderWithEEManagement< DF >::popItem().

template<class DF = CacheDFDecoder< >> void DFDecoderWithEEManagement< DF >::popItem (   )  [inline]

Pop an item from the item stack. Definition at line 77 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer_segment_length, and DFDecoderWithEEManagement< DF >::popEquisupportItems().

template<class DF> void DFDecoderWithEEManagement< DF >::pushEquisupportItem (  item_t  item  )  [inline]

Pushes a given item on the stack of equisupport items. Definition at line 177 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer, and DFDecoderWithEEManagement< DF >::ee_buffer_segment_length. Referenced by DFDecoderWithEEManagement< DF >::EquisupportItemOutputIterator::operator=().

template<class DF> void DFDecoderWithEEManagement< DF >::pushEquisupportItemSet (  const std::vector< item_t > &  itemset  )  [inline]

Pushes a given itemset on the stack of equisupport items. Definition at line 187 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer, and DFDecoderWithEEManagement< DF >::ee_buffer_segment_length.

template<class DF = CacheDFDecoder< >> void DFDecoderWithEEManagement< DF >::pushItem (  item_t  item  )  [inline]

Push an item to the item stack. note that functionality is duplicated in function pushItemWithPrevSupport. Definition at line 65 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer_segment_length. Referenced by DFDecoderWithEEManagement< DF >::pushItemWithWrite().

template<class DF = CacheDFDecoder< >> void DFDecoderWithEEManagement< DF >::pushItemWithPrevSupport (  item_t  item  )  [inline]

Pushes an item on the item stack and writes actual itemset and all its equisupport extensions as represented by the actual stack of equisupport items. Support will be the same as the previous write() or pushItemWithPrevSupport call set it to. Definition at line 117 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer_segment_length, and DFDecoderWithEEManagement< DF >::write1().

template<class DF = CacheDFDecoder< >> void DFDecoderWithEEManagement< DF >::pushItemWithWrite (  item_t  item, counter_t  support )  [inline]

Pushes an item on the item stack and writes actual itemset and all its equisupport extensions as represented by the actual stack of equisupport items. Definition at line 128 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::pushItem(), and DFDecoderWithEEManagement< DF >::write().

template<class DF = CacheDFDecoder< >> void DFDecoderWithEEManagement< DF >::write (  counter_t  support  )  [inline]

Writes actual itemset and all its equisupport extensions as represented by the actual stack of equisupport items. Definition at line 104 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::write1(). Referenced by DFDecoderWithEEManagement< DF >::pushItemWithWrite().

template<class DF> void DFDecoderWithEEManagement< DF >::write1 (   )  [inline, private]

Writes the EE extensions with the prevSupport writer of the parent. The length of the ee_buffer Definition at line 229 of file DFDecoderWithEEManagement.hpp. References DFDecoderWithEEManagement< DF >::ee_buffer. Referenced by DFDecoderWithEEManagement< DF >::pushItemWithPrevSupport(), and DFDecoderWithEEManagement< DF >::write().

---

Member Data Documentation

template<class DF = CacheDFDecoder< >> std::vector<item_t> DFDecoderWithEEManagement< DF >::ee_buffer [private]

The buffer for the equisupport extensions. Definition at line 150 of file DFDecoderWithEEManagement.hpp. Referenced by DFDecoderWithEEManagement< DF >::EEListEmpty(), DFDecoderWithEEManagement< DF >::nrOfEEItems(), DFDecoderWithEEManagement< DF >::popEquisupportItem(), DFDecoderWithEEManagement< DF >::popEquisupportItems(), DFDecoderWithEEManagement< DF >::pushEquisupportItem(), DFDecoderWithEEManagement< DF >::pushEquisupportItemSet(), and DFDecoderWithEEManagement< DF >::write1().

template<class DF = CacheDFDecoder< >> std::vector<size_t> DFDecoderWithEEManagement< DF >::ee_buffer_segment_length [private]

size of ee-buffer segment for each item, i.e. , number of ee-items added specific before this item. Definition at line 155 of file DFDecoderWithEEManagement.hpp. Referenced by DFDecoderWithEEManagement< DF >::DFDecoderWithEEManagement(), DFDecoderWithEEManagement< DF >::popEquisupportItem(), DFDecoderWithEEManagement< DF >::popEquisupportItems(), DFDecoderWithEEManagement< DF >::popItem(), DFDecoderWithEEManagement< DF >::pushEquisupportItem(), DFDecoderWithEEManagement< DF >::pushEquisupportItemSet(), DFDecoderWithEEManagement< DF >::pushItem(), and DFDecoderWithEEManagement< DF >::pushItemWithPrevSupport().

---

The documentation for this class was generated from the following file:

• DFDecoderWithEEManagement.hpp

---