sigmasternchen/gleam-community-maths
1
0
Fork 0
mirror of https://github.com/sigmasternchen/gleam-community-maths synced 2025-03-15 07:59:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add function descriptions and fix typos

Browse source
This commit is contained in:
NicklasXYZ 2024-04-14 17:30:39 +02:00
parent d2485d4e88
commit ef8844d991
2 changed files with 38 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/gleam_community/maths/arithmetics.gleam
View file

@ -306,8 +306,8 @@ pub fn proper_divisors(n: Int) -> List(Int) {
/// \\]
///
/// In the formula, $$n$$ is the length of the list and $$x_i \in \mathbb{R}$$ is
/// the value in the input list indexed by $$i$$, while $$w_i \in \mathbb{R}$$ is
/// a corresponding weight ($$w_i = 1.0\\;\forall i=1...n$$ by default).
/// the value in the input list indexed by $$i$$, while the $$w_i \in \mathbb{R}$$
/// are corresponding weights ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// <details>
/// <summary>Example:</summary>
@ -412,8 +412,8 @@ pub fn int_sum(arr: List(Int)) -> Int {
/// \\]
///
/// In the formula, $$n$$ is the length of the list and $$x_i \in \mathbb{R}$$ is
/// the value in the input list indexed by $$i$$, while $$w_i \in \mathbb{R}$$ is
/// a corresponding weight ($$w_i = 1.0\\;\forall i=1...n$$ by default).
/// the value in the input list indexed by $$i$$, while the $$w_i \in \mathbb{R}$$
/// are corresponding weights ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// <details>
/// <summary>Example:</summary>

41
src/gleam_community/maths/metrics.gleam
View file

@ -243,8 +243,8 @@ pub fn norm(
/// \\]
///
/// In the formula, $$n$$ is the length of the two lists and $$x_i, y_i$$ are the
/// values in the respective input lists indexed by $$i$$, while
/// $$w_i \in \mathbb{R}_{+}$$ is a corresponding positive weight
/// values in the respective input lists indexed by $$i$$, while the
/// $$w_i \in \mathbb{R}_{+}$$ are corresponding positive weights
/// ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// <details>
@ -304,7 +304,7 @@ pub fn manhattan_distance(
///
/// In the formula, $$p >= 1$$ is the order, $$n$$ is the length of the two lists
/// and $$x_i, y_i$$ are the values in the respective input lists indexed by $$i$$.
/// $$w_i \in \mathbb{R}_{+}$$ is a corresponding positive weight
/// The $$w_i \in \mathbb{R}_{+}$$ are corresponding positive weights
/// ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// The Minkowski distance is a generalization of both the Euclidean distance
@ -393,8 +393,8 @@ pub fn minkowski_distance(
/// \\]
///
/// In the formula, $$n$$ is the length of the two lists and $$x_i, y_i$$ are the
/// values in the respective input lists indexed by $$i$$, while
/// $$w_i \in \mathbb{R}_{+}$$ is a corresponding positive weight
/// values in the respective input lists indexed by $$i$$, while the
/// $$w_i \in \mathbb{R}_{+}$$ are corresponding positive weights
/// ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// <details>
@ -1042,8 +1042,8 @@ pub fn overlap_coefficient(xset: set.Set(a), yset: set.Set(a)) -> Float {
/// \\]
///
/// In the formula, $$n$$ is the length of the two lists and $$x_i$$, $$y_i$$ are
/// the values in the respective input lists indexed by $$i$$, while
/// $$w_i \in \mathbb{R}_{+}$$ is a corresponding positive weight
/// the values in the respective input lists indexed by $$i$$, while the
/// $$w_i \in \mathbb{R}_{+}$$ are corresponding positive weights
/// ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// The cosine similarity provides a value between -1 and 1, where 1 means the
@ -1253,6 +1253,18 @@ fn distance_list_helper(
/// </a>
/// </div>
///
/// Calculate the (weighted) Canberra distance between two lists:
///
/// \\[
/// \sum_{i=1}^n w_{i}\frac{\left| x_i - y_i \right|}
/// {\left| x_i \right| + \left| y_i \right|}
/// \\]
///
/// In the formula, $$n$$ is the length of the two lists, and $$x_i, y_i$$ are the
/// values in the respective input lists indexed by $$i$$, while the
/// $$w_i \in \mathbb{R}_{+}$$ are corresponding positive weights
/// ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// <details>
/// <summary>Example:</summary>
///
@ -1330,6 +1342,21 @@ fn canberra_distance_helper(tuple: #(Float, Float)) -> Float {
/// </a>
/// </div>
///
/// Calculate the (weighted) Bray-Curtis distance between two lists:
///
/// \\[
/// \frac{\sum_{i=1}^n w_{i} \left| x_i - y_i \right|}
/// {\sum_{i=1}^n w_{i}\left| x_i + y_i \right|}
/// \\]
///
/// In the formula, $$n$$ is the length of the two lists, and $$x_i, y_i$$ are the values
/// in the respective input lists indexed by $$i$$, while the
/// $$w_i \in \mathbb{R}_{+}$$ are corresponding positive weights
/// ($$w_i = 1.0\\;\forall i=1...n$$ by default).
///
/// The Bray-Curtis distance is in the range $$[0, 1]$$ if all entries $$x_i, y_i$$ are
/// positive.
///
/// <details>
/// <summary>Example:</summary>
///