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

Quantiles of a sample.

Calculates the p-th quantile of values in an array or matrix. Quantiles are values that divide the data into equal probability intervals.

Examples

Median (0.5 quantile)

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

assertEquals(quantile([1, 2, 3, 4, 5], 0.5), 3);

First quartile

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

assertEquals(quantile([1, 2, 3, 4], 0.25), 1.5);

Matrix quantiles

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

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

Parameters

x: array

Input array or matrix

p: number

Quantile value in range [0,1] (0.5 = median, 0.25 = first quartile)

optional
dim: 0 | 1

Dimension along which to compute quantiles. Default is 0

Return Type

number

Quantile values

Throws

When quantile is outside valid range [0,1]

quantile(
x: matrix,
p: number,
dim?: 0 | 1,
): array

Quantiles of a sample.

Calculates the p-th quantile of values in an array or matrix. Quantiles are values that divide the data into equal probability intervals.

Examples

Median (0.5 quantile)

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

assertEquals(quantile([1, 2, 3, 4, 5], 0.5), 3);

First quartile

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

assertEquals(quantile([1, 2, 3, 4], 0.25), 1.5);

Matrix quantiles

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

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

Parameters

Input array or matrix

p: number

Quantile value in range [0,1] (0.5 = median, 0.25 = first quartile)

optional
dim: 0 | 1

Dimension along which to compute quantiles. Default is 0

Return Type

Quantile values

Throws

When quantile is outside valid range [0,1]

quantile(
x: array,
p: number,
dim: 0 | 1,
): number

Quantiles of a sample.

Calculates the p-th quantile of values in an array or matrix. Quantiles are values that divide the data into equal probability intervals.

Examples

Median (0.5 quantile)

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

assertEquals(quantile([1, 2, 3, 4, 5], 0.5), 3);

First quartile

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

assertEquals(quantile([1, 2, 3, 4], 0.25), 1.5);

Matrix quantiles

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

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

Parameters

x: array

Input array or matrix

p: number

Quantile value in range [0,1] (0.5 = median, 0.25 = first quartile)

dim: 0 | 1

Dimension along which to compute quantiles. Default is 0

Return Type

number

Quantile values

Throws

When quantile is outside valid range [0,1]

quantile(
x: matrix,
p: number,
dim: 0 | 1,
): array

Quantiles of a sample.

Calculates the p-th quantile of values in an array or matrix. Quantiles are values that divide the data into equal probability intervals.

Examples

Median (0.5 quantile)

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

assertEquals(quantile([1, 2, 3, 4, 5], 0.5), 3);

First quartile

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

assertEquals(quantile([1, 2, 3, 4], 0.25), 1.5);

Matrix quantiles

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

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

Parameters

Input array or matrix

p: number

Quantile value in range [0,1] (0.5 = median, 0.25 = first quartile)

dim: 0 | 1

Dimension along which to compute quantiles. Default is 0

Return Type

Quantile values

Throws

When quantile is outside valid range [0,1]

Usage

import quantile from "stats/quantile.ts";