[Gmp-commit] /var/hg/gmp: doc/gmp.texi (mpz_invert): Specify mod 0 is not han...

[mercurial at gmplib.org]

details:   /var/hg/gmp/rev/22ba3bcf0d66
changeset: 14727:22ba3bcf0d66
user:      Marco Bodrato <bodrato at mail.dm.unipi.it>
date:      Sun Mar 04 09:01:32 2012 +0100
description:
doc/gmp.texi (mpz_invert): Specify mod 0 is not handled.

diffstat:

 ChangeLog    |  1 +
 doc/gmp.texi |  5 +++--
 2 files changed, 4 insertions(+), 2 deletions(-)

diffs (26 lines):

diff -r 14737f2a2bdf -r 22ba3bcf0d66 ChangeLog
--- a/ChangeLog	Sun Mar 04 08:49:36 2012 +0100
+++ b/ChangeLog	Sun Mar 04 09:01:32 2012 +0100
@@ -2,6 +2,7 @@
 
 	* mpz/invert.c: Remove mod 0 branch.
 	* tests/mpz/t-invert.c: Avoid testing mod 0.
+	* doc/gmp.texi (mpz_invert): Specify mod 0 is not handled.
 
 	* gmp-h.in (__gmp_signed): Remove.
 	(__GMP_HAVE_TOKEN_PASTE, __GMP_HAVE_CONST): Remove.
diff -r 14737f2a2bdf -r 22ba3bcf0d66 doc/gmp.texi
--- a/doc/gmp.texi	Sun Mar 04 08:49:36 2012 +0100
+++ b/doc/gmp.texi	Sun Mar 04 09:01:32 2012 +0100
@@ -3585,8 +3585,9 @@
 @cindex Inverse modulo functions
 Compute the inverse of @var{op1} modulo @var{op2} and put the result in
 @var{rop}.  If the inverse exists, the return value is non-zero and @var{rop}
-will satisfy @math{0 < @var{rop} < @var{@GMPabs{op2}}}.  If an inverse doesn't exist
-the return value is zero and @var{rop} is undefined.
+will satisfy @math{0 < @var{rop} < @var{@GMPabs{op2}}}.  If an inverse doesn't
+exist the return value is zero and @var{rop} is undefined.  The behaviour of
+this function is undefined when @var{op2} is zero.
 @end deftypefun
 
 @deftypefun int mpz_jacobi (mpz_t @var{a}, mpz_t @var{b})