Expand description

Whistlin’Oak

Repository Build Status Documentation

Annotated even-arity trees backed by mmaps.

Usage

whistlinoak = "0.1"

Example

use tempfile::NamedTempFile;
use whistlinoak::{Annotation, Tree};

let file = NamedTempFile::new().unwrap();
let path = file.into_temp_path();

struct Cardinality(usize);

impl<T> Annotation<T> for Cardinality {
    fn compute(leaf: &T) -> Self {
        Cardinality(1)
    }

    fn combine<'a>(annotations: impl Iterator<Item=&'a Self>) -> Self
    where
        Self: 'a
    {
        Self(annotations.fold(0, |curr, c| curr + c.0))
    }
}

let mut tree = Tree::<usize, Cardinality>::new(path).unwrap();

let n_leaves = 1000;

for i in 0..n_leaves {
    tree.push(i).unwrap();
}

assert_eq!(tree.len(), n_leaves);
assert_eq!(tree.root().0, n_leaves);

Structs

An annotated tree structure with an arity of 2N, backed by an mmap.

Traits

Annotation over a leaf.