Skip to content

Commit 4f3811f

Browse files
committed
docs: Add file brief descriptions for various headers
1 parent 64fd4db commit 4f3811f

File tree

4 files changed

+20
-0
lines changed

4 files changed

+20
-0
lines changed

weilycoder/ds/group.hpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#ifndef WEILYCODER_GROUP_HPP
22
#define WEILYCODER_GROUP_HPP
33

4+
/**
5+
* @file group.hpp
6+
* @brief Group Definitions
7+
*/
8+
49
namespace weilycoder {
510
/**
611
* @brief Additive Group

weilycoder/ds/point_add_range_sum.hpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#ifndef WEILYCODER_POINT_ADD_RANGE_SUM_HPP
22
#define WEILYCODER_POINT_ADD_RANGE_SUM_HPP
33

4+
/**
5+
* @file point_add_range_sum.hpp
6+
* @brief Point Add Range Sum using Fenwick Tree
7+
*/
8+
49
#include "group.hpp"
510
#include <cstddef>
611
#include <stdexcept>

weilycoder/ds/static_range_sum.hpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#ifndef WEILYCODER_STATIC_RANGE_SUM_HPP
22
#define WEILYCODER_STATIC_RANGE_SUM_HPP
33

4+
/**
5+
* @file static_range_sum.hpp
6+
* @brief Static Range Sum using Prefix Sums
7+
*/
8+
49
#include "group.hpp"
510
#include <cstddef>
611
#include <stdexcept>

weilycoder/ds/unionfind.hpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#ifndef WEILYCODER_UNIONFIND_HPP
22
#define WEILYCODER_UNIONFIND_HPP
33

4+
/**
5+
* @file unionfind.hpp
6+
* @brief Union-Find (Disjoint Set Union) Data Structure
7+
*/
8+
49
#include <algorithm>
510
#include <numeric>
611
#include <vector>

0 commit comments

Comments
 (0)