# array
# array
A set of array utilities.
- array
- ~addValue(a, f) ⇒
Array
- ~addArray(a, f) ⇒
Array
- ~add(a) ⇒
Array
- ~fromxyz(object)
- ~first(a) ⇒
Number
- ~last(a) ⇒
Number
- ~min(a) ⇒
Number
- ~range(a, b) ⇒
Array
- ~addValue(a, f) ⇒
# array~addValue(a, f) ⇒ Array
Adds a value to each element of an array of numbers.
Kind: inner method of array
Returns: Array
- A new array with the values added together.
Param | Type | Description |
---|---|---|
a | Array | Array of numbers. |
f | Number | A value to add to each element of the original array. |
# array~addArray(a, f) ⇒ Array
Adds two arrays together. The shorter array must be the first argument.
Kind: inner method of array
Returns: Array
- A new array with the two values added together.
Param | Type | Description |
---|---|---|
a | Array | An array of numbers. |
f | Array | Another array of numbers, if |
# array~add(a) ⇒ Array
Adds a value or array to another array.
Kind: inner method of array
Returns: Array
- A new array with the two values added together.
Param | Type | Description |
---|---|---|
a | Array | An array of numbers . |
# array~fromxyz(object)
Converts an object with x, y, and z properties into an array, or an array if passed an array.
Kind: inner method of array
Param | Type |
---|---|
object | Object | Array |
# array~first(a) ⇒ Number
Returns the first value of an array.
Kind: inner method of array
Returns: Number
- The value of the first element of the array or undefined.
Param | Type | Description |
---|---|---|
a | Array | An array of numbers. |
# array~last(a) ⇒ Number
Kind: inner method of array
Returns: Number
- The value of the last element of the array or undefined.
Param | Type | Description |
---|---|---|
a | Array | An array of numbers. |
# array~min(a) ⇒ Number
Finds the minimum value of an array.
Kind: inner method of array
Returns: Number
- The minimum value in an array of numbers.
Param | Type | Description |
---|---|---|
a | Array | An array of numbers. |
# array~range(a, b) ⇒ Array
Creates a array of numbers given the start and end points.
Kind: inner method of array
Returns: Array
- An array of values from a
to b
.
Param | Type | Description |
---|---|---|
a | Number | The starting value. |
b | Number | The ending value. |