commit | 6d00f65dd4d4a572f9a2db7ee9ed93a184361a60 | [log] [tgz] |
---|---|---|
author | Graeme Connell <gconnell@google.com> | Fri Aug 01 11:14:24 2014 -0600 |
committer | Graeme Connell <gconnell@google.com> | Fri Aug 01 11:14:24 2014 -0600 |
tree | d2c9c270bd9259ddcb056a08e3dd7109722b4f09 | |
parent | 07b41b253e55263d06351b777e384bb749e40134 [diff] |
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.
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.