cobt 0.1.1

A Cache-Oblivious B-Tree implementation in Rust
Documentation 
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

<h1 align="center">cobt</h1>

<div align="center">Cache-Oblivious B-Tree's in Rust</div>

<!--
Still need to publish both the API Docs and the Changelog
<div align="center">
    <a href="https://docs.rs/crate/cobt/">Released API Docs</a>
    |
    <a href="https://github.com/Toby-Faucher/cobt/blob/master/CHANGELOG.md">Changelog</a>
</div>-->



## Table of Contents


- [Table of Contents](#table-of-contents)
  - [Quickstart](#quickstart)
  - [Contributing](#contributing)
  - [License](#license)

## Quickstart


To start with cobt, add the following to your `Cargo.toml` file:
```toml
[dependencies]
cobt = "0.1"
```
and add this to you can use it your project:

```rust
use cobt::CacheObliviousBTree;

fn main() {
    let mut tree = CacheObliviousBTree::new();

    for i in 0..20 {
        tree.insert(i, format!("value_{}", i));
    }

    println!("Tree Size {}", tree.len());

    for i in [0, 5, 10, 15, 19, 25] {
        match tree.search(&i) {
            Some(v) => println!("Key {}: {}", i, v),
            None => println!("Key {}, not found", i),
        }
    }
}
```

## Contributing


Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to this project.

Whether you're fixing bugs, adding features, improving documentation, or reporting issues, your help is appreciated.

## License


This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.