From e466113d70e9786259b3516b5951771b0706e5d8 Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@tavianator.com>
Date: Fri, 26 Jun 2020 17:20:22 -0400
Subject: docs: Integrate KaTeX and add some formulas

---
 src/hamming.rs | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'src/hamming.rs')

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
 }
-- 
cgit v1.2.3