Indicado.Math (Indicado v0.0.4) View Source

This is the helper module holding common math functions for Indicado.

Link to this section Summary

Functions

Calculated mean of a given numeric list. Returns nil if list is empty.

Calculates standard deviation of a given numeric list. Returns nil if list is empty.

Calculates standard deviation of a given numeric list when mean is pre calculated and passed. Returns nil if list is empty.

variance(list)

Calculates variance of a given numeric list. Returns nil if list is empty.

variance(list, calculated_mean)

Calculates variance of a given numeric list when mean is pre calculated and passed. Returns nil if list is empty.

Link to this section Functions

mean(list)

Specs

mean([list(), ...]) :: float()

Calculated mean of a given numeric list. Returns nil if list is empty.

Examples

iex> Indicado.Math.mean([1, 2, 3, 4])
2.5

iex> Indicado.Math.mean([3, 5, 0, 14])
5.5

iex> Indicado.Math.mean([])
nil

stddev(list)

Specs

stddev([list(), ...]) :: float()

Calculates standard deviation of a given numeric list. Returns nil if list is empty.

Examples

iex> Indicado.Math.stddev([1, 2, 3, 4])
1.118033988749895

iex> Indicado.Math.stddev([5, 10, 15, 20, 40])
12.083045973594572

iex> Indicado.Math.stddev([])
nil

stddev(list, calculated_mean)

Specs

stddev([list()], float()) :: nil | float()

Calculates standard deviation of a given numeric list when mean is pre calculated and passed. Returns nil if list is empty.

Examples

iex> Indicado.Math.stddev([1, 2, 3, 4], 2.5)
1.118033988749895

iex> Indicado.Math.stddev([5, 10, 15, 20, 40], 18)
12.083045973594572

iex> Indicado.Math.stddev([])
nil

variance(list)

Specs

variance([list(), ...]) :: float()

Calculates variance of a given numeric list. Returns nil if list is empty.

Examples

iex> Indicado.Math.variance([1, 2, 3, 4])
1.25

iex> Indicado.Math.variance([2, 4, 6, 8])
5.0

iex> Indicado.Math.variance([])
nil

variance(list, calculated_mean)

Specs

variance([list(), ...], float()) :: nil | float()

Calculates variance of a given numeric list when mean is pre calculated and passed. Returns nil if list is empty.

Examples

iex> Indicado.Math.variance([1, 2, 3, 4], 2.5)
1.25

iex> Indicado.Math.variance([2, 4, 6, 8], 5.0)
5.0

iex> Indicado.Math.variance([])
nil