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

range(str [, includeEnd])               // Create a range from a string,
                                             // where the string contains the
                                             // start, optional step, and end,
                                             // separated by a colon.
range(start, end [, includeEnd])        // Create a range with start and
                                             // end and a step size of 1.
range(start, end, step [, includeEnd])  // Create a range with start, step,
                                             // and end.

Where

  • str: string A string 'start:end' or 'start:step:end'
  • start: {number | BigNumber} Start of the range
  • end: number | BigNumber End of the range, excluded by default, included when parameter includeEnd=true
  • step: number | BigNumber Step size. Default value is 1.
  • includeEnd: boolean Option 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

Examples

range(2, 6);        // [2, 3, 4, 5]
range(2, -3, -1);   // [2, 1, 0, -1, -2]
range('2:1:6');     // [2, 3, 4, 5]
range(2, 6, true);  // [2, 3, 4, 5, 6]

See also

ones, zeros, size, subset