OilfieldToolsNet/opm-common
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document at least what OrderedMap class is all about.

Browse Source
This commit is contained in:
Markus Blatt 2022-06-24 12:16:46 +02:00
parent d4cd92ee40
commit 19c58e33c4
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
opm/input/eclipse/EclipseState/Util/OrderedMap.hpp
View File

@ -100,6 +100,16 @@ struct TruncatedStringEquals<std::string::npos> : public std::equal_to<std::stri
} // end namespace detail } // end namespace detail
/// \brief A map with iteration in the order of insertion.
///
/// Each entry has an associated index indicating when a value with that key was
/// first inserted. When itering over it's entries values with lower insertion index
/// are traversed before ones with an higher insertion index.
///
/// \tparam MAX_CHARS The maximum number of characters that are use a keys. Default is
/// std::string::npos, which honors all characters. Any keys with the
/// same first MAX_CHARS characters are considered equal.
///
template <typename T, std::size_t MAX_CHARS = std::string::npos> template <typename T, std::size_t MAX_CHARS = std::string::npos>
class OrderedMap { class OrderedMap {
public: public: