mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-18 14:59:29 +00:00
41 lines
830 B
Markdown
41 lines
830 B
Markdown
# Function map
|
|
|
|
Create a new matrix or array with the results of the callback function executed on
|
|
each entry of the matrix/array.
|
|
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
math.map(x, callback)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`x` | Matrix | Array | The matrix to iterate on.
|
|
`callback` | Function | The callback method is invoked with three parameters: the value of the element, the index of the element, and the matrix being traversed.
|
|
|
|
### Returns
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
Matrix | array | Transformed map of x
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
var math = mathjs();
|
|
|
|
math.map([1, 2, 3], function(value) {
|
|
return value * value;
|
|
}); // returns [1, 4, 9]
|
|
```
|
|
|
|
|
|
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|