summaryrefslogtreecommitdiffstats
path: root/src/euclid.rs
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2020-06-27 17:17:10 -0400
committerTavian Barnes <tavianator@tavianator.com>2020-06-27 17:40:03 -0400
commit07e61231dff21fda6da32929c0eae82fa44f6517 (patch)
tree0279b132f1b3b82f9c4e7ac581d152d052fa3c52 /src/euclid.rs
parente466113d70e9786259b3516b5951771b0706e5d8 (diff)
downloadacap-07e61231dff21fda6da32929c0eae82fa44f6517.tar.xz
docs: Update some links
Diffstat (limited to 'src/euclid.rs')
-rw-r--r--src/euclid.rs10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/euclid.rs b/src/euclid.rs
index 0f2281e..c1d88ae 100644
--- a/src/euclid.rs
+++ b/src/euclid.rs
@@ -12,8 +12,8 @@ use std::convert::TryFrom;
///
/// This wrapper equips any [coordinate space] with the [Euclidean distance] metric.
///
-/// [coordinate space]: [Coordinates]
-/// [Euclidean distance]: https://en.wikipedia.org/wiki/Euclidean_distance
+/// [coordinate space]: Coordinates
+/// [Euclidean distance]: euclidean_distance
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Euclidean<T>(pub T);
@@ -46,7 +46,7 @@ impl<T: Coordinates> Coordinates for Euclidean<T> {
}
}
-/// Compute the Euclidean distance between two points.
+/// Compute the [Euclidean distance] between two points.
///
/// ```math
/// \begin{aligned}
@@ -54,6 +54,8 @@ impl<T: Coordinates> Coordinates for Euclidean<T> {
/// &= \sqrt{\sum_i (x_i - y_i)^2}
/// \end{aligned}
/// ```
+///
+/// [Euclidean distance]: https://en.wikipedia.org/wiki/Euclidean_distance
pub fn euclidean_distance<T, U>(x: T, y: U) -> EuclideanDistance<T::Value>
where
T: Coordinates,
@@ -175,7 +177,7 @@ impl<T: Value> EuclideanDistance<T> {
}
}
-/// Error type for failed conversions from negative numbers to [EuclideanDistance].
+/// Error type for failed conversions from negative numbers to [`EuclideanDistance`].
#[derive(Debug)]
pub struct NegativeDistanceError;