From eed8d1aee5651567bae78ccaaceeb4be6971cb02 Mon Sep 17 00:00:00 2001 From: Takumasa Ochi <4468155+aeroastro@users.noreply.github.com> Date: Wed, 22 Nov 2017 02:06:26 +0900 Subject: [PATCH] [DOC] Fix mathematical representation on interval (range) (#27450) --- .../aggregations/bucket/histogram-aggregation.asciidoc | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/reference/aggregations/bucket/histogram-aggregation.asciidoc b/docs/reference/aggregations/bucket/histogram-aggregation.asciidoc index 380d06258da..2576662b6d1 100644 --- a/docs/reference/aggregations/bucket/histogram-aggregation.asciidoc +++ b/docs/reference/aggregations/bucket/histogram-aggregation.asciidoc @@ -14,7 +14,8 @@ To make this more formal, here is the rounding function that is used: bucket_key = Math.floor((value - offset) / interval) * interval + offset -------------------------------------------------- -The `interval` must be a positive decimal, while the `offset` must be a decimal in `[0, interval[`. +The `interval` must be a positive decimal, while the `offset` must be a decimal in `[0, interval)` +(a decimal greater than or equal to `0` and less than `interval`) The following snippet "buckets" the products based on their `price` by interval of `50`: @@ -73,7 +74,7 @@ And the following may be the response: ==== Minimum document count -The response above show that no documents has a price that falls within the range of `[100 - 150)`. By default the +The response above show that no documents has a price that falls within the range of `[100, 150)`. By default the response will fill gaps in the histogram with empty buckets. It is possible change that and request buckets with a higher minimum count thanks to the `min_doc_count` setting: @@ -185,10 +186,10 @@ the `order` setting. Supports the same `order` functionality as the <<search-agg ==== Offset By default the bucket keys start with 0 and then continue in even spaced steps of `interval`, e.g. if the interval is 10 the first buckets -(assuming there is data inside them) will be [0 - 9], [10-19], [20-29]. The bucket boundaries can be shifted by using the `offset` option. +(assuming there is data inside them) will be `[0, 10)`, `[10, 20)`, `[20, 30)`. The bucket boundaries can be shifted by using the `offset` option. This can be best illustrated with an example. If there are 10 documents with values ranging from 5 to 14, using interval `10` will result in -two buckets with 5 documents each. If an additional offset `5` is used, there will be only one single bucket [5-14] containing all the 10 +two buckets with 5 documents each. If an additional offset `5` is used, there will be only one single bucket `[5, 15)` containing all the 10 documents. ==== Response Format