aboutsummaryrefslogtreecommitdiffstats
path: root/src/math/numbertheory/numthry.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/math/numbertheory/numthry.h')
-rw-r--r--src/math/numbertheory/numthry.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/math/numbertheory/numthry.h b/src/math/numbertheory/numthry.h
index d21635f34..7d0330ef6 100644
--- a/src/math/numbertheory/numthry.h
+++ b/src/math/numbertheory/numthry.h
@@ -108,9 +108,10 @@ BigInt BOTAN_DLL power_mod(const BigInt& b,
BigInt BOTAN_DLL ressol(const BigInt& x, const BigInt& p);
/**
-* @param x an integer
+* @param x a positive integer
* @return count of the zero bits in x, or, equivalently, the largest
-* value of n such that 2^n divides x evently
+* value of n such that 2^n divides x evenly. Returns zero if
+* n is less than or equal to zero.
*/
size_t BOTAN_DLL low_zero_bits(const BigInt& x);