diff options
| author | Mattias Andrée <maandree@kth.se> | 2016-03-01 11:49:17 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2016-03-01 11:49:42 +0100 |
| commit | 1f4fb92a5f52e25170f28a61e6979cf63ca7f36b (patch) | |
| tree | 01effdf7920681df51fcde8cd6a911b90186a495 /man/zmod.3 | |
| parent | Add more man pages (diff) | |
| download | libzahl-1f4fb92a5f52e25170f28a61e6979cf63ca7f36b.tar.gz libzahl-1f4fb92a5f52e25170f28a61e6979cf63ca7f36b.tar.bz2 libzahl-1f4fb92a5f52e25170f28a61e6979cf63ca7f36b.tar.xz | |
Add more man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/zmod.3')
| -rw-r--r-- | man/zmod.3 | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/man/zmod.3 b/man/zmod.3 new file mode 100644 index 0000000..9c6e72b --- /dev/null +++ b/man/zmod.3 @@ -0,0 +1,41 @@ +.TH ZMOD 3 libzahl +.SH NAME +zmod - Calculate the modulus of two big integer +.SH SYNOPSIS +.nf +#include <zahl.h> + +void zmod(z_t \fIremainder\fP, z_t \fIdividend\fP, z_t \fIdivisor\fP); +.fi +.SH DESCRIPTION +.B zmod +calculates the remainder of a +.I dividend +and a +.IR divisor , +and stores the result in +.IR remainder . +That is, +.I remainder +gets +.I dividend +Mod +.IR divisor . +.P +The result +.RI ( remainder ) +is always non-negative. +.P +It is safe to call +.B zmod +with non-unique parameters. +.SH SEE ALSO +.BR zdivmod (3), +.BR zstr (3), +.BR zadd (3), +.BR zsub (3), +.BR zmul (3), +.BR zdiv (3), +.BR zneg (3), +.BR zabs (3), +.BR zpow (3) |