faasle 0.1.1

A Rust crate for evaluating distances (metrics)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

#![doc = include_str!("../README.md")]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/Qazalbash/faasle/main/logos/logoBgColor.png",
    html_favicon_url = "https://raw.githubusercontent.com/Qazalbash/faasle/main/logos/logoBgColor.png"
)]
#![doc(issue_tracker_base_url = "https://github.com/Qazalbash/faasle/issues/")]

mod distance;
mod generic;

/// The `Distance` trait defines the interface for evaluating distances (metrics)
/// between multidimensional arrays.
#[doc(inline)]
pub use distance::Distance;
/// `Chebyshev(x, y) = max(|x - y|)`
#[doc(inline)]
pub use generic::metric::Chebyshev;
/// `Cityblock(x, y) = sum(|x - y|)`
#[doc(inline)]
pub use generic::metric::Cityblock;
/// `Euclidean(x, y) = sqrt(sum((x - y).^2))`
#[doc(inline)]
pub use generic::metric::Euclidean;
/// `Hamming(x, y) = sum(x!=y)`
#[doc(inline)]
pub use generic::metric::Hamming;
/// `Minkowski(x, y) = sum(|x - y|.^p).^(1/p)`
#[doc(inline)]
pub use generic::metric::Minkowski;
/// `RMSDeviation(x, y) = sqrt(mean((x - y).^2))`
#[doc(inline)]
pub use generic::metric::RMSDeviation;
/// `TotalVariation(x, y) = sum(|x - y|) ./ 2`
#[doc(inline)]
pub use generic::metric::TotalVariation;
/// `GenKLDivergence(x, y) = sum(x .* ln(x ./ y) - x + y)`
#[doc(inline)]
pub use generic::pre_metric::GenKLDivergence;
/// `KLDivergence(x, y) = sum(x .* ln(x ./ y))`
#[doc(inline)]
pub use generic::pre_metric::KLDivergence;
/// `BhattacharyyaDist(x, y) = -ln(sum(sqrt(x .* y)))+0.5*ln(sum(x))+0.5*ln(sum(y))`
#[doc(inline)]
pub use generic::semi_metric::BhattacharyyaDist;
/// `BrayCurtis(x, y) = sum(|x - y|) / sum(|x + y|)`
#[doc(inline)]
pub use generic::semi_metric::BrayCurtis;
/// `ChiSqDist(x, y) = sum((x - y).^2 ./ (x + y))`
#[doc(inline)]
pub use generic::semi_metric::ChiSqDist;
/// `JSDivergence(x, y) = KLDivergence(x, (x + y) ./ 2) + KLDivergence(y, (x + y) ./ 2)`
#[doc(inline)]
pub use generic::semi_metric::JSDivergence;
/// `MeanAbsDeviation(x, y) = mean(|x - y|)`
#[doc(inline)]
pub use generic::semi_metric::MeanAbsDeviation;
/// `MeanSqDeviation(x, y) = mean((x - y).^2)`
#[doc(inline)]
pub use generic::semi_metric::MeanSqDeviation;
/// `SqEuclidean(x, y) = sqrt(sum((x - y).^2))`
#[doc(inline)]
pub use generic::semi_metric::SqEuclidean;