sequence-map 0.1.0

Implements a map of unsigned 64-bit keys into strings. The map is optimized for creating it once, and then reading many times. The struct `Builder` is used to build the map, and the struct `Map` is used for lookups. The special property of the implementation is that it encodes all the data needed for the lookup in a single sequence of bytes. This makes it rather interesting for dynamic loading of data that can then be placed in an operating system's read only memory. The internal structure requires no decoding when it is loaded (say from a file).
Documentation
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use criterion::{criterion_group, criterion_main, Criterion};
use sequence_map;

const ENTRIES: usize = 50000;

fn run_one(lookup: &sequence_map::Map, bits: usize, entries: usize, c: &mut Criterion) {
    c.bench_function(&format!("lookup bits={} entries={}", bits, entries), move |b| {
        b.iter(|| {
            for key in 0..entries {
                lookup.get(key as u64).expect(&format!("entry exists: {}", key));
            }
        })
    });
}

fn run_bit_size(bits: usize, entries: usize, c: &mut Criterion) {
    let mut builder = sequence_map::Builder::new(bits);
    for key in 0..entries {
        let string = format!("entry_{}", key);
        builder.insert(key as u64, &string);
    }
    let bytes = builder.build();
    let lookup = sequence_map::Map::new(&bytes);

    run_one(&lookup, bits, 1, c);
    run_one(&lookup, bits, 10, c);
    run_one(&lookup, bits, 100, c);
    run_one(&lookup, bits, 1000, c);
}

pub fn criterion_benchmark(c: &mut Criterion) {
    run_bit_size(2, ENTRIES, c);
    run_bit_size(4, ENTRIES, c);
    run_bit_size(8, ENTRIES, c);
    run_bit_size(16, ENTRIES, c);
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);