61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function multiply
|
||
|
|
|
||
|
|
Multiply two or more values, `x * y`.
|
||
|
|
For matrices, the matrix product is calculated.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.multiply(x, y)
|
||
|
|
math.multiply(x, y, z, ...)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`x` | number | BigNumber | Fraction | Complex | Unit | Array | Matrix | First value to multiply
|
||
|
|
`y` | number | BigNumber | Fraction | Complex | Unit | Array | Matrix | Second value to multiply
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
number | BigNumber | Fraction | Complex | Unit | Array | Matrix | Multiplication of `x` and `y`
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.multiply(4, 5.2) // returns number 20.8
|
||
|
|
math.multiply(2, 3, 4) // returns number 24
|
||
|
|
|
||
|
|
const a = math.complex(2, 3)
|
||
|
|
const b = math.complex(4, 1)
|
||
|
|
math.multiply(a, b) // returns Complex 5 + 14i
|
||
|
|
|
||
|
|
const c = [[1, 2], [4, 3]]
|
||
|
|
const d = [[1, 2, 3], [3, -4, 7]]
|
||
|
|
math.multiply(c, d) // returns Array [[7, -6, 17], [13, -4, 33]]
|
||
|
|
|
||
|
|
const e = math.unit('2.1 km')
|
||
|
|
math.multiply(3, e) // returns Unit 6.3 km
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[divide](divide.md),
|
||
|
|
[prod](prod.md),
|
||
|
|
[cross](cross.md),
|
||
|
|
[dot](dot.md)
|