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