mood.c: Fix documentation of int_sqrt().
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 24 Jul 2017 20:41:40 +0000 (22:41 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Fri, 28 Jul 2017 14:01:01 +0000 (16:01 +0200)
As pointed out by Peter Zijlstra on lkml, int_sqrt() is not
rough nor any approximation; it calculates the exact value of
floor(sqrt()). Document this.

mood.c

diff --git a/mood.c b/mood.c
index c24b3d8..bf6b3c9 100644 (file)
--- a/mood.c
+++ b/mood.c
@@ -121,10 +121,9 @@ __a_const static uint32_t fls64(uint64_t v)
 }
 
 /*
- * Rough approximation to sqrt.
+ * Compute the integer square root floor(sqrt(x)).
  *
- * It returns an integer res with res * res <= x. Taken 2007 from the linux
- * source tree.
+ * Taken 2007 from the linux source tree.
  */
 __a_const static uint64_t int_sqrt(uint64_t x)
 {