Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release version 0.7.0; include tiny maintentance #50

Merged
merged 4 commits into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ jobs:
cargo miri setup
- name: Test with Miri
run: MIRIFLAGS=-Zmiri-strict-provenance cargo miri test
- name: Run tests for serde feature
run: MIRIFLAGS=-Zmiri-strict-provenance cargo miri test --features serde

fmt:
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bit-set"
version = "0.6.0"
version = "0.7.0"
authors = ["Alexis Beingessner <[email protected]>"]
license = "Apache-2.0 OR MIT"
description = "A set of bits"
Expand All @@ -9,6 +9,7 @@ homepage = "https://github.com/contain-rs/bit-set"
documentation = "https://docs.rs/bit-set/"
keywords = ["data-structures", "bitset"]
readme = "README.md"
edition = "2015"

[dependencies]
serde = { version = "1.0", features = ["derive"], optional = true }
Expand All @@ -25,4 +26,3 @@ serde_json = "1.0"
default = ["std"]
std = ["bit-vec/std"]
serde = ["dep:serde", "bit-vec/serde"]
bench = []
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@

[crates.io shield]: https://img.shields.io/crates/v/bit-set?label=latest
[crates.io link]: https://crates.io/crates/bit-set
[docs.rs badge]: https://docs.rs/bit-set/badge.svg?version=0.6.0
[docs.rs link]: https://docs.rs/bit-set/0.6.0/bit_set/
[docs.rs badge]: https://docs.rs/bit-set/badge.svg?version=0.7.0
[docs.rs link]: https://docs.rs/bit-set/0.7.0/bit_set/
[github ci badge]: https://github.com/contain-rs/linked-hash-map/workflows/Rust/badge.svg?branch=master
[rustc 1.0+]: https://img.shields.io/badge/rustc-1.0%2B-blue.svg
[Rust 1.0]: https://blog.rust-lang.org/2015/05/15/Rust-1.0.html
[deps.rs status]: https://deps.rs/crate/bit-set/0.6.0/status.svg
[deps.rs link]: https://deps.rs/crate/bit-set/0.6.0
[deps.rs status]: https://deps.rs/crate/bit-set/0.7.0/status.svg
[deps.rs link]: https://deps.rs/crate/bit-set/0.7.0
[shields.io download count]: https://img.shields.io/crates/d/bit-set.svg

## Usage
Expand Down
6 changes: 3 additions & 3 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Version 0.7.0 (not yet released)
==========================
Version 0.7.0 (not yet released) (ZERO BREAKING CHANGES)
========================================================

<a id="v0.7.0"></a>

- `serde::Serialize`, `Deserialize` is derived under the `serde` optional feature
- `impl Display` is implemented
- `impl Debug` has different output
- `impl Debug` has different output (we do not promise stable `Debug` output)
- `fn truncate` is implemented
- `fn get_mut` is implemented
65 changes: 65 additions & 0 deletions benches/bench.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
// Copyright 2012-2024 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#![feature(test)]

extern crate bit_set;
extern crate bit_vec;
extern crate rand;
extern crate test;

use bit_set::BitSet;
use bit_vec::BitVec;
use rand::{rngs::ThreadRng, thread_rng, RngCore};

use test::{black_box, Bencher};

const BENCH_BITS: usize = 1 << 14;
const BITS: usize = 32;

fn rng() -> ThreadRng {
thread_rng()
}

#[bench]
fn bench_bit_vecset_small(b: &mut Bencher) {
let mut r = rng();
let mut bit_vec = BitSet::new();
b.iter(|| {
for _ in 0..100 {
bit_vec.insert((r.next_u32() as usize) % BITS);
}
black_box(&bit_vec);
});
}

#[bench]
fn bench_bit_vecset_big(b: &mut Bencher) {
let mut r = rng();
let mut bit_vec = BitSet::new();
b.iter(|| {
for _ in 0..100 {
bit_vec.insert((r.next_u32() as usize) % BENCH_BITS);
}
black_box(&bit_vec);
});
}

#[bench]
fn bench_bit_vecset_iter(b: &mut Bencher) {
let bit_vec = BitSet::from_bit_vec(BitVec::from_fn(BENCH_BITS, |idx| idx % 3 == 0));
b.iter(|| {
let mut sum = 0;
for idx in &bit_vec {
sum += idx as usize;
}
sum
})
}
61 changes: 2 additions & 59 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,14 @@
//! let bv = s.into_bit_vec();
//! assert!(bv[3]);
//! ```

#![doc(html_root_url = "https://docs.rs/bit-set/0.7.0")]
#![no_std]
#![cfg_attr(feature = "bench", feature(test))]

extern crate bit_vec;

#[cfg(feature = "serde")]
extern crate serde;

#[cfg(test)]
extern crate rand;
#[cfg(feature = "bench")]
extern crate test;

#[cfg(any(test, feature = "std"))]
extern crate std;

Expand Down Expand Up @@ -1684,55 +1679,3 @@ mod tests {
}
*/
}

#[cfg(feature = "bench")]
mod bench {
use super::BitSet;
use bit_vec::BitVec;
use rand::{rngs::ThreadRng, thread_rng, RngCore};

use test::{black_box, Bencher};

const BENCH_BITS: usize = 1 << 14;
const BITS: usize = 32;

fn rng() -> ThreadRng {
thread_rng()
}

#[bench]
fn bench_bit_vecset_small(b: &mut Bencher) {
let mut r = rng();
let mut bit_vec = BitSet::new();
b.iter(|| {
for _ in 0..100 {
bit_vec.insert((r.next_u32() as usize) % BITS);
}
black_box(&bit_vec);
});
}

#[bench]
fn bench_bit_vecset_big(b: &mut Bencher) {
let mut r = rng();
let mut bit_vec = BitSet::new();
b.iter(|| {
for _ in 0..100 {
bit_vec.insert((r.next_u32() as usize) % BENCH_BITS);
}
black_box(&bit_vec);
});
}

#[bench]
fn bench_bit_vecset_iter(b: &mut Bencher) {
let bit_vec = BitSet::from_bit_vec(BitVec::from_fn(BENCH_BITS, |idx| idx % 3 == 0));
b.iter(|| {
let mut sum = 0;
for idx in &bit_vec {
sum += idx as usize;
}
sum
})
}
}
Loading