aboutsummaryrefslogtreecommitdiffstats
path: root/libj2_parity_j2u.3
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2025-12-27 20:44:22 +0100
committerMattias Andrée <m@maandree.se>2025-12-27 20:44:22 +0100
commit56b19a09fda414876e310d086636c8e618871219 (patch)
treed1858ddf3712e2dcd4a0bf3aae8a4669e598ea11 /libj2_parity_j2u.3
parentTesting (diff)
downloadlibj2-56b19a09fda414876e310d086636c8e618871219.tar.gz
libj2-56b19a09fda414876e310d086636c8e618871219.tar.bz2
libj2-56b19a09fda414876e310d086636c8e618871219.tar.xz
Add some man pages
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
-rw-r--r--libj2_parity_j2u.342
1 files changed, 42 insertions, 0 deletions
diff --git a/libj2_parity_j2u.3 b/libj2_parity_j2u.3
new file mode 100644
index 0000000..067c0cf
--- /dev/null
+++ b/libj2_parity_j2u.3
@@ -0,0 +1,42 @@
+.TH LIBJ2_PARITY_J2U 3 LIBJ2
+.SH NAME
+libj2_parity_j2u \- Calculate bit parity
+
+.SH SYNOPSIS
+.nf
+#include <libj2.h>
+
+unsigned \fBlibj2_parity_j2u\fP(const struct libj2_j2u *\fIa\fP);
+.fi
+.PP
+Link with
+.IR -lj2 .
+
+.SH DESCRIPTION
+The
+.BR libj2_parity_j2u ()
+function returns the parity of the bits in
+.IR a .
+.PP
+.I a
+is assumed to be
+.RI non- NULL .
+
+.SH RETURN VALUE
+The
+.BR libj2_parity_j2u ()
+function returns the 1 if the number of
+set bits (or equivalently the cleared bits)
+in
+.I a
+is odd, and 0 otherwise.
+
+.SH ERRORS
+The
+.BR libj2_parity_j2u ()
+function cannot fail.
+
+.SH SEE ALSO
+.BR libj2 (7),
+.BR libj2_co_j2u (3),
+.BR libj2_cz_j2u (3)