aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/math/bigint/bigint.h
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2018-06-23 19:24:12 -0400
committerJack Lloyd <[email protected]>2018-06-23 19:24:12 -0400
commit3726fe354bd13ca0716d9ea80d8ab45c3cace2cd (patch)
tree5d3a915708454555f3baa9e7a5202e6dc63ce5d6 /src/lib/math/bigint/bigint.h
parent5d3fb558a86976187f5edcac70bb28bfa61238cd (diff)
Document preconditions of BigInt::mod_add/mod_sub
Diffstat (limited to 'src/lib/math/bigint/bigint.h')
-rw-r--r--src/lib/math/bigint/bigint.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/lib/math/bigint/bigint.h b/src/lib/math/bigint/bigint.h
index 8c627c584..ea0f1c60e 100644
--- a/src/lib/math/bigint/bigint.h
+++ b/src/lib/math/bigint/bigint.h
@@ -282,6 +282,7 @@ class BOTAN_PUBLIC_API(2,0) BigInt final
/**
* Set *this to (*this + y) % mod
+ * This function assumes *this is >= 0 && < mod
* @param y the BigInt to add - assumed y >= 0 and y < mod
* @param mod the positive modulus
* @param ws a temp workspace
@@ -290,6 +291,7 @@ class BOTAN_PUBLIC_API(2,0) BigInt final
/**
* Set *this to (*this - y) % mod
+ * This function assumes *this is >= 0 && < mod
* @param y the BigInt to subtract - assumed y >= 0 and y < mod
* @param mod the positive modulus
* @param ws a temp workspace