Function range #
Create an array from a range.
By default, the range end is excluded. This can be customized by providing
an extra parameter includeEnd.
Syntax #
math.range(str [, includeEnd]) // Create a range from a string,
// where the string contains the
// start, optional step, and end,
// separated by a colon.
math.range(start, end [, includeEnd]) // Create a range with start and
// end and a step size of 1.
math.range(start, end, step [, includeEnd]) // Create a range with start, step,
// and end.
Where #
str: stringA string ‘start:end’ or ‘start:step:end’start: {number | BigNumber | Unit}Start of the rangeend: number | BigNumber | UnitEnd of the range, excluded by default, included when parameter includeEnd=truestep: number | BigNumber | UnitStep size. Default value is 1.includeEnd: booleanOption to specify whether to include the end or not. False by default.
Parameters #
| Parameter | Type | Description |
|---|---|---|
args |
* | Parameters describing the ranges start, end, and optional step. |
Returns #
| Type | Description |
|---|---|
| Array | Matrix | range |
Throws #
Type | Description —- | ———–
Examples #
math.range(2, 6) // [2, 3, 4, 5]
math.range(2, -3, -1) // [2, 1, 0, -1, -2]
math.range('2:1:6') // [2, 3, 4, 5]
math.range(2, 6, true) // [2, 3, 4, 5, 6]
math.range(math.unit(2, 'm'), math.unit(-3, 'm'), math.unit(-1, 'm')) // [2 m, 1 m, 0 m , -1 m, -2 m]
