function mean
mean(x: number): number

Average value of array or matrix.

Computes the average (arithmetic mean) of values in an array or matrix. For arrays, returns a single mean value. For matrices, computes mean along specified dimension.

Examples

Simple array mean

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

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

Array with decimals

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

assertEquals(mean([1.5, 2.5, 3.5]), 2.5);

Matrix mean along rows

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

assertEquals(mean([[1, 2], [3, 4]]), [1.5, 3.5]);

Parameters

x: number

Input array, matrix, or number

Return Type

number

Mean values

Throws

When input is invalid

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

Average value of array or matrix.

Computes the average (arithmetic mean) of values in an array or matrix. For arrays, returns a single mean value. For matrices, computes mean along specified dimension.

Examples

Simple array mean

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

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

Array with decimals

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

assertEquals(mean([1.5, 2.5, 3.5]), 2.5);

Matrix mean along rows

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

assertEquals(mean([[1, 2], [3, 4]]), [1.5, 3.5]);

Parameters

x: array

Input array, matrix, or number

optional
dim: 0 | 1

Dimension along which to calculate (0: rows, 1: columns). Default is 0

Return Type

number

Mean values

Throws

When input is invalid

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

Average value of array or matrix.

Computes the average (arithmetic mean) of values in an array or matrix. For arrays, returns a single mean value. For matrices, computes mean along specified dimension.

Examples

Simple array mean

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

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

Array with decimals

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

assertEquals(mean([1.5, 2.5, 3.5]), 2.5);

Matrix mean along rows

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

assertEquals(mean([[1, 2], [3, 4]]), [1.5, 3.5]);

Parameters

Input array, matrix, or number

optional
dim: 0 | 1

Dimension along which to calculate (0: rows, 1: columns). Default is 0

Return Type

Mean values

Throws

When input is invalid

mean(
dim?: 0 | 1,
): number | array

Average value of array or matrix.

Computes the average (arithmetic mean) of values in an array or matrix. For arrays, returns a single mean value. For matrices, computes mean along specified dimension.

Examples

Simple array mean

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

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

Array with decimals

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

assertEquals(mean([1.5, 2.5, 3.5]), 2.5);

Matrix mean along rows

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

assertEquals(mean([[1, 2], [3, 4]]), [1.5, 3.5]);

Parameters

Input array, matrix, or number

optional
dim: 0 | 1

Dimension along which to calculate (0: rows, 1: columns). Default is 0

Return Type

number | array

Mean values

Throws

When input is invalid

Usage

import mean from "stats/mean.ts";