How pawelbeza/algoanalysis works
Major Modules/Components
• Sorting – Contains implementations for bubble sort, merge sort, quick sort, and a comparison against STL sort, with dedicated input files (small_input.txt, big_input.txt) and test harnesses.
• Dictionaries – Implements dictionary data structures using AVL trees and splay trees. It includes a large text file (The_bible.txt) and supports insertion and querying benchmarks contrasted with STL map behavior.
• Pattern Searching – Implements string search algorithms (BruteForce, KMP, Rabin-Karp) along with their respective test suites.
• Path Finding – Features an implementation of Dijkstra’s algorithm (note: spelled “Djikstra” in the code) packaged with its header, source files, and tests.
• karyHeap – Implements a heap data structure optimized for k‑ary heaps, including tests.
Relationships and Interactions
• Each module is self-contained with its own CMakeLists.txt, indicating that they are independently built units suitable for separate compilation and testing.
• The input files (e.g., The_bible.txt, big_input.txt, small_input.txt, test.txt) are external data sources fed into the corresponding testing harnesses.
• Tests (e.g., test.cpp and tests.cpp in each folder) interact with the source code to measure performance, which ultimately leads to the generation of benchmark charts (as described in the README).
Architectural Patterns and Design Principles
• Modularization – Each algorithm category is isolated into its own directory, promoting separation of concerns and allowing for independent development, testing, and benchmarking.
• Benchmarking & Comparison – The structure emphasizes dual paths: custom algorithm implementations versus STL equivalents, which is central when comparing execution times.
• Use of CMake – Each module has its own CMakeLists.txt; this signifies a standardized build system across the project, demonstrating reproducibility and modular builds.
Relevant Technologies/Frameworks
• Programming Language: C++
• Build System: CMake
• Benchmarking/Test Harnesses: Custom test files that execute and time algorithm performance.
• External Dependencies: Standard Template Library (STL) for comparisons.
Specific Elements to Incorporate
• Clear, descriptive labels for each component (e.g., “Sorting Module”, “Dictionary Module”, “Pattern Searching Module”, etc.).
• Algorithm implementations (e.g., rectangles for modules)
• Under each module, detail the specific algorithms and associated test/input files.
• Link the modules to a shared “Benchmark & Analysis” layer that symbolizes the performance comparison (as described in the README charts).
• That while each module is independent, they collectively serve the overarching purpose of algorithm analysis and performance benchmarking.