summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNiels M?ller <nisse@lysator.liu.se>2014-07-05 23:11:30 +0200
committerNiels M?ller <nisse@lysator.liu.se>2014-07-05 23:11:30 +0200
commit9e8378048bc595551385aa359002ac480bdd0510 (patch)
tree51482884d6868cb7a196ac149ffdb1e3f2755bd5 /doc
parentffff1e6aa055f6545a42953e91d56f2ca58ee03f (diff)
downloadgmp-9e8378048bc595551385aa359002ac480bdd0510.tar.gz
Document that scratch need for mpn_sec_add_1 and mpn_sec_sub_1 are at most n limbs.
Diffstat (limited to 'doc')
-rw-r--r--doc/gmp.texi3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/gmp.texi b/doc/gmp.texi
index e71face4f..a90fc28a0 100644
--- a/doc/gmp.texi
+++ b/doc/gmp.texi
@@ -5706,7 +5706,8 @@ These functions take @math{O(N)} time, unlike the leaky functions
@code{mpn_add_1} which are @math{O(1)} on average. They require scratch space
of @code{mpn_sec_add_1_itch(@var{n})} and @code{mpn_sec_sub_1_itch(@var{n})}
limbs, respectively, to be passed in the @var{tp} parameter. The scratch space
-requirements are guaranteed to increase monotonously in the operand size.
+requirements are guaranteed to be at most @var{n} limbs, and increase
+monotonously in the operand size.
@end deftypefun
@deftypefun void mpn_sec_mul (mp_limb_t *@var{rp}, const mp_limb_t *@var{ap}, mp_size_t @var{an}, const mp_limb_t *@var{bp}, mp_size_t @var{bn}, mp_limb_t *@var{tp})