aboutsummaryrefslogtreecommitdiffstats
path: root/man/zmodmul.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-03-01 11:49:17 +0100
committerMattias Andrée <maandree@kth.se>2016-03-01 11:49:42 +0100
commit1f4fb92a5f52e25170f28a61e6979cf63ca7f36b (patch)
tree01effdf7920681df51fcde8cd6a911b90186a495 /man/zmodmul.3
parentAdd more man pages (diff)
downloadlibzahl-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/zmodmul.3')
-rw-r--r--man/zmodmul.342
1 files changed, 42 insertions, 0 deletions
diff --git a/man/zmodmul.3 b/man/zmodmul.3
new file mode 100644
index 0000000..45fdbe9
--- /dev/null
+++ b/man/zmodmul.3
@@ -0,0 +1,42 @@
+.TH ZMODMUL 3 libzahl
+.SH NAME
+zmodmul - Calculate the modular product of two big integer
+.SH SYNOPSIS
+.nf
+#include <zahl.h>
+
+void zmodmul(z_t \fIproduct\fP, z_t \fImultiplier\fP, z_t \fImultiplicand\fP, z_t \fImodulator\fP);
+.fi
+.SH DESCRIPTION
+.B zmodmul
+calculates the product of a
+.I multiplier
+and a
+.IR multiplicand ,
+modulus a
+.IR modulator ,
+and stores the result in
+.IR product .
+That is,
+.I product
+gets
+.RI ( multiplier
+⋅
+.IR multiplicand )
+Mod
+.IR modulator .
+.P
+It is safe to call
+.B zmodmul
+with non-unique parameters.
+.SH SEE ALSO
+.BR zmodpow (3),
+.BR zstr (3),
+.BR zadd (3),
+.BR zsub (3),
+.BR zmul (3),
+.BR zdiv (3),
+.BR zmod (3),
+.BR zneg (3),
+.BR zabs (3),
+.BR zpow (3)