diff options
| author | Lioncash <mathew1800@gmail.com> | 2019-10-15 14:56:15 -0400 |
|---|---|---|
| committer | Lioncash <mathew1800@gmail.com> | 2019-10-15 15:25:23 -0400 |
| commit | d5706346d7e95984a003bfeedf1b8ffed6dd9422 (patch) | |
| tree | 1966d00f489790ec77e3d55e0b40d9e047272411 /src/common/algorithm.h | |
| parent | ac4dbd3b25f022b3ef025f6d3451712187308efb (diff) | |
common/algorithm: Add description comment indicating intended algorithms
Makes it explicit that the header is intended for iterator-based
algorithms that can ideally operate on any type.
Diffstat (limited to 'src/common/algorithm.h')
| -rw-r--r-- | src/common/algorithm.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/common/algorithm.h b/src/common/algorithm.h index 18e7ece981..e21b1373ca 100644 --- a/src/common/algorithm.h +++ b/src/common/algorithm.h @@ -7,6 +7,11 @@ #include <algorithm> #include <functional> +// Algorithms that operate on iterators, much like the <algorithm> header. +// +// Note: If the algorithm is not general-purpose and/or doesn't operate on iterators, +// it should probably not be placed within this header. + namespace Common { template <class ForwardIt, class T, class Compare = std::less<>> |