---
layout: default
---

<a name="Range"></a>
<h2 id="range">Range <a href="#range" title="Permalink">#</a></h2>
* [new Range(start, end, [step])](#new_Range_new)
* _instance_
	* [.size()](#Range+size) ⇒ <code>Array.&lt;number&gt;</code>
	* [.min()](#Range+min) ⇒ <code>number</code> &#124; <code>undefined</code>
	* [.max()](#Range+max) ⇒ <code>number</code> &#124; <code>undefined</code>
	* [.forEach(callback)](#Range+forEach)
	* [.map(callback)](#Range+map) ⇒ <code>Array</code>
	* [.toArray()](#Range+toArray) ⇒ <code>Array</code>
	* [.valueOf()](#Range+valueOf) ⇒ <code>Array</code>
	* [.format([options])](#Range+format) ⇒ <code>string</code>
	* [.toString()](#Range+toString) ⇒ <code>string</code>
	* [.toJSON()](#Range+toJSON) ⇒ <code>Object</code>
* _static_
	* [.parse(str)](#Range.parse) ⇒ <code>[Range](#Range)</code> &#124; <code>null</code>
	* [.fromJSON(json)](#Range.fromJSON) ⇒ <code>[Range](#Range)</code>

<a name="new_Range_new"></a>
<h3 id="new-rangestart-end-step">new Range(start, end, [step]) <a href="#new-rangestart-end-step" title="Permalink">#</a></h3>
Create a range. A range has a start, step, and end, and contains functions
to iterate over the range.

A range can be constructed as:
    var range = new Range(start, end);
    var range = new Range(start, end, step);

To get the result of the range:
    range.forEach(function (x) {
        console.log(x);
    });
    range.map(function (x) {
        return math.sin(x);
    });
    range.toArray();

Example usage:
    var c = new Range(2, 6);         // 2:1:5
    c.toArray();                     // [2, 3, 4, 5]
    var d = new Range(2, -3, -1);    // 2:-1:-2
    d.toArray();                     // [2, 1, 0, -1, -2]


| Param | Type | Description |
| --- | --- | --- |
| start | <code>number</code> | included lower bound |
| end | <code>number</code> | excluded upper bound |
| [step] | <code>number</code> | step size, default value is 1 |

<a name="Range+size"></a>
<h3 id="rangesize--codearrayltnumbergtcode">range.size() ⇒ <code>Array.&lt;number&gt;</code> <a href="#rangesize--codearrayltnumbergtcode" title="Permalink">#</a></h3>
Retrieve the size of the range.
Returns an array containing one number, the number of elements in the range.

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>Array.&lt;number&gt;</code> - size  
<a name="Range+min"></a>
<h3 id="rangemin--codenumbercode-124-codeundefinedcode">range.min() ⇒ <code>number</code> &#124; <code>undefined</code> <a href="#rangemin--codenumbercode-124-codeundefinedcode" title="Permalink">#</a></h3>
Calculate the minimum value in the range

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>number</code> &#124; <code>undefined</code> - min  
<a name="Range+max"></a>
<h3 id="rangemax--codenumbercode-124-codeundefinedcode">range.max() ⇒ <code>number</code> &#124; <code>undefined</code> <a href="#rangemax--codenumbercode-124-codeundefinedcode" title="Permalink">#</a></h3>
Calculate the maximum value in the range

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>number</code> &#124; <code>undefined</code> - max  
<a name="Range+forEach"></a>
<h3 id="rangeforeachcallback">range.forEach(callback) <a href="#rangeforeachcallback" title="Permalink">#</a></h3>
Execute a callback function for each value in the range.

**Kind**: instance method of <code>[Range](#Range)</code>  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | The callback method is invoked with three                              parameters: the value of the element, the index                              of the element, and the Range being traversed. |

<a name="Range+map"></a>
<h3 id="rangemapcallback--codearraycode">range.map(callback) ⇒ <code>Array</code> <a href="#rangemapcallback--codearraycode" title="Permalink">#</a></h3>
Execute a callback function for each value in the Range, and return the
results as an array

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>Array</code> - array  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | The callback method is invoked with three                              parameters: the value of the element, the index                              of the element, and the Matrix being traversed. |

<a name="Range+toArray"></a>
<h3 id="rangetoarray--codearraycode">range.toArray() ⇒ <code>Array</code> <a href="#rangetoarray--codearraycode" title="Permalink">#</a></h3>
Create an Array with a copy of the Ranges data

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>Array</code> - array  
<a name="Range+valueOf"></a>
<h3 id="rangevalueof--codearraycode">range.valueOf() ⇒ <code>Array</code> <a href="#rangevalueof--codearraycode" title="Permalink">#</a></h3>
Get the primitive value of the Range, a one dimensional array

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>Array</code> - array  
<a name="Range+format"></a>
<h3 id="rangeformatoptions--codestringcode">range.format([options]) ⇒ <code>string</code> <a href="#rangeformatoptions--codestringcode" title="Permalink">#</a></h3>
Get a string representation of the range, with optional formatting options.
Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>string</code> - str  

| Param | Type | Description |
| --- | --- | --- |
| [options] | <code>Object</code> &#124; <code>number</code> &#124; <code>function</code> | Formatting options. See                                                lib/utils/number:format for a                                                description of the available                                                options. |

<a name="Range+toString"></a>
<h3 id="rangetostring--codestringcode">range.toString() ⇒ <code>string</code> <a href="#rangetostring--codestringcode" title="Permalink">#</a></h3>
Get a string representation of the range.

**Kind**: instance method of <code>[Range](#Range)</code>  
<a name="Range+toJSON"></a>
<h3 id="rangetojson--codeobjectcode">range.toJSON() ⇒ <code>Object</code> <a href="#rangetojson--codeobjectcode" title="Permalink">#</a></h3>
Get a JSON representation of the range

**Kind**: instance method of <code>[Range](#Range)</code>  
**Returns**: <code>Object</code> - Returns a JSON object structured as:
                  `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`  
<a name="Range.parse"></a>
<h3 id="rangeparsestr--coderangerangecode-124-codenullcode">Range.parse(str) ⇒ <code>[Range](#Range)</code> &#124; <code>null</code> <a href="#rangeparsestr--coderangerangecode-124-codenullcode" title="Permalink">#</a></h3>
Parse a string into a range,
The string contains the start, optional step, and end, separated by a colon.
If the string does not contain a valid range, null is returned.
For example str='0:2:11'.

**Kind**: static method of <code>[Range](#Range)</code>  
**Returns**: <code>[Range](#Range)</code> &#124; <code>null</code> - range  

| Param | Type |
| --- | --- |
| str | <code>string</code> | 

<a name="Range.fromJSON"></a>
<h3 id="rangefromjsonjson--coderangerangecode">Range.fromJSON(json) ⇒ <code>[Range](#Range)</code> <a href="#rangefromjsonjson--coderangerangecode" title="Permalink">#</a></h3>
Instantiate a Range from a JSON object

**Kind**: static method of <code>[Range](#Range)</code>  

| Param | Type | Description |
| --- | --- | --- |
| json | <code>Object</code> | A JSON object structured as:                      `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}` |