mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-18 14:59:29 +00:00
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
# Function norm
|
|
|
|
Calculate the norm of a number, vector or matrix.
|
|
|
|
The second parameter p is optional. If not provided, it defaults to 2.
|
|
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
math.norm(x)
|
|
math.norm(x, p)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`x` | Number | BigNumber | Complex | Boolean | Array | Matrix | null | Value for which to calculate the norm
|
|
`p` | Number | String | Vector space. Supported numbers include Infinity and -Infinity. Supported strings are: 'inf', '-inf', and 'fro' (The Frobenius norm) Default value: 2.
|
|
|
|
### Returns
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
Number | the p-norm
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
math.abs(-3.5); // returns 3.5
|
|
math.norm(-3.5); // returns 3.5
|
|
|
|
math.norm(math.complex(3, -4)); // returns 5
|
|
|
|
math.norm([1, 2, -3], Infinity); // returns 3
|
|
math.norm([1, 2, -3], -Infinity); // returns 1
|
|
|
|
math.norm([3, 4], 2); // returns 5
|
|
|
|
math.norm([[1, 2], [3, 4]], 1) // returns 6
|
|
math.norm([[1, 2], [3, 4]], 'inf'); // returns 7
|
|
math.norm([[1, 2], [3, 4]], 'fro'); // returns 5.477225575051661
|
|
```
|
|
|
|
|
|
## See also
|
|
|
|
[abs](abs.md)
|
|
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|