From 32b87c5979a0e70994e4db65415ec0a2349c5618 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 1 Mar 2016 10:55:20 +0100
Subject: Add more man pages
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 man/zptest.3 | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 man/zptest.3

(limited to 'man/zptest.3')

diff --git a/man/zptest.3 b/man/zptest.3
new file mode 100644
index 0000000..404b66e
--- /dev/null
+++ b/man/zptest.3
@@ -0,0 +1,69 @@
+.TH ZPTEST 3 libzahl
+.SH NAME
+zptest - Test the primality of a big integer
+.SH SYNOPSIS
+.nf
+#include <zahl.h>
+
+enum zprimality zptest(z_t \fIwitness\fP, z_t \fIquestioned\fP, z_t \fItries\fP);
+.fi
+.SH DESCRIPTION
+.B zptest
+tests whether
+.I questioned
+is a prime number. This is implemented using the
+Miller–Rabin primality test.
+.P
+If
+.I questioned
+is determined to be a composite, the witness if its
+compositeness is stored into
+.I witness
+unless
+.I witness
+is
+.BR 0 .
+.BR zgcd (3)
+can be used on
+.I questioned
+and
+.I witness
+to extract a factor of
+.IR questioned .
+This factor can be either composite, prime, or 1.
+.P
+The risk that a composite number is determined to be
+a probably prime is
+.IR (1-4↑-tries) .
+.SH RETURN VALUE
+This function will either return:
+.TP
+.B NONPRIME
+.I questioned
+is certainly a composite number.
+.TP
+.B PROBABLY_PRIME
+.I questioned
+is probably a prime number.
+.TP
+.B PRIME
+.I questioned
+is certainly a prime number.
+.SH NOTES
+If
+.I questioned
+is less than two
+.I questioned
+is copied into
+.P
+Increasing
+.I tries
+only reduces the chance that
+.B PROBABLY_PRIME
+is returned. It cannot increase
+the chance that
+.B PRIME
+is returned.
+.IR witness .
+.SH SEE ALSO
+.BR zgcd (3)
-- 
cgit v1.2.3-70-g09d2