Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.13 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.13 KB

bytecount

Counting bytes really fast

Build Status Windows build status Current Version License: Apache 2.0/MIT

This uses the "hyperscreamingcount" algorithm by Joshua Landau to count bytes faster than anything else. The newlinebench repository has further benchmarks.

To use bytecount in your crate, if you have cargo-edit, just type cargo add bytecount in a terminal with the crate root as the current path. Otherwise you can manually edit your Cargo.toml to add bytecount = 0.1.4 to your [dependencies] section.

In your crate root (lib.rs or main.rs, depending on if you are writing a library or application), add extern crate bytecount;. Now you can simply use bytecount::count as follows:

extern crate bytecount;

fn main() {
    let mytext = "some potentially large text, perhaps read from disk?";
    let spaces = bytecount::count(mytext.as_bytes(), b' ');
    ..
}

bytecount makes use of features in modern CPUs to speed up counting considerably. To use these features, add the following to your Cargo.toml:

[features]
simd-accel = ["bytecount/simd-accel"]

Now your users can compile with SIMD support, regardless of processor type, using:

RUSTFLAGS="-C target-cpu=native" cargo build --release --features simd-accel

The scalar algorithm is explained in depth here.

Note that for very short slices, the data parallelism will likely not win much performance gains. In those cases, a naive count with a 32-bit counter may be a superior solution, unless counting really large byte slices.

License

Licensed under either of at your discretion: