summaryrefslogtreecommitdiffstats
path: root/src/euclid.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/euclid.rs')
-rw-r--r--src/euclid.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/euclid.rs b/src/euclid.rs
index 4f2309a..0f2281e 100644
--- a/src/euclid.rs
+++ b/src/euclid.rs
@@ -47,6 +47,13 @@ impl<T: Coordinates> Coordinates for Euclidean<T> {
}
/// Compute the Euclidean distance between two points.
+///
+/// ```math
+/// \begin{aligned}
+/// \mathrm{euclidean\_distance}(x, y) &= \|x - y\|_2 \\
+/// &= \sqrt{\sum_i (x_i - y_i)^2}
+/// \end{aligned}
+/// ```
pub fn euclidean_distance<T, U>(x: T, y: U) -> EuclideanDistance<T::Value>
where
T: Coordinates,