aboutsummaryrefslogtreecommitdiffstats
path: root/src/math/bigint/divide.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/math/bigint/divide.h')
-rw-r--r--src/math/bigint/divide.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/math/bigint/divide.h b/src/math/bigint/divide.h
index 9445b137b..36aed7854 100644
--- a/src/math/bigint/divide.h
+++ b/src/math/bigint/divide.h
@@ -12,7 +12,17 @@
namespace Botan {
-void BOTAN_DLL divide(const BigInt&, const BigInt&, BigInt&, BigInt&);
+/**
+* BigInt Division
+* @param x an integer
+* @param y a non-zero integer
+* @param q will be set to x / y
+* @param r will be set to x % y
+*/
+void BOTAN_DLL divide(const BigInt& x,
+ const BigInt& y,
+ BigInt& q,
+ BigInt& r);
}