mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
---
|
|
layout: default
|
|
---
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
|
|
|
<h1 id="function-square">Function square <a href="#function-square" title="Permalink">#</a></h1>
|
|
|
|
Compute the square of a value, `x * x`.
|
|
To avoid confusion with multiplying a square matrix by itself,
|
|
this function does not apply to matrices. If you wish to square
|
|
every element of a matrix, see the examples.
|
|
|
|
|
|
<h2 id="syntax">Syntax <a href="#syntax" title="Permalink">#</a></h2>
|
|
|
|
```js
|
|
math.square(x)
|
|
```
|
|
|
|
<h3 id="parameters">Parameters <a href="#parameters" title="Permalink">#</a></h3>
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`x` | number | BigNumber | Fraction | Complex | Unit | Number for which to calculate the square
|
|
|
|
<h3 id="returns">Returns <a href="#returns" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
number | BigNumber | Fraction | Complex | Unit | Squared value
|
|
|
|
|
|
<h3 id="throws">Throws <a href="#throws" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
|
|
|
|
<h2 id="examples">Examples <a href="#examples" title="Permalink">#</a></h2>
|
|
|
|
```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.map([1, 2, 3, 4], math.square) // returns Array [1, 4, 9, 16]
|
|
```
|
|
|
|
|
|
<h2 id="see-also">See also <a href="#see-also" title="Permalink">#</a></h2>
|
|
|
|
[multiply](multiply.html),
|
|
[cube](cube.html),
|
|
[sqrt](sqrt.html),
|
|
[pow](pow.html)
|