docs-v2/content/flux/v0/stdlib/universe/linearbins.md

1.8 KiB

title description menu weight introduced
linearBins() function `linearBins()` generates a list of linearly separated float values.
flux_v0_ref
name parent identifier
linearBins universe universe/linearBins
101 0.19.0

linearBins() generates a list of linearly separated float values.

Use linearBins() to generate bin bounds for histogram().

Function type signature
(count: int, start: float, width: float, ?infinity: bool) => [float]

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

start

({{< req >}}) First value to return in the list.

width

({{< req >}}) Distance between subsequent values.

count

({{< req >}}) Number of values to return.

infinity

Include an infinite value at the end of the list. Default is true.

Examples

Generate a list of linearly increasing values

linearBins(
    start: 0.0,
    width: 10.0,
    count: 10,
)// Returns [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, +Inf]