51 lines
974 B
Markdown
51 lines
974 B
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function sqrt
|
||
|
|
|
||
|
|
Calculate the square root of a value.
|
||
|
|
|
||
|
|
For matrices, the function is evaluated element wise.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.sqrt(x)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`x` | number | BigNumber | Complex | Array | Matrix | Unit | Value for which to calculate the square root.
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
number | BigNumber | Complex | Array | Matrix | Unit | Returns the square root of `x`
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.sqrt(25) // returns 5
|
||
|
|
math.square(5) // returns 25
|
||
|
|
math.sqrt(-4) // returns Complex 2i
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[square](square.md),
|
||
|
|
[multiply](multiply.md),
|
||
|
|
[cube](cube.md),
|
||
|
|
[cbrt](cbrt.md),
|
||
|
|
[sqrtm](sqrtm.md)
|