From 3919e65b5a7600e9b9baa0e9f2fab7af051c8eb9 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Mon, 19 Jan 2026 22:01:31 +0100 Subject: Add some man pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libj2_j2u_test_j2u.3 | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 libj2_j2u_test_j2u.3 (limited to 'libj2_j2u_test_j2u.3') diff --git a/libj2_j2u_test_j2u.3 b/libj2_j2u_test_j2u.3 new file mode 100644 index 0000000..b9dd8f0 --- /dev/null +++ b/libj2_j2u_test_j2u.3 @@ -0,0 +1,86 @@ +.TH LIBJ2_J2U_TEST_J2U 3 LIBJ2 +.SH NAME +libj2_j2u_test_j2u \- Check whether any bit from a set is set + +.SH SYNOPSIS +.nf +#include + +int \fBlibj2_j2u_test_j2u\fP(const struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP); +int \fBlibj2_j2u_test_ju\fP(const struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP); +int \fBlibj2_j2u_test_high_ju\fP(const struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP); +int \fBlibj2_j2u_test_bit\fP(const struct libj2_j2u *\fIa\fP, unsigned \fIb\fP); +.fi +.PP +Link with +.IR -lj2 . + +.SH DESCRIPTION +The +.BR libj2_j2u_test_j2u () +function checks whether any set bit in +.I b +is also set in +.IR a . +.PP +The +.BR libj2_j2u_test_ju () +function checks whether any set bit in +.I b +is also set in the least significant half of +.IR a . +.PP +The +.BR libj2_j2u_test_high_ju () +function checks whether any set bit in +.I b +is also set in the most significant half of +.IR a . +.PP +The +.BR libj2_j2u_test_bit () +function checks whether the bit at position +.IR b , +counting from 0 at the least significant bit, +is set in +.IR a . +.PP +The arguments are assumed to be +.RI non- NULL . + +.SH RETURN VALUE +The +.BR libj2_j2u_test_j2u (), +.BR libj2_j2u_test_ju (), +.BR libj2_j2u_test_high_ju (), +and +.BR libj2_j2u_test_bit () +functions return 1 if the test passes, and 0 otherwise. + +.SH ERRORS +The above listed functions cannot fail. + +.SH HISTORY +The +.BR libj2_j2u_test_j2u (), +.BR libj2_j2u_test_ju (), +.BR libj2_j2u_test_high_ju (), +and +.BR libj2_j2u_test_bit () +functions were added in version 1.0 of +.BR libj2 . + +.SH SEE ALSO +.BR libj2 (7), +.BR libj2_j2u_has_j2u (3), +.BR libj2_j2u_and_j2u (3), +.BR libj2_j2u_or_j2u (3), +.BR libj2_j2u_xor_j2u (3), +.BR libj2_j2u_if_j2u (3), +.BR libj2_j2u_imply_j2u (3), +.BR libj2_j2u_nand_j2u (3), +.BR libj2_j2u_nor_j2u (3), +.BR libj2_j2u_xnor_j2u (3), +.BR libj2_j2u_nif_j2u (3), +.BR libj2_j2u_nimply_j2u (3), +.BR libj2_not_j2u (3) -- cgit v1.2.3-70-g09d2