Data_Formatter Class Reference

An interface for formatter objects. More...

#include <Data_Formatter.h>

Inheritance diagram for Data_Formatter:
Unigram_Train_Data_Formatter Unigram_Model_Streamer Unigram_Test_Data_Formatter

List of all members.

Public Member Functions

virtual void format ()=0
 Perform the actual formatting.
virtual WordIndexDictionaryget_dictionary ()=0
 Return the dictionary being used by the formatter.
virtual int get_num_docs ()=0
 The number of documents formatted.
virtual int get_total_num_words ()=0
 The total number of words found.

Detailed Description

An interface for formatter objects.

A formatter is an object that converts raw text corpus into binary so that its disk footprint is low and there is no parsing involved while reading it back


Member Function Documentation

virtual void Data_Formatter::format (  )  [pure virtual]

Perform the actual formatting.

Implemented in Unigram_Train_Data_Formatter.

virtual WordIndexDictionary& Data_Formatter::get_dictionary (  )  [pure virtual]

Return the dictionary being used by the formatter.

Implemented in Unigram_Train_Data_Formatter.

virtual int Data_Formatter::get_num_docs (  )  [pure virtual]

The number of documents formatted.

Implemented in Unigram_Train_Data_Formatter.

virtual int Data_Formatter::get_total_num_words (  )  [pure virtual]

The total number of words found.

Implemented in Unigram_Train_Data_Formatter.


The documentation for this class was generated from the following file:
Generated on Tue Jul 19 11:45:26 2011 for Y!LDA by  doxygen 1.6.3