Skip to content

Commit

Permalink
New home in HdrHistogram org
Browse files Browse the repository at this point in the history
Fixes #60.
  • Loading branch information
jonhoo committed Feb 15, 2018
1 parent de132f5 commit 271205b
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
12 changes: 6 additions & 6 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "hdrsample"
version = "6.0.1"
name = "hdrhistogram"
version = "6.0.2"

description = "A port of HdrHistogram to Rust"
readme = "README.md"
Expand All @@ -10,17 +10,17 @@ authors = [
"Marshall Pierce <[email protected]>",
]

documentation = "https://docs.rs/hdrsample"
homepage = "https://github.com/jonhoo/hdrsample"
repository = "https://github.com/jonhoo/hdrsample.git"
documentation = "https://docs.rs/hdrhistogram"
homepage = "https://github.com/HdrHistogram/HdrHistogram_rust"
repository = "https://github.com/HdrHistogram/HdrHistogram_rust.git"

keywords = ["sampling", "statistics", "analytics"]
categories = ["data-structures", "development-tools::profiling"]

license = "MIT/Apache-2.0"

[badges]
travis-ci = { repository = "jonhoo/hdrsample" }
travis-ci = { repository = "HdrHistogram/HdrHistogram_rust" }

[features]
bench_private = [] # for enabling nightly-only feature(test) on the main crate to allow benchmarking private code
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# hdrsample
# HdrHistogram_rust

[![Crates.io](https://img.shields.io/crates/v/hdrsample.svg)](https://crates.io/crates/hdrsample)
[![Documentation](https://docs.rs/hdrsample/badge.svg)](https://docs.rs/hdrsample/)
Expand Down Expand Up @@ -42,6 +42,10 @@ range and precision chosen. The amount of work involved in recording a sample is
directly computes storage index locations such that no iteration or searching is ever involved
in recording data values.

If you are looking for FFI bindings to
[`HdrHistogram_c`](https://github.com/HdrHistogram/HdrHistogram_c), you want the
[`hdrhistogram_c`](https://crates.io/crates/hdrhistogram_c) crate instead.

## Interacting with the library

HdrSample's API follows that of the original HdrHistogram Java implementation, with some
Expand Down Expand Up @@ -100,7 +104,7 @@ as the total number of recorded samples, or the value at a given quantile:
use hdrsample::Histogram;
let hist = Histogram::<u64>::new(2).unwrap();
// ...
println!("# of samples: {}", hist.count());
println!("# of samples: {}", hist.len());
println!("99.9'th percentile: {}", hist.value_at_quantile(0.999));
```

Expand All @@ -115,7 +119,7 @@ let hist = Histogram::<u64>::new(2).unwrap();
// ...
for v in hist.iter_recorded() {
println!("{}'th percentile of data is {} with {} samples",
v.percentile(), v.value(), v.count_at_value());
v.percentile(), v.value_iterated_to(), v.count_at_value());
}
```

Expand Down Expand Up @@ -176,7 +180,6 @@ not (yet) been implemented:
- `DoubleHistogram`.
- The `Recorder` feature of HdrHistogram.
- Value shifting ("normalization").
- Timestamps and tags.
- Textual output methods. These seem almost orthogonal to HdrSample, though it might be
convenient if we implemented some relevant traits (CSV, JSON, and possibly simple
`fmt::Display`).
Expand Down
2 changes: 1 addition & 1 deletion README.tpl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# {{crate}}
# HdrHistogram_rust

[![Crates.io](https://img.shields.io/crates/v/hdrsample.svg)](https://crates.io/crates/hdrsample)
[![Documentation](https://docs.rs/hdrsample/badge.svg)](https://docs.rs/hdrsample/)
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
//! directly computes storage index locations such that no iteration or searching is ever involved
//! in recording data values.
//!
//! If you are looking for FFI bindings to
//! [`HdrHistogram_c`](https://github.com/HdrHistogram/HdrHistogram_c), you want the
//! [`hdrhistogram_c`](https://crates.io/crates/hdrhistogram_c) crate instead.
//!
//! # Interacting with the library
//!
//! HdrSample's API follows that of the original HdrHistogram Java implementation, with some
Expand Down

0 comments on commit 271205b

Please sign in to comment.