Move comments around, add test example.

First off, this commit moves in-depth discussion of implementation details and
efficiency from the BTree docstring to the package docstring.  Secondly, we add
a simple test example detailing most of the functionality of the tree.
2 files changed
tree: d2c9c270bd9259ddcb056a08e3dd7109722b4f09
  1. btree.go
  2. btree_mem.go
  3. btree_test.go
  4. LICENSE
  5. README.md
README.md

BTree implementation for Go

This package provides an in-memory B-Tree implementation for Go, useful as a an ordered, mutable data structure.

The API is based off of the wonderful http://godoc.org/github.com/petar/GoLLRB/llrb, and is meant to allow btree to act as a drop-in replacement for gollrb trees.

See http://godoc.org/github.com/google/btree for documentation.