summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md86
1 files changed, 86 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..65ec173
--- /dev/null
+++ b/README.md
@@ -0,0 +1,86 @@
+fixedbitset
+---
+
+A simple bitset container for Rust
+
+Please read the [API documentation here](https://docs.rs/fixedbitset/)
+
+[![build\_status](https://github.com/petgraph/fixedbitset/workflows/Continuous%20integration/badge.svg?branch=master)](https://github.com/petgraph/fixedbitset/actions)
+[![crates](https://img.shields.io/crates/v/fixedbitset.svg)](https://crates.io/crates/fixedbitset)
+
+# Recent Changes
+
+- 0.4.2
+ - [#79](https://github.com/petgraph/fixedbitset/pull/79): Add `is_clear`,
+ clarify `is_empty` and `len` documentation by \@nicopap.
+- 0.4.1
+ - Documentation and formatting fixes.
+- 0.4.0
+ - [#61](https://github.com/petgraph/fixedbitset/pull/61): Require
+ Rust 1.39.
+ - [#60](https://github.com/petgraph/fixedbitset/pull/60): Add
+ `const` `FixedBitSet::new` consructor
+ by \@jakobhellermann.
+ - [#59](https://github.com/petgraph/fixedbitset/pull/59): Add
+ optional `serde` support by \@keshavsn.
+- 0.3.2
+ - [#18](https://github.com/petgraph/fixedbitset/pull/18): Optimize
+ `ones` using `trailing_zeroes` by \@vks
+- 0.3.1
+ - Add bit assign operators for references by \@flaghacker
+ - Improve assertion error messages by \@lovasoa
+ - Add documentation examples for `with_capacity_and_blocks`
+- 0.3.0
+ - Add `with_capacity_and_blocks` by \@luizirber
+ - Add `difference_with` by \@sunshowers
+ - Implement `Binary` and `Display` traits by \@Dolphindalt
+ - Add `toggle_range` by \@wirelyre
+- 0.2.0
+ - Add assign operators for the bit operations by \@jrraymond
+ - Add `symmetric_difference`, `union_with`, `intersection_with` by
+ \@jrraymond
+ - Add `is_subset`, `is_superset`, `is_disjoint` by \@nwn
+ - Add `.toggle(i)` method by \@ShiroUsagi-san
+ - Add default feature \"std\" which can be disabled to make the
+ crate not link the std library. By \@jonimake and \@bluss
+ - Require Rust 1.31.
+- 0.1.9
+ - Add intersection, union, difference iterators by \@jrraymond
+ - Add intersection: `&` and union: `|` operator implementations by
+ \@jrraymond
+ - Add Extend and FromIterator implementations (from sequences of
+ bit indices) by \@jrraymond
+- 0.1.8
+ - Add missing `#[inline]` on the ones iterator
+ - Fix docs for `insert_range, set_range`
+- 0.1.7
+ - Add fast methods `.insert_range`, `.set_range` by \@kennytm
+- 0.1.6
+ - Add iterator `.ones()` by \@mneumann
+ - Fix bug with `.count_ones()` where it would erronously have an
+ out-of-bounds panic for even block endpoints
+- 0.1.5
+ - Add method `.count_ones(range)`.
+- 0.1.4
+ - Remove an assertion in `.copy_bit(from, to)` so that it is in
+ line with the documentation. The `from` bit does not need to be
+ in bounds.
+ - Improve `.grow()` to use `Vec::resize` internally.
+- 0.1.3
+ - Add method `.put()` to enable a bit and return previous value
+- 0.1.2
+ - Add method `.copy_bit()` (by fuine)
+ - impl Default
+- 0.1.1
+ - Update documentation URL
+- 0.1.0
+ - Add method `.grow()`
+
+# License
+
+Dual-licensed to be compatible with the Rust project.
+
+Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+ or the [MIT license](https://opensource.org/licenses/MIT),
+ at your option. This file may not be copied, modified, or distributed except
+according to those terms.