Skip to content

Commit

Permalink
Remove TODO list, bump to 0.1 as mostly API complete
Browse files Browse the repository at this point in the history
  • Loading branch information
Nemo157 committed Jan 3, 2015
1 parent e616fd1 commit 36750b6
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 30 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]

name = "roaring"
version = "0.0.15"
version = "0.1.0"
authors = ["Wim Looman <[email protected]>"]
description = "http://roaringbitmap.org for http://www.rust-lang.org"

Expand Down
30 changes: 1 addition & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RoaringBitmap [![Travis CI Build Status][]][travis]

> This is not yet production ready.
> This is not yet production ready. The API should be mostly complete now.
This is a [Rust][] port of the [Roaring bitmap][] data structure, initially
defined as a [Java library][roaring-java] and described in [_Better bitmap
Expand All @@ -11,32 +11,6 @@ performance with Roaring bitmaps_][roaring-paper].
Take note of the [Collections reform RFC][collections-rfc] for the API. Mostly aiming to
duplicate the [BitvSet][] API.

### TODO

- [ ] Bounded Iterators ([§ in the RFC][bounded-iterators])
- [ ] `fn range(&self, min: Bound<&T>, max: Bound<&T>) -> RangedItems<'a, T>;`
- [X] Set Operations ([§ in the RFC][set-operations])
- [X] Comparisons
- [X] `fn is_disjoint(&self, other: &Self) -> bool;`
- [X] `fn is_subset(&self, other: &Self) -> bool;`
- [X] `fn is_superset(&self, other: &Self) -> bool;`
- [X] Combinations
- [X] Iterated Functions
- [X] `fn union<'a>(&'a self, other: &'a Self) -> I;`
- [X] `fn intersection<'a>(&'a self, other: &'a Self) -> I;`
- [X] `fn difference<'a>(&'a self, other: &'a Self) -> I;`
- [X] `fn symmetric_difference<'a>(&'a self, other: &'a Self) -> I;`
- [X] Operator Traits
- [X] `std::ops::BitOr`
- [X] `std::ops::BitAnd`
- [X] `std::ops::Sub`
- [X] `std::ops::BitXor`
- [X] Inplace Functions
- [X] `fn union_with(&mut self, other: &BitvSet)`
- [X] `fn intersect_with(&mut self, other: &BitvSet)`
- [X] `fn difference_with(&mut self, other: &BitvSet)`
- [X] `fn symmetric_difference_with(&mut self, other: &BitvSet)`

[Travis CI Build Status]: https://img.shields.io/travis/Nemo157/roaring-rs.svg?style=flat-square
[travis]: https://travis-ci.org/Nemo157/roaring-rs
[Rust]: https://rust-lang.org
Expand All @@ -45,5 +19,3 @@ duplicate the [BitvSet][] API.
[roaring-paper]: http://arxiv.org/pdf/1402.6407v4
[collections-rfc]: https://github.com/rust-lang/rfcs/pull/235
[BitvSet]: http://doc.rust-lang.org/std/collections/bitv_set/struct.BitvSet.html
[bounded-iterators]: https://github.com/aturon/rfcs/blob/collections-conventions/text/0000-collection-conventions.md#bounded-iterators
[set-operations]: https://github.com/aturon/rfcs/blob/collections-conventions/text/0000-collection-conventions.md#set-operations

0 comments on commit 36750b6

Please sign in to comment.