summaryrefslogtreecommitdiff
path: root/doc/gcrypt.texi
diff options
context:
space:
mode:
authorWerner Koch <wk@gnupg.org>2017-11-15 20:35:16 +0100
committerWerner Koch <wk@gnupg.org>2017-11-15 20:37:50 +0100
commit0abd1031bc0d889f21ddbf4ced8764d2191075fe (patch)
tree480c641a228fc1f3fee1bea6123a1e2f793a3948 /doc/gcrypt.texi
parentc594f187bd457b757112adc551ffa4db92962dc1 (diff)
downloadlibgcrypt-0abd1031bc0d889f21ddbf4ced8764d2191075fe.tar.gz
doc: Clarify gcry_mpi_div
--
Diffstat (limited to 'doc/gcrypt.texi')
-rw-r--r--doc/gcrypt.texi4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/gcrypt.texi b/doc/gcrypt.texi
index a6841344..dd244691 100644
--- a/doc/gcrypt.texi
+++ b/doc/gcrypt.texi
@@ -4759,7 +4759,9 @@ Basic arithmetic operations:
@math{@var{q} = @var{dividend} / @var{divisor}}, @math{@var{r} =
@var{dividend} \bmod @var{divisor}}. @var{q} and @var{r} may be passed
-as @code{NULL}. @var{round} should be negative or 0.
+as @code{NULL}. @var{round} is either negative for floored division
+(rounds towards the next lower integer) or zero for truncated division
+(rounds towards zero).
@end deftypefun
@deftypefun void gcry_mpi_mod (@w{gcry_mpi_t @var{r}}, @w{gcry_mpi_t @var{dividend}}, @w{gcry_mpi_t @var{divisor}})