From 687876add148fe3193e11d941c649989c09a89b6 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 28 Dec 2025 18:59:16 +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_sgn_j2i.3 | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 libj2_sgn_j2i.3 (limited to 'libj2_sgn_j2i.3') diff --git a/libj2_sgn_j2i.3 b/libj2_sgn_j2i.3 new file mode 100644 index 0000000..6c48cac --- /dev/null +++ b/libj2_sgn_j2i.3 @@ -0,0 +1,58 @@ +.TH LIBJ2_SGN_J2I 3 LIBJ2 +.SH NAME +libj2_sgn_j2i \- Get signum of value + +.SH SYNOPSIS +.nf +#include + +int \fBlibj2_sgn_j2i\fP(const struct libj2_j2i *\fIa\fP); +int \fBlibj2_sgn_j2u\fP(const struct libj2_j2u *\fIa\fP); +.fi +.PP +Link with +.IR -lj2 . + +.SH DESCRIPTION +The +.BR libj2_sgn_j2i () +and +.BR libj2_sgn_j2u () +function compares +.I a +against zero, returning whether +the value is positive, negative, or zero. +.PP +.I a +is assumed to be +.RI non- NULL . + +.SH RETURN VALUE +The functions return -1 if the value of +.I a +is negative +(impossible for the +.BR libj2_sgn_j2u () +function), +1 if the value is positive, +and 0 if zero. + +.SH ERRORS +The functions cannot fail. + +.SH HISTORY +The +.BR libj2_sgn_j2u () +function was added in version 1.0 of +.BR libj2 . +.PP +The +.BR libj2_sgn_j2i () +function was added in version 1.1 of +.BR libj2 . + +.SH SEE ALSO +.BR libj2 (7), +.BR libj2_j2i_cmp_j2i (3), +.BR libj2_j2i_is_zero (3), +.BR libj2_j2i_is_negative (3), +.BR libj2_j2i_is_positive (3) -- cgit v1.2.3-70-g09d2