rust/src/lib/map.rs

/**
 * Hashmap implementation.
 */
type hashfn[K] = fn(&K) -> uint ;

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

type hashmap[K, V] =
    obj {
        fn size() -> uint ;
        fn insert(&K, &V) -> bool ;
        fn contains_key(&K) -> bool ;
        fn get(&K) -> V ;
        fn find(&K) -> option::t[V] ;
        fn remove(&K) -> option::t[V] ;
        fn rehash() ;
        iter items() -> @{key: K, val: V} ;
        iter keys() -> K ;
    };
type hashset[K] = hashmap[K, ()];

fn set_add[@K](set: hashset[K], key: &K) -> bool { ret set.insert(key, ()); }

fn mk_hashmap[@K, @V](hasher: &hashfn[K], eqer: &eqfn[K]) -> hashmap[K, V] {
    let initial_capacity: uint = 32u; // 2^5

    let load_factor: util::rational = {num: 3, den: 4};
    tag bucket[@K, @V] { nil; deleted; some(K, V); }
    fn make_buckets[@K, @V](nbkts: uint) -> [mutable (bucket[K, V])] {
        ret ivec::init_elt_mut[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 hashl 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(n: uint, nbkts: uint) -> uint { ret (n >>> 16u) * 2u + 1u; }
    fn hashr(n: uint, nbkts: uint) -> uint { ret 0x0000_ffff_u & n; }
    fn hash(h: uint, nbkts: uint, i: uint) -> uint {
        ret (hashl(h, nbkts) * i + hashr(h, nbkts)) % nbkts;
    }
    /**
     * We attempt to never call this with a full table.  If we do, it
     * will fail.
     */

    fn insert_common[@K, @V](hasher: &hashfn[K], eqer: &eqfn[K],
                             bkts: &[mutable bucket[K, V]], nbkts: uint,
                             key: &K, val: &V) -> bool {
        let i: uint = 0u;
        let h: uint = hasher(key);
        while i < nbkts {
            let j: uint = hash(h, nbkts, i);
            alt bkts.(j) {
              some(k, _) {
                // Copy key to please alias analysis.

                let k_ = k;
                if eqer(key, k_) {
                    bkts.(j) = some(k_, val);
                    ret false;
                }
                i += 1u;
              }
              _ { bkts.(j) = some(key, val); ret true; }
            }
        }
        fail; // full table
    }
    fn find_common[@K, @V](hasher: &hashfn[K], eqer: &eqfn[K],
                           bkts: &[mutable bucket[K, V]], nbkts: uint,
                           key: &K) -> option::t[V] {
        let i: uint = 0u;
        let h: uint = hasher(key);
        while i < nbkts {
            let j: uint = hash(h, nbkts, i);
            alt bkts.(j) {
              some(k, v) {
                // Copy to please alias analysis.
                let k_ = k;
                let v_ = v;
                if eqer(key, k_) { ret option::some(v_); }
              }
              nil. { ret option::none; }
              deleted. { }
            }
            i += 1u;
        }
        ret option::none;
    }
    fn rehash[@K, @V](hasher: &hashfn[K], eqer: &eqfn[K],
                      oldbkts: &[mutable bucket[K, V]], noldbkts: uint,
                      newbkts: &[mutable bucket[K, V]], nnewbkts: uint) {
        for b: bucket[K, V]  in oldbkts {
            alt b {
              some(k_, v_) {
                let k = k_;
                let v = v_;
                insert_common(hasher, eqer, newbkts, nnewbkts, k, v);
              }
              _ { }
            }
        }
    }
    obj hashmap[@K, @V](hasher: hashfn[K],
                        eqer: eqfn[K],
                        mutable bkts: [mutable bucket[K, V]],
                        mutable nbkts: uint,
                        mutable nelts: uint,
                        lf: util::rational) {
        fn size() -> uint { ret nelts; }
        fn insert(key: &K, val: &V) -> bool {
            let load: util::rational =
                {num: nelts + 1u as int, den: nbkts as int};
            if !util::rational_leq(load, lf) {
                let nnewbkts: uint = uint::next_power_of_two(nbkts + 1u);
                let newbkts = make_buckets(nnewbkts);
                rehash(hasher, eqer, bkts, nbkts, newbkts, nnewbkts);
                bkts = newbkts;
                nbkts = nnewbkts;
            }
            if insert_common(hasher, eqer, bkts, nbkts, key, val) {
                nelts += 1u;
                ret true;
            }
            ret false;
        }
        fn contains_key(key: &K) -> bool {
            ret alt find_common(hasher, eqer, bkts, nbkts, key) {
                  option::some(_) { true }
                  _ { false }
                };
        }
        fn get(key: &K) -> V {
            ret alt find_common(hasher, eqer, bkts, nbkts, key) {
                  option::some(val) { val }
                  _ { fail }
                };
        }
        fn find(key: &K) -> option::t[V] {
            be find_common(hasher, eqer, bkts, nbkts, key);
        }
        fn remove(key: &K) -> option::t[V] {
            let i: uint = 0u;
            let h: uint = hasher(key);
            while i < nbkts {
                let j: uint = hash(h, nbkts, i);
                alt bkts.(j) {
                  some(k, v) {
                    let k_ = k;
                    let vo = option::some(v);
                    if eqer(key, k_) {
                        bkts.(j) = deleted;
                        nelts -= 1u;
                        ret vo;
                    }
                  }
                  deleted. { }
                  nil. { ret option::none; }
                }
                i += 1u;
            }
            ret option::none;
        }
        fn rehash() {
            let newbkts = make_buckets(nbkts);
            rehash(hasher, eqer, bkts, nbkts, newbkts, nbkts);
            bkts = newbkts;
        }
        iter items() -> @{key: K, val: V} {
            for b: bucket[K, V]  in bkts {
                alt b { some(k, v) { put @{key: k, val: v}; } _ { } }
            }
        }
        iter keys() -> K {
            for b: bucket[K, V]  in bkts {
                alt b { some(k, _) { put k; } _ { } }
            }
        }
    }
    let bkts = make_buckets(initial_capacity);
    ret hashmap(hasher, eqer, bkts, initial_capacity, 0u, load_factor);
}

// Hash map constructors for basic types

fn new_str_hash[@V]() -> hashmap[str, V] {
    ret mk_hashmap(str::hash, str::eq);
}

fn new_int_hash[@V]() -> hashmap[int, V] {
    fn hash_int(x: &int) -> uint { ret x as uint; }
    fn eq_int(a: &int, b: &int) -> bool { ret a == b; }
    ret mk_hashmap(hash_int, eq_int);
}

fn new_uint_hash[@V]() -> hashmap[uint, V] {
    fn hash_uint(x: &uint) -> uint { ret x; }
    fn eq_uint(a: &uint, b: &uint) -> bool { ret a == b; }
    ret mk_hashmap(hash_uint, eq_uint);
}

// Local Variables:
// mode: rust;
// fill-column: 78;
// indent-tabs-mode: nil
// c-basic-offset: 4
// buffer-file-coding-system: utf-8-unix
// compile-command: "make -k -C $RBUILD 2>&1 | sed -e 's/\\/x\\//x:\\//g'";
// End: