N-archive/yuzu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

common/algorithm: Add description comment indicating intended algorithms

Browse source 
Makes it explicit that the header is intended for iterator-based
algorithms that can ideally operate on any type.
This commit is contained in:
Lioncash 2019-10-15 14:56:15 -04:00
parent ac4dbd3b25
commit d5706346d7
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/common/algorithm.h
View file

@ -7,6 +7,11 @@
#include <algorithm> #include <algorithm>
#include <functional> #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 { namespace Common {
template <class ForwardIt, class T, class Compare = std::less<>> template <class ForwardIt, class T, class Compare = std::less<>>