From 07e61231dff21fda6da32929c0eae82fa44f6517 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Sat, 27 Jun 2020 17:17:10 -0400 Subject: docs: Update some links --- src/cos.rs | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'src/cos.rs') diff --git a/src/cos.rs b/src/cos.rs index 5d8f73f..99a08f4 100644 --- a/src/cos.rs +++ b/src/cos.rs @@ -10,7 +10,7 @@ use std::cmp::Ordering; /// Compute the [cosine *similarity*] between two points. /// -/// Use [cosine_distance] instead if you are implementing [Proximity::distance()]. +/// Use [cosine_distance] instead if you are implementing [`Proximity::distance()`]. /// /// ```math /// \begin{aligned} @@ -21,7 +21,7 @@ use std::cmp::Ordering; /// ``` /// /// [cosine *similarity*]: https://en.wikipedia.org/wiki/Cosine_similarity -/// [Proximity::distance()]: Proximity#tymethod.distance +/// [`Proximity::distance()`]: Proximity#tymethod.distance pub fn cosine_similarity(x: T, y: U) -> T::Value where T: Coordinates, @@ -69,8 +69,8 @@ where /// Equips any [coordinate space] with the [cosine distance] function. /// -/// [coordinate space]: [Coordinates] -/// [cosine distance]: https://en.wikipedia.org/wiki/Cosine_similarity +/// [coordinate space]: Coordinates +/// [cosine distance]: cosine_distance #[derive(Clone, Copy, Debug, Eq, PartialEq)] pub struct Cosine(pub T); @@ -112,7 +112,7 @@ where /// Compute the [cosine *similarity*] between two pre-normalized (unit magnitude) points. /// -/// Use [prenorm_cosine_distance] instead if you are implementing [Proximity::distance()]. +/// Use [`prenorm_cosine_distance()`] instead if you are implementing [`Proximity::distance()`]. /// /// ```math /// \begin{aligned} @@ -166,8 +166,8 @@ where /// Equips any [coordinate space] with the [cosine distance] function for pre-normalized (unit /// magnitude) points. /// -/// [coordinate space]: [Coordinates] -/// [cosine distance]: https://en.wikipedia.org/wiki/Cosine_similarity +/// [coordinate space]: Coordinates +/// [cosine distance]: prenorm_cosine_distance #[derive(Clone, Copy, Debug, Eq, PartialEq)] pub struct PrenormCosine(pub T); @@ -230,8 +230,8 @@ where /// Equips any [coordinate space] with the [angular distance] metric. /// -/// [coordinate space]: [Coordinates] -/// [angular distance]: https://en.wikipedia.org/wiki/Cosine_similarity#Angular_distance_and_similarity +/// [coordinate space]: Coordinates +/// [angular distance]: angular_distance #[derive(Clone, Copy, Debug, Eq, PartialEq)] pub struct Angular(pub T); @@ -322,8 +322,8 @@ where /// Equips any [coordinate space] with the [angular distance] metric for pre-normalized (unit /// magnitude) points. /// -/// [coordinate space]: [Coordinates] -/// [angular distance]: https://en.wikipedia.org/wiki/Cosine_similarity#Angular_distance_and_similarity +/// [coordinate space]: Coordinates +/// [angular distance]: prenorm_angular_distance #[derive(Clone, Copy, Debug, Eq, PartialEq)] pub struct PrenormAngular(pub T); -- cgit v1.2.3