mp-modsqrt: Always return the smaller possible square root.

[u/mdw/catacomb] / mp.h

diff --git a/mp.h b/mp.h
index aa9bbac..74b6473 100644 (file)
--- a/mp.h
+++ b/mp.h
@@ -968,6 +968,9 @@ extern int mp_jacobi(mp */*a*/, mp */*n*/);
  *             work if %$p$% is composite: you must factor the modulus, take
  *             a square root mod each factor, and recombine the results
  *             using the Chinese Remainder Theorem.
+ *
+ *             We guarantee that the square root returned is the smallest
+ *             one (i.e., the `positive' square root).
  */
 
 extern mp *mp_modsqrt(mp */*d*/, mp */*a*/, mp */*p*/);