summaryrefslogtreecommitdiffstats
path: root/src/hamming.rs
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2020-06-26 17:20:22 -0400
committerTavian Barnes <tavianator@tavianator.com>2020-06-27 13:58:43 -0400
commite466113d70e9786259b3516b5951771b0706e5d8 (patch)
tree9abce5a134d5f437d8f1b6f70bba9669f191b82e /src/hamming.rs
parentb4e301a2a4e6e00a1b521cae8e1a015ab8fc2b54 (diff)
downloadacap-e466113d70e9786259b3516b5951771b0706e5d8.tar.xz
docs: Integrate KaTeX and add some formulas
Diffstat (limited to 'src/hamming.rs')
-rw-r--r--src/hamming.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/hamming.rs b/src/hamming.rs
index c6822ee..da959b4 100644
--- a/src/hamming.rs
+++ b/src/hamming.rs
@@ -25,6 +25,13 @@ impl<T> Hamming<T> {
}
/// Compute the Hamming distance between two integers.
+///
+/// ```math
+/// \begin{aligned}
+/// \mathrm{hamming\_distance}(x, y) &= |\{i \mid x_i \ne y_i\}| \\
+/// &= \mathrm{popcount}(x \wedge y)
+/// \end{aligned}
+/// ```
pub fn hamming_distance<T: PrimInt>(x: T, y: T) -> i32 {
(x ^ y).count_ones() as i32
}