Skip to content

Statistics

The rite.numeric.statistics submodule provides basic statistical functions such as mean, median, and min/max.

Statistics Module

Statistical calculation utilities.

This submodule provides utilities for statistical operations like mean, median, sum, min, and max.

Examples

from rite.numeric.statistics import ( ... statistics_mean, ... statistics_median ... ) statistics_mean([1, 2, 3, 4, 5]) 3.0 statistics_median([1, 2, 3, 4, 5]) 3

Functions

statistics_max(values: list[float]) -> float

Find maximum value in list.

Parameters:

Name Type Description Default
values list[float]

List of numbers.

 required

Returns:

Type Description
float

Maximum value.

Raises:

Type Description
ValueError

If values list is empty.

Examples:

>>> statistics_max([3, 1, 4, 1, 5])
5
>>> statistics_max([10, 20, 5])
20
Notes

Wrapper around built-in max().

statistics_min(values: list[float]) -> float

Find minimum value in list.

Parameters:

Name Type Description Default
values list[float]

List of numbers.

 required

Returns:

Type Description
float

Minimum value.

Raises:

Type Description
ValueError

If values list is empty.

Examples:

>>> statistics_min([3, 1, 4, 1, 5])
1
>>> statistics_min([10, 20, 5])
5
Notes

Wrapper around built-in min().

Modules

statistics_mean

Mean Calculator

Calculate arithmetic mean of numbers.

Examples

from rite.numeric.statistics import statistics_mean statistics_mean([1, 2, 3, 4, 5]) 3.0

Functions

statistics_mean(values: list[float]) -> float

Calculate arithmetic mean of numbers.

Parameters:

Name Type Description Default
values list[float]

List of numbers.

 required

Returns:

Type Description
float

Mean value.

Raises:

Type Description
ValueError

If values list is empty.

Examples:

>>> statistics_mean([1, 2, 3, 4, 5])
3.0
>>> statistics_mean([10, 20, 30])
20.0
>>> statistics_mean([5.5])
5.5
Notes

Sum divided by count.

statistics_median

Median Calculator

Calculate median of numbers.

Examples

from rite.numeric.statistics import statistics_median statistics_median([1, 2, 3, 4, 5]) 3

Functions

statistics_median(values: list[float]) -> float

Calculate median of numbers.

Parameters:

Name Type Description Default
values list[float]

List of numbers.

 required

Returns:

Type Description
float

Median value.

Raises:

Type Description
ValueError

If values list is empty.

Examples:

>>> statistics_median([1, 2, 3, 4, 5])
3
>>> statistics_median([1, 2, 3, 4])
2.5
>>> statistics_median([5])
5
Notes

Middle value for odd length. Average of two middle values for even length.

statistics_min_max

Min/Max Functions

Find minimum and maximum values.

Examples

from rite.numeric.statistics import statistics_min statistics_min([3, 1, 4, 1, 5]) 1

Functions

statistics_max(values: list[float]) -> float

Find maximum value in list.

Parameters:

Name Type Description Default
values list[float]

List of numbers.

 required

Returns:

Type Description
float

Maximum value.

Raises:

Type Description
ValueError

If values list is empty.

Examples:

>>> statistics_max([3, 1, 4, 1, 5])
5
>>> statistics_max([10, 20, 5])
20
Notes

Wrapper around built-in max().

statistics_min(values: list[float]) -> float

Find minimum value in list.

Parameters:

Name Type Description Default
values list[float]

List of numbers.

 required

Returns:

Type Description
float

Minimum value.

Raises:

Type Description
ValueError

If values list is empty.

Examples:

>>> statistics_min([3, 1, 4, 1, 5])
1
>>> statistics_min([10, 20, 5])
5
Notes

Wrapper around built-in min().

statistics_sum

Sum Calculator

Calculate sum of numbers.

Examples

from rite.numeric.statistics import statistics_sum statistics_sum([1, 2, 3, 4, 5]) 15

Functions

statistics_sum(values: list[float]) -> float

Calculate sum of numbers.

Parameters:

Name Type Description Default
values list[float]

List of numbers.

 required

Returns:

Type Description
float

Sum of all values.

Examples:

>>> statistics_sum([1, 2, 3, 4, 5])
15
>>> statistics_sum([10, 20, 30])
60
>>> statistics_sum([])
0
Notes

Returns 0 for empty list. Wrapper around built-in sum().

options: show_root_heading: true show_source: false heading_level: 2