mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
# 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
|
|
|
|
```js
|
|
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.
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`args` | ...* | Parameters describing the ranges `start`, `end`, and optional `step`.
|
|
|
|
### Returns
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
Array | Matrix | range
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
var math = mathjs();
|
|
|
|
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]
|
|
```
|
|
|
|
|
|
## See also
|
|
|
|
[ones](ones.md),
|
|
[zeros](zeros.md),
|
|
[size](size.md),
|
|
[subset](subset.md)
|
|
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|