52 lines
1.0 KiB
Markdown
52 lines
1.0 KiB
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function square
|
||
|
|
|
||
|
|
Compute the square of a value, `x * x`.
|
||
|
|
For matrices, the function is evaluated element wise.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.square(x)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`x` | number | BigNumber | Fraction | Complex | Array | Matrix | Unit | Number for which to calculate the square
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
number | BigNumber | Fraction | Complex | Array | Matrix | Unit | Squared value
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.square(2) // returns number 4
|
||
|
|
math.square(3) // returns number 9
|
||
|
|
math.pow(3, 2) // returns number 9
|
||
|
|
math.multiply(3, 3) // returns number 9
|
||
|
|
|
||
|
|
math.square([1, 2, 3, 4]) // returns Array [1, 4, 9, 16]
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[multiply](multiply.md),
|
||
|
|
[cube](cube.md),
|
||
|
|
[sqrt](sqrt.md),
|
||
|
|
[pow](pow.md)
|