UNPKG

1.24 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function max
4
5Compute the maximum value of a matrix or a list with values.
6In case of a multi dimensional array, the maximum of the flattened array
7will be calculated. When `dim` is provided, the maximum over the selected
8dimension will be calculated. Parameter `dim` is zero-based.
9
10
11## Syntax
12
13```js
14math.max(a, b, c, ...)
15math.max(A)
16math.max(A, dim)
17```
18
19### Parameters
20
21Parameter | Type | Description
22--------- | ---- | -----------
23`args` | ... * | A single matrix or or multiple scalar values
24
25### Returns
26
27Type | Description
28---- | -----------
29* | The maximum value
30
31
32## Examples
33
34```js
35math.max(2, 1, 4, 3) // returns 4
36math.max([2, 1, 4, 3]) // returns 4
37
38// maximum over a specified dimension (zero-based)
39math.max([[2, 5], [4, 3], [1, 7]], 0) // returns [4, 7]
40math.max([[2, 5], [4, 3]], [1, 7], 1) // returns [5, 4, 7]
41
42math.max(2.7, 7.1, -4.5, 2.0, 4.1) // returns 7.1
43math.min(2.7, 7.1, -4.5, 2.0, 4.1) // returns -4.5
44```
45
46
47## See also
48
49[mean](mean.md),
50[median](median.md),
51[min](min.md),
52[prod](prod.md),
53[std](std.md),
54[sum](sum.md),
55[variance](variance.md)