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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
use std::{
    hash::{BuildHasher, Hash, Hasher, RandomState},
    ops::{Deref, DerefMut},
};

macro_rules! make_hashable_map {
    ($hash_map_impl:ident) => {
        #[derive(Clone, Debug, Default)]
        pub struct HashableMap<K, V, S = RandomState>($hash_map_impl<K, V, S>);

        impl<K, V> HashableMap<K, V> {
            pub fn new() -> Self {
                Self($hash_map_impl::new())
            }

            pub fn with_capacity(capacity: usize) -> Self {
                Self($hash_map_impl::with_capacity(capacity))
            }
        }

        impl<K, V, S> HashableMap<K, V, S> {
            pub fn with_hasher(hash_builder: S) -> Self {
                Self($hash_map_impl::with_hasher(hash_builder))
            }

            pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
                Self($hash_map_impl::with_capacity_and_hasher(
                    capacity,
                    hash_builder,
                ))
            }
        }

        impl<K, V, S> Deref for HashableMap<K, V, S> {
            type Target = $hash_map_impl<K, V, S>;

            fn deref(&self) -> &Self::Target {
                &self.0
            }
        }

        impl<K, V, S> DerefMut for HashableMap<K, V, S> {
            fn deref_mut(&mut self) -> &mut Self::Target {
                &mut self.0
            }
        }

        impl<K, V, S> From<$hash_map_impl<K, V, S>> for HashableMap<K, V, S> {
            fn from(value: $hash_map_impl<K, V, S>) -> Self {
                Self(value)
            }
        }

        impl<T, S> From<HashableMap<T, S>> for $hash_map_impl<T, S> {
            fn from(value: HashableMap<T, S>) -> $hash_map_impl<T, S> {
                value.0
            }
        }

        impl<K, V, S, D> Hash for HashableMap<K, V, S>
        where
            K: Hash,
            V: Hash,
            S: BuildHasher<Hasher = D>,
            D: Hasher + Default,
        {
            fn hash<H: Hasher>(&self, state: &mut H) {
                let hash = self
                    .iter()
                    .map(|(k, v)| {
                        let mut hasher = D::default();
                        k.hash(&mut hasher);
                        v.hash(&mut hasher);
                        hasher.finish()
                    })
                    .fold(0, u64::wrapping_add);

                state.write_u64(hash);
            }
        }

        impl<K, V, S> PartialEq for HashableMap<K, V, S>
        where
            K: Eq + Hash,
            V: PartialEq,
            S: BuildHasher,
        {
            fn eq(&self, other: &Self) -> bool {
                self.0 == other.0
            }
        }

        impl<K, V, S> Eq for HashableMap<K, V, S>
        where
            K: Eq + Hash,
            V: Eq,
            S: BuildHasher,
        {
        }

        #[cfg(feature = "serde")]
        impl<K, V, S> serde::Serialize for HashableMap<K, V, S>
        where
            $hash_map_impl<K, V, S>: serde::Serialize,
        {
            fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
            where
                Ser: serde::Serializer,
            {
                self.0.serialize(serializer)
            }
        }

        #[cfg(feature = "serde")]
        impl<'de, K, V, S> serde::Deserialize<'de> for HashableMap<K, V, S>
        where
            $hash_map_impl<K, V, S>: serde::Deserialize<'de>,
        {
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: serde::Deserializer<'de>,
            {
                Ok(Self($hash_map_impl::deserialize(deserializer)?))
            }
        }
    };
}

use std::collections::HashMap;
make_hashable_map!(HashMap);

#[cfg(test)]
pub(crate) mod tests {
    use rand::prelude::SliceRandom;
    use rand::{
        distributions::{Distribution, Standard},
        thread_rng,
    };
    use std::hash::{BuildHasherDefault, DefaultHasher};

    use super::*;

    #[test]
    fn insertion_order_random_state() {
        insertion_order::<RandomState, _>()
    }

    #[test]
    fn insertion_order_fx_build_hasher() {
        insertion_order::<fxhash::FxBuildHasher, _>()
    }

    #[test]
    fn insertion_order_fnv_build_hasher() {
        insertion_order::<fnv::FnvBuildHasher, _>()
    }

    #[test]
    fn insertion_order_ahash_build_hasher() {
        insertion_order::<BuildHasherDefault<ahash::AHasher>, _>()
    }

    fn insertion_order<B: BuildHasher<Hasher = H> + Default, H: Hasher + Default>() {
        let values = generate_random_values::<i32, 128>();
        let values_shuffled = shuffle(&values);
        let values_other = generate_random_values::<i32, 128>();

        assert_ne!(values, values_shuffled);
        assert_ne!(values, values_other);
        assert_ne!(values_shuffled, values_other);

        let mut a = HashableMap::<_, _, B>::default();
        a.extend(values.iter().copied().map(|k| (k, k)));
        let mut b = HashableMap::<_, _, B>::default();
        b.extend(values_shuffled.iter().copied().map(|k| (k, k)));
        let mut c = HashableMap::<_, _, B>::default();
        c.extend(values_other.iter().copied().map(|k| (k, k)));

        assert_hash_eq(&a, &b);
        assert_hash_ne(&a, &c);
        assert_hash_ne(&b, &c)
    }

    #[test]
    fn same_keys_different_values_gx_build_hasher() {
        same_keys_different_values::<RandomState, _>()
    }

    fn same_keys_different_values<B: BuildHasher<Hasher = H> + Default, H: Hasher + Default>() {
        let keys = generate_random_values::<i32, 128>();
        let values1 = generate_random_values::<i32, 128>();
        let values2 = generate_random_values::<i32, 128>();

        assert_ne!(values1, values2);

        let mut a = HashableMap::<_, _, B>::default();
        a.extend(keys.iter().copied().zip(values1.iter().copied()));
        let mut b = HashableMap::<_, _, B>::default();
        b.extend(keys.iter().copied().zip(values2.iter().copied()));

        assert_hash_ne(&a, &b)
    }

    #[test]
    fn different_keys_same_values_gx_build_hasher() {
        different_keys_same_values::<RandomState, _>()
    }

    fn different_keys_same_values<B: BuildHasher<Hasher = H> + Default, H: Hasher + Default>() {
        let keys1 = generate_random_values::<i32, 128>();
        let keys2 = generate_random_values::<i32, 128>();
        let values = generate_random_values::<i32, 128>();

        assert_ne!(keys1, keys2);

        let mut a = HashableMap::<_, _, B>::default();
        a.extend(keys1.iter().copied().zip(values.iter().copied()));
        let mut b = HashableMap::<_, _, B>::default();
        b.extend(keys2.iter().copied().zip(values.iter().copied()));

        assert_hash_ne(&a, &b)
    }

    pub(crate) fn generate_random_values<T, const N: usize>() -> [T; N]
    where
        Standard: Distribution<[T; N]>,
    {
        rand::random()
    }

    pub(crate) fn shuffle<T, const N: usize>(values: &[T; N]) -> [T; N]
    where
        T: Clone,
    {
        let mut values = values.clone();
        values.shuffle(&mut thread_rng());
        values
    }

    pub(crate) fn assert_hash_eq<H: Hash>(a: &H, b: &H) {
        let mut hasher_a = DefaultHasher::new();
        a.hash(&mut hasher_a);
        let mut hasher_b = DefaultHasher::new();
        b.hash(&mut hasher_b);

        assert_eq!(hasher_a.finish(), hasher_b.finish());
    }

    pub(crate) fn assert_hash_ne<H: Hash>(x: &H, y: &H) {
        let mut hasher_x = DefaultHasher::new();
        x.hash(&mut hasher_x);
        let mut hasher_y = DefaultHasher::new();
        y.hash(&mut hasher_y);

        assert_ne!(hasher_x.finish(), hasher_y.finish());
    }
}