WordFreq Overview

Table of Contents

• Introduction to WordFreq
• WordFreq Classes
• Example Usage - parse a file and export the analytics.
• Example Usage - parse multiple file and export the combinded analytics.

Introduction to WordFreq

The WordFreq module supports the parsing and sorting alphabetically words in a text file. The primary use case is to collect word frequency information locally per document aswell as across multiple documents.

WordFreq Classes

• Parser - A class that parses and stores word frequency analytics.
• ParserCollection - A class that holds collection types needed to parse multiple files.
• StringHelper - A class that provides common string operations like lowering characters.

Example Usage - parse a file and export the analytics.

#include <iostream>
#include "lib/parser.h"
 
int main() {
    std::string fileName;
    std::cout << "Please enter a file name: ";
    std::cin >> fileName;
    Parser parser(fileName);
    parser.parse();
    parser.exportToFile();
    return 0;
}

Example Usage - parse multiple file and export the combinded analytics.

#include <iostream>
#include "lib/parser.h"
 
int main() {
    ParserCollection parserCollection;
    std::string fileName;
    for(int i = 0; i < 3; i++) {
        std::cout << "Please enter a file name: ";
        std::cin >> fileName;
        Parser parser(fileName, &parserCollection.globalFreqencyMap);
        parser.parse();
    }
    parserCollection.exportGlobal();
    return 0;
}