60 lines
1.3 KiB
Markdown
60 lines
1.3 KiB
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function add
|
||
|
|
|
||
|
|
Add two or more values, `x + y`.
|
||
|
|
For matrices, the function is evaluated element wise.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.add(x, y)
|
||
|
|
math.add(x, y, z, ...)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`x` | number | BigNumber | Fraction | Complex | Unit | Array | Matrix | First value to add
|
||
|
|
`y` | number | BigNumber | Fraction | Complex | Unit | Array | Matrix | Second value to add
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
number | BigNumber | Fraction | Complex | Unit | Array | Matrix | Sum of `x` and `y`
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.add(2, 3) // returns number 5
|
||
|
|
math.add(2, 3, 4) // returns number 9
|
||
|
|
|
||
|
|
const a = math.complex(2, 3)
|
||
|
|
const b = math.complex(-4, 1)
|
||
|
|
math.add(a, b) // returns Complex -2 + 4i
|
||
|
|
|
||
|
|
math.add([1, 2, 3], 4) // returns Array [5, 6, 7]
|
||
|
|
|
||
|
|
const c = math.unit('5 cm')
|
||
|
|
const d = math.unit('2.1 mm')
|
||
|
|
math.add(c, d) // returns Unit 52.1 mm
|
||
|
|
|
||
|
|
math.add("2.3", "4") // returns number 6.3
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[subtract](subtract.md),
|
||
|
|
[sum](sum.md)
|