aboutsummaryrefslogtreecommitdiffstats
path: root/libj2_j2i_is_positive.3
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2025-12-28 18:59:16 +0100
committerMattias Andrée <m@maandree.se>2025-12-28 18:59:16 +0100
commit687876add148fe3193e11d941c649989c09a89b6 (patch)
tree8797a3fb3d5cf416e78a0ee68e05ed95e0cfb2b8 /libj2_j2i_is_positive.3
parentAdd man pages for regular subtraction functions (diff)
downloadlibj2-687876add148fe3193e11d941c649989c09a89b6.tar.gz
libj2-687876add148fe3193e11d941c649989c09a89b6.tar.bz2
libj2-687876add148fe3193e11d941c649989c09a89b6.tar.xz
Add some man pages
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
-rw-r--r--libj2_j2i_is_positive.354
1 files changed, 54 insertions, 0 deletions
diff --git a/libj2_j2i_is_positive.3 b/libj2_j2i_is_positive.3
new file mode 100644
index 0000000..c08ddbe
--- /dev/null
+++ b/libj2_j2i_is_positive.3
@@ -0,0 +1,54 @@
+.TH LIBJ2_J2I_IS_POSITIVE 3 LIBJ2
+.SH NAME
+libj2_j2i_is_positive \- Check if value is positive
+
+.SH SYNOPSIS
+.nf
+#include <libj2.h>
+
+int \fBlibj2_j2i_is_positive\fP(const struct libj2_j2i *\fIa\fP);
+int \fBlibj2_j2u_is_positive\fP(const struct libj2_j2u *\fIa\fP);
+.fi
+.PP
+Link with
+.IR -lj2 .
+
+.SH DESCRIPTION
+The
+.BR libj2_j2i_is_positive ()
+and
+.BR libj2_j2u_is_positive ()
+functions check whether the
+value of
+.I a
+is positive.
+.PP
+.I a
+is assumed to be
+.RI non- NULL .
+
+.SH RETURN VALUE
+The functions return 1 if the value of
+.I a
+is positive, and 0 otherwise.
+
+.SH ERRORS
+The functions cannot fail.
+
+.SH HISTORY
+The
+.BR libj2_j2u_is_positive ()
+function was added in version 1.0 of
+.BR libj2 .
+.PP
+The
+.BR libj2_j2i_is_positive ()
+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_sgn_j2i (3)