summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNiels M?ller <nisse@lysator.liu.se>2014-07-05 23:14:57 +0200
committerNiels M?ller <nisse@lysator.liu.se>2014-07-05 23:14:57 +0200
commita63047dc48325c8b4ae85fbe0c9ae7651e333daa (patch)
treee160ff3730e0b2dd4f1c2104b1993bf8121a02eb /doc
parent9e8378048bc595551385aa359002ac480bdd0510 (diff)
downloadgmp-a63047dc48325c8b4ae85fbe0c9ae7651e333daa.tar.gz
Document allowed overlap for mpn_addmul_1 and mpn_submul_1.
Diffstat (limited to 'doc')
-rw-r--r--doc/gmp.texi6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/gmp.texi b/doc/gmp.texi
index a90fc28a0..99165ddd2 100644
--- a/doc/gmp.texi
+++ b/doc/gmp.texi
@@ -5301,7 +5301,8 @@ with a count equal to the logarithm of @var{s2limb} instead, for optimal speed.
Multiply @{@var{s1p}, @var{n}@} and @var{s2limb}, and add the @var{n} least
significant limbs of the product to @{@var{rp}, @var{n}@} and write the result
to @var{rp}. Return the most significant limb of the product, plus carry-out
-from the addition.
+from the addition. @{@var{s1p}, @var{n}@} and @{@var{rp}, @var{n}@} are
+allowed to overlap provided @math{@var{rp} @le{} @var{s1p}}.
This is a low-level function that is a building block for general
multiplication as well as other operations in GMP@. It is written in assembly
@@ -5312,7 +5313,8 @@ for most CPUs.
Multiply @{@var{s1p}, @var{n}@} and @var{s2limb}, and subtract the @var{n}
least significant limbs of the product from @{@var{rp}, @var{n}@} and write the
result to @var{rp}. Return the most significant limb of the product, plus
-borrow-out from the subtraction.
+borrow-out from the subtraction. @{@var{s1p}, @var{n}@} and @{@var{rp},
+@var{n}@} are allowed to overlap provided @math{@var{rp} @le{} @var{s1p}}.
This is a low-level function that is a building block for general
multiplication and division as well as other operations in GMP@. It is written