aboutsummaryrefslogtreecommitdiffstats
path: root/libj2_parity_j2u.3
blob: 067c0cfddeb31464388710b220e0703445017424 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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)