aboutsummaryrefslogtreecommitdiff
path: root/src/lib/map.rs
blob: f95741761c0c6c1fc40e9cfee9b4036aa421845b (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
206
207
208
209
210
211
212
213
214
/**
 * At the moment, this is a partial hashmap implementation, not yet fit for
 * use, but useful as a stress test for rustboot.
 */

import std._int;
import std.sys;
import std.util;
import std._vec;


type hashfn[K] = fn(&K) -> uint;
type eqfn[K] = fn(&K, &K) -> bool;

type hashmap[K, V] = obj {
  fn insert(&K key, &V val) -> bool;
  fn contains_key(&K key) -> bool;
  fn get(&K key) -> V;
  fn find(&K key) -> util.option[V];
  fn remove(&K key) -> util.option[V];
  fn rehash();
};

fn mk_hashmap[K, V](&hashfn[K] hasher, &eqfn[K] eqer) -> hashmap[K, V] {

  let uint initial_capacity = 32u; // 2^5
  let util.rational load_factor = rec(num=3, den=4);

  type bucket[K, V] = tag(nil(), deleted(), some(K, V));

  fn make_buckets[K, V](uint nbkts) -> vec[mutable bucket[K, V]] {
    ret _vec.init_elt[mutable bucket[K, V]](nil[K, V](), nbkts);
  }

  // Derive two hash functions from the one given by taking the upper
  // half and lower half of the uint bits.  Our bucket probing
  // sequence is then defined by
  //
  //   hash(key, i) := hashl(key) + i * hashr(key)   for i = 0, 1, 2, ...
  //
  // Tearing the hash function apart this way is kosher in practice
  // as, assuming 32-bit uints, the table would have to be at 2^32
  // buckets before the resulting pair of hash functions no longer
  // probes all buckets for a fixed key.  Note that hashr is made to
  // output odd numbers (hence coprime to the number of nbkts, which
  // is always a power of 2), so that all buckets are probed for a
  // fixed key.

  fn hashl[K](&hashfn[K] hasher, uint nbkts, &K key) -> uint {
    ret (hasher(key) >>> (sys.rustrt.size_of[uint]() * 8u / 2u))
      % nbkts;
  }

  fn hashr[K](&hashfn[K] hasher, uint nbkts, &K key) -> uint {
    ret ((((~ 0u) >>> (sys.rustrt.size_of[uint]() * 8u / 2u))
          & hasher(key)) * 2u + 1u)
      % nbkts;
  }

  fn hash[K](&hashfn[K] hasher, uint nbkts, &K key, uint i) -> uint {
    ret hashl[K](hasher, nbkts, key) + i * hashr[K](hasher, nbkts, key);
  }

  /**
   * We attempt to never call this with a full table.  If we do, it
   * will fail.
   */
  fn insert_common[K, V](&hashfn[K] hasher,
                         &eqfn[K] eqer,
                         vec[mutable bucket[K, V]] bkts,
                         uint nbkts,
                         &K key,
                         &V val)
    -> bool
  {
    let uint i = 0u;
    while (i < nbkts) {
      // FIXME (issue #94): as in find_common()
      let int j = (hash[K](hasher, nbkts, key, i)) as int;
      alt (bkts.(j)) {
        case (some[K, V](k, _)) {
          if (eqer(key, k)) {
            bkts.(j) = some[K, V](k, val);
            ret false;
          }
          i += 1u;
        }
        case (_) {
          bkts.(j) = some[K, V](key, val);
          ret true;
        }
      }
    }
    fail; // full table
  }

  fn find_common[K, V](&hashfn[K] hasher,
                       &eqfn[K] eqer,
                       vec[mutable bucket[K, V]] bkts,
                       uint nbkts,
                       &K key)
    -> util.option[V]
  {
    let uint i = 0u;
    while (i < nbkts) {
      // FIXME (issue #94):  Pending bugfix, remove uint coercion.
      let int j = (hash[K](hasher, nbkts, key, i)) as int;
      alt (bkts.(j)) {
        case (some[K, V](k, v)) {
          if (eqer(key, k)) {
            ret util.some[V](v);
          }
        }
        case (nil[K, V]()) {
          ret util.none[V]();
        }
        case (deleted[K, V]()) { }
      }
      i += 1u;
    }
    ret util.none[V]();
  }


  fn rehash[K, V](&hashfn[K] hasher,
                  &eqfn[K] eqer,
                  vec[mutable bucket[K, V]] oldbkts, uint noldbkts,
                  vec[mutable bucket[K, V]] newbkts, uint nnewbkts)
  {
    for (bucket[K, V] b in oldbkts) {
      alt (b) {
        case (some[K, V](k, v)) {
          insert_common[K, V](hasher, eqer, newbkts, nnewbkts, k, v);
        }
        case (_) { }
      }
    }
  }

  obj hashmap[K, V](hashfn[K] hasher,
                    eqfn[K] eqer,
                    mutable vec[mutable bucket[K, V]] bkts,
                    mutable uint nbkts,
                    mutable uint nelts,
                    util.rational lf)
  {
    fn insert(&K key, &V val) -> bool {
      let util.rational load = rec(num=(nelts + 1u) as int, den=nbkts as int);
      if (!util.rational_leq(load, lf)) {
        let uint nnewbkts = _int.next_power_of_two(nbkts + 1u);

        // FIXME (issue #94):  Enforce our workaround to issue #94.
        check ((nnewbkts as int) > 0);

        let vec[mutable bucket[K, V]] newbkts = make_buckets[K, V](nnewbkts);
        rehash[K, V](hasher, eqer, bkts, nbkts, newbkts, nnewbkts);
      }
      if (insert_common[K, V](hasher, eqer, bkts, nbkts, key, val)) {
        nelts += 1u;
        ret true;
      }
      ret false;
    }

    fn contains_key(&K key) -> bool {
      alt (find_common[K, V](hasher, eqer, bkts, nbkts, key)) {
        case (util.some[V](_)) { ret true; }
        case (_) { ret false; }
      }
    }

    fn get(&K key) -> V {
      alt (find_common[K, V](hasher, eqer, bkts, nbkts, key)) {
        case (util.some[V](val)) { ret val; }
        case (_) { fail; }
      }
    }

    fn find(&K key) -> util.option[V] {
      be find_common[K, V](hasher, eqer, bkts, nbkts, key);
    }

    fn remove(&K key) -> util.option[V] {
      let uint i = 0u;
      while (i < nbkts) {
        // FIXME (issue #94): as in find_common()
        let int j = (hash[K](hasher, nbkts, key, i)) as int;
        alt (bkts.(j)) {
          case (some[K, V](_, val)) {
            bkts.(j) = deleted[K, V]();
            ret util.some[V](val);
          }
          case (deleted[K, V]()) {
            nelts += 1u;
          }
          case (nil[K, V]()) {
            ret util.none[V]();
          }
        }
      }
      ret util.none[V]();
    }

    fn rehash() {
      let vec[mutable bucket[K, V]] newbkts = make_buckets[K, V](nbkts);
      rehash[K, V](hasher, eqer, bkts, nbkts, newbkts, nbkts);
      bkts = newbkts;
    }
  }

  let vec[mutable bucket[K, V]] bkts = make_buckets[K, V](initial_capacity);

  ret hashmap[K, V](hasher, eqer, bkts, initial_capacity, 0u, load_factor);
}