WIDTH_BUCKET_REGULAR()
All functions > MATH > WIDTH_BUCKET_REGULAR()
Returns the bucket number for a value in equally-spaced buckets within a range.
Signatures
Regular bins
Returns: Bucket number (1-based)
WIDTH_BUCKET_REGULAR(value: T, min_value: T, max_value: T, num_buckets: BIGINT) → BIGINT sql
| Parameter | Type | Required | Description |
|---|---|---|---|
value | T | Yes | Value to categorize |
min_value | T | Yes | Minimum of the range |
max_value | T | Yes | Maximum of the range |
num_buckets | BIGINT | Yes | Number of equal-width buckets |
With:
T: Floating-point type (FLOAT, DOUBLE)
Signature notes:
- Creates
num_bucketsequal-width intervals betweenmin_valueandmax_value - Returns 0 if value < min_value
- Returns
num_buckets + 1if value >= max_value - Returns NULL if value is NULL
Examples
FeatureQL
SELECT
f1 := WIDTH_BUCKET(-5E0, 0E0, 100E0, 10), -- Below range
f2 := WIDTH_BUCKET(15E0, 0E0, 100E0, 10), -- Bucket 2
f3 := WIDTH_BUCKET(55E0, 0E0, 100E0, 10), -- Bucket 6
f4 := WIDTH_BUCKET(105E0, 0E0, 100E0, 10) -- Above range
;Result
| f1 BIGINT | f2 BIGINT | f3 BIGINT | f4 BIGINT |
|---|---|---|---|
| 0 | 2 | 6 | 11 |
On this page