55 lines
995 B
Markdown
55 lines
995 B
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
||
|
# Function lcm
|
||
|
|
||
|
Calculate the least common multiple for two or more values or arrays.
|
||
|
|
||
|
lcm is defined as:
|
||
|
|
||
|
lcm(a, b) = abs(a * b) / gcd(a, b)
|
||
|
|
||
|
For matrices, the function is evaluated element wise.
|
||
|
|
||
|
|
||
|
## Syntax
|
||
|
|
||
|
```js
|
||
|
math.lcm(a, b)
|
||
|
math.lcm(a, b, c, ...)
|
||
|
```
|
||
|
|
||
|
### Parameters
|
||
|
|
||
|
Parameter | Type | Description
|
||
|
--------- | ---- | -----------
|
||
|
`args` | ... number | BigNumber | Array | Matrix | Two or more integer numbers
|
||
|
|
||
|
### Returns
|
||
|
|
||
|
Type | Description
|
||
|
---- | -----------
|
||
|
number | BigNumber | Array | Matrix | The least common multiple
|
||
|
|
||
|
|
||
|
### Throws
|
||
|
|
||
|
Type | Description
|
||
|
---- | -----------
|
||
|
|
||
|
|
||
|
## Examples
|
||
|
|
||
|
```js
|
||
|
math.lcm(4, 6) // returns 12
|
||
|
math.lcm(6, 21) // returns 42
|
||
|
math.lcm(6, 21, 5) // returns 210
|
||
|
|
||
|
math.lcm([4, 6], [6, 21]) // returns [12, 42]
|
||
|
```
|
||
|
|
||
|
|
||
|
## See also
|
||
|
|
||
|
[gcd](gcd.md),
|
||
|
[xgcd](xgcd.md)
|