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.

Sign up for GitHub

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

[DOC] Fix mathematical representation on interval (range) #27450

Merged
merged 3 commits into from
Nov 21, 2017
Merged

[DOC] Fix mathematical representation on interval (range) #27450

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40fe786
Fix mathematical representation on interval (range)
aeroastro Nov 20, 2017
381a324
Fix document according to review
aeroastro Nov 20, 2017
0590e6f
Merge remote-tracking branch 'elastic/master' into feature/doc-fix
aeroastro Nov 20, 2017
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
9 changes: 5 additions & 4 deletions docs/reference/aggregations/bucket/histogram-aggregation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down