function min
min(
x: array,
dim?: 0 | 1,
): number

Smallest element in array.

Computes the smallest element in an array or matrix. For arrays, returns a single value. For matrices, returns the minimum along the specified dimension.

Examples

Simple array minimum

import { assertEquals } from "jsr:@std/assert";

assertEquals(min([3, 1, 2]), 1);

Array with negative values

import { assertEquals } from "jsr:@std/assert";

assertEquals(min([5, -1, 10]), -1);

Matrix minimum along rows

import { assertEquals } from "jsr:@std/assert";

assertEquals(min([[1, 2], [3, 4]]), [1, 3]);

Parameters

x: array

Input array or matrix

optional
dim: 0 | 1

Dimension along which to compute minimum. Default is 0

Return Type

number

Minimum values

Throws

When input is invalid

min(
x: matrix,
dim?: 0 | 1,
): array

Smallest element in array.

Computes the smallest element in an array or matrix. For arrays, returns a single value. For matrices, returns the minimum along the specified dimension.

Examples

Simple array minimum

import { assertEquals } from "jsr:@std/assert";

assertEquals(min([3, 1, 2]), 1);

Array with negative values

import { assertEquals } from "jsr:@std/assert";

assertEquals(min([5, -1, 10]), -1);

Matrix minimum along rows

import { assertEquals } from "jsr:@std/assert";

assertEquals(min([[1, 2], [3, 4]]), [1, 3]);

Parameters

Input array or matrix

optional
dim: 0 | 1

Dimension along which to compute minimum. Default is 0

Return Type

Minimum values

Throws

When input is invalid

Usage

import min from "stats/min.ts";