aboutsummaryrefslogtreecommitdiff
path: root/src/openvic-simulation/types/OrderedContainers.hpp
blob: 31bf17a6f8c66acfa3bf0fbf3ce94ff7b5d2ab72 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
#pragma once

#include <cctype>
#include <deque>
#include <functional>
#include <memory>

#include <tsl/ordered_map.h>
#include <tsl/ordered_set.h>

#include "openvic-simulation/utility/StringUtils.hpp"
#include "openvic-simulation/utility/Utility.hpp"

namespace OpenVic {
   struct ordered_container_string_hash {
      using is_transparent = void;
      [[nodiscard]] size_t operator()(char const* txt) const {
         return std::hash<std::string_view> {}(txt);
      }
      [[nodiscard]] size_t operator()(std::string_view txt) const {
         return std::hash<std::string_view> {}(txt);
      }
      [[nodiscard]] size_t operator()(std::string const& txt) const {
         return std::hash<std::string> {}(txt);
      }
   };

   template<typename T>
   struct container_hash : std::hash<T> {};

   template<>
   struct container_hash<std::string> : ordered_container_string_hash {};
   template<>
   struct container_hash<std::string_view> : ordered_container_string_hash {};
   template<>
   struct container_hash<char const*> : ordered_container_string_hash {};

   // Useful for contiguous memory
   template<
      class Key, class T, class Hash = container_hash<Key>, class KeyEqual = std::equal_to<>,
      class Allocator = std::allocator<std::pair<Key, T>>, class IndexType = std::uint_least32_t>
   using vector_ordered_map =
      tsl::ordered_map<Key, T, Hash, KeyEqual, Allocator, std::vector<std::pair<Key, T>, Allocator>, IndexType>;

   // Useful for stable memory addresses (so long as you don't remove or insert values)
   template<
      class Key, class T, class Hash = container_hash<Key>, class KeyEqual = std::equal_to<>,
      class Allocator = std::allocator<std::pair<Key, T>>, class IndexType = std::uint_least32_t>
   using deque_ordered_map =
      tsl::ordered_map<Key, T, Hash, KeyEqual, Allocator, std::deque<std::pair<Key, T>, Allocator>, IndexType>;

   template<
      class Key, class T, class Hash = container_hash<Key>, class KeyEqual = std::equal_to<>,
      class Allocator = std::allocator<std::pair<Key, T>>, class IndexType = std::uint_least32_t>
   using ordered_map = vector_ordered_map<Key, T, Hash, KeyEqual, Allocator, IndexType>;

   // Useful for contiguous memory
   template<
      class Key, class Hash = container_hash<Key>, class KeyEqual = std::equal_to<>, class Allocator = std::allocator<Key>,
      class IndexType = std::uint_least32_t>
   using vector_ordered_set = tsl::ordered_set<Key, Hash, KeyEqual, Allocator, std::vector<Key, Allocator>, IndexType>;

   // Useful for stable memory addresses (so long as you don't remove or insert values)
   template<
      class Key, class Hash = container_hash<Key>, class KeyEqual = std::equal_to<>, class Allocator = std::allocator<Key>,
      class IndexType = std::uint_least32_t>
   using deque_ordered_set = tsl::ordered_set<Key, Hash, KeyEqual, Allocator, std::deque<Key, Allocator>, IndexType>;

   template<
      class Key, class Hash = container_hash<Key>, class KeyEqual = std::equal_to<>, class Allocator = std::allocator<Key>,
      class IndexType = std::uint_least32_t>
   using ordered_set = vector_ordered_set<Key, Hash, KeyEqual, Allocator, IndexType>;

   template<typename T>
   concept IsOrderedMap = utility::is_derived_from_specialization_of<T, tsl::ordered_map>;
   template<typename T>
   concept IsOrderedSet = utility::is_derived_from_specialization_of<T, tsl::ordered_set>;
   template<typename T>
   concept IsVectorOrderedMap = utility::is_derived_from_specialization_of<T, vector_ordered_map>;
   template<typename T>
   concept IsVectorOrderedSet = utility::is_derived_from_specialization_of<T, vector_ordered_set>;
   template<typename T>
   concept IsDequeOrderedMap = utility::is_derived_from_specialization_of<T, deque_ordered_map>;
   template<typename T>
   concept IsDequeOrderedSet = utility::is_derived_from_specialization_of<T, deque_ordered_set>;

   template<typename T, typename Key, typename Value>
   concept IsOrderedMapOf =
      IsOrderedMap<T> && std::same_as<Key, typename T::key_type> && std::same_as<Value, typename T::mapped_type>;
   template<typename T, typename Key>
   concept IsOrderedSetOf = IsOrderedSet<T> && std::same_as<Key, typename T::key_type>;
   template<typename T, typename Key, typename Value>
   concept IsVectorOrderedMapOf =
      IsVectorOrderedMap<T> && std::same_as<Key, typename T::key_type> && std::same_as<Value, typename T::mapped_type>;
   template<typename T, typename Key>
   concept IsVectorOrderedSetOf = IsVectorOrderedSet<T> && std::same_as<Key, typename T::key_type>;
   template<typename T, typename Key, typename Value>
   concept IsDequeOrderedMapOf =
      IsDequeOrderedMap<T> && std::same_as<Key, typename T::key_type> && std::same_as<Value, typename T::mapped_type>;
   template<typename T, typename Key>
   concept IsDequeOrderedSetOf = IsDequeOrderedSet<T> && std::same_as<Key, typename T::key_type>;

   /* Case-Insensitive Containers */
   struct case_insensitive_string_hash {
      using is_transparent = void;

   private:
      /* Based on the byte array hashing functions in MSVC's <type_traits>. */
      [[nodiscard]] static constexpr size_t _hash_bytes_case_insensitive(char const* first, size_t count) {
         constexpr size_t _offset_basis = 14695981039346656037ULL;
         constexpr size_t _prime = 1099511628211ULL;
         size_t hash = _offset_basis;
         for (size_t i = 0; i < count; ++i) {
            hash ^= static_cast<size_t>(std::tolower(static_cast<unsigned char>(first[i])));
            hash *= _prime;
         }
         return hash;
      }

   public:
      [[nodiscard]] constexpr size_t operator()(char const* txt) const {
         return operator()(std::string_view { txt });
      }
      [[nodiscard]] constexpr size_t operator()(std::string_view txt) const {
         return _hash_bytes_case_insensitive(txt.data(), txt.length());
      }
      [[nodiscard]] constexpr size_t operator()(std::string const& txt) const {
         return _hash_bytes_case_insensitive(txt.data(), txt.length());
      }
   };

   struct case_insensitive_string_equal {
      using is_transparent = void;

      [[nodiscard]] constexpr bool operator()(std::string_view const& lhs, std::string_view const& rhs) const {
         return StringUtils::strings_equal_case_insensitive(lhs, rhs);
      }
   };

   // Useful for contiguous memory
   template<class Key, class T, class Allocator = std::allocator<std::pair<Key, T>>, class IndexType = std::uint_least32_t>
   using case_insensitive_vector_ordered_map =
      vector_ordered_map<Key, T, case_insensitive_string_hash, case_insensitive_string_equal, Allocator, IndexType>;

   // Useful for stable memory addresses (so long as you don't remove or insert values)
   template<class Key, class T, class Allocator = std::allocator<std::pair<Key, T>>, class IndexType = std::uint_least32_t>
   using case_insensitive_deque_ordered_map =
      deque_ordered_map<Key, T, case_insensitive_string_hash, case_insensitive_string_equal, Allocator, IndexType>;

   template<class Key, class T, class Allocator = std::allocator<std::pair<Key, T>>, class IndexType = std::uint_least32_t>
   using case_insensitive_ordered_map = case_insensitive_vector_ordered_map<Key, T, Allocator, IndexType>;

   // Useful for contiguous memory
   template<class Key, class Allocator = std::allocator<Key>, class IndexType = std::uint_least32_t>
   using case_insensitive_vector_ordered_set =
      vector_ordered_set<Key, case_insensitive_string_hash, case_insensitive_string_equal, Allocator, IndexType>;

   // Useful for stable memory addresses (so long as you don't remove or insert values)
   template<class Key, class Allocator = std::allocator<Key>, class IndexType = std::uint_least32_t>
   using case_insensitive_deque_ordered_set =
      deque_ordered_set<Key, case_insensitive_string_hash, case_insensitive_string_equal, Allocator, IndexType>;

   template<class Key, class Allocator = std::allocator<Key>, class IndexType = std::uint_least32_t>
   using case_insensitive_ordered_set = case_insensitive_vector_ordered_set<Key, Allocator, IndexType>;

   template<typename Case>
   concept StringMapCase = requires(std::string_view identifier) {
      { typename Case::hash {}(identifier) } -> std::same_as<std::size_t>;
      { typename Case::equal {}(identifier, identifier) } -> std::same_as<bool>;
   };
   struct StringMapCaseSensitive {
      using hash = container_hash<std::string>;
      using equal = std::equal_to<>;
   };
   struct StringMapCaseInsensitive {
      using hash = case_insensitive_string_hash;
      using equal = case_insensitive_string_equal;
   };

   /* Intermediate struct that "remembers" Case, instead of just decomposing it into its hash and equal components,
    * needed so that templates can deduce the Case with which a type was defined. */
   template<template<typename...> typename Container, StringMapCase Case, typename... Args>
   struct template_case_container_t : Container<Args..., typename Case::hash, typename Case::equal> {
      using container_t = Container<Args..., typename Case::hash, typename Case::equal>;
      using container_t::container_t;

      using case_t = Case;
   };

   /* Template for map with string keys, supporting search by string_view without creating an intermediate string. */
   template<typename T, StringMapCase Case>
   using template_string_map_t = template_case_container_t<ordered_map, Case, std::string, T>;

   template<typename T>
   using string_map_t = template_string_map_t<T, StringMapCaseSensitive>;
   template<typename T>
   using case_insensitive_string_map_t = template_string_map_t<T, StringMapCaseInsensitive>;

   /* Template for set with string elements, supporting search by string_view without creating an intermediate string. */
   template<StringMapCase Case>
   using template_string_set_t = template_case_container_t<ordered_set, Case, std::string>;

   using string_set_t = template_string_set_t<StringMapCaseSensitive>;
   using case_insensitive_string_set_t = template_string_set_t<StringMapCaseInsensitive>;
}