rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-01-06 01:02:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update src/aggregation/bucket/histogram/histogram.rs

Browse Source 
Co-authored-by: Paul Masurel <paul@quickwit.io>
This commit is contained in:
PSeitz
2022-03-18 04:55:25 +01:00
committed by GitHub
parent f619658e2c
commit c0f524e1a3
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/aggregation/bucket/histogram/histogram.rs
View File

@@ -74,7 +74,9 @@ pub struct HistogramAggregation {
/// The interval to chunk your data range. The buckets span ranges of [0..interval).
/// Must be a positive value.
pub interval: f64,
/// Intervals intersect at 0 by default, offset can move the interval.
/// Intervals implicitely defines an absolute grid of buckets `[interval * k, interval * (k + 1))`.
///
/// Offset makes it possible to shift this grid into `[offset + interval * k, offset + interval * (k + 1))
/// Offset has to be in the range [0, interval).
///
/// As an example. If there are two documents with value 8 and 12 and interval 10.0, they would