mode - stats/mode.ts - Ubique documentation

function mode



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

Most frequent value in an array.

Finds the most frequently occurring value in an array or matrix. In case of ties, returns the first value that achieves the maximum frequency.

Examples

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

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

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

assertEquals(mode([1, 1, 2, 2, 2]), 2);

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

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



x: array

Input array or matrix

optional



dim: 0 | 1

Dimension along which to compute mode. Default is 0

number

Most frequent values

When input is invalid



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