aboutsummaryrefslogtreecommitdiffstats
path: root/libj2_j2i_is_negative.3
diff options
context:
space:
mode:
Diffstat (limited to 'libj2_j2i_is_negative.3')
-rw-r--r--libj2_j2i_is_negative.346
1 files changed, 46 insertions, 0 deletions
diff --git a/libj2_j2i_is_negative.3 b/libj2_j2i_is_negative.3
new file mode 100644
index 0000000..97c2199
--- /dev/null
+++ b/libj2_j2i_is_negative.3
@@ -0,0 +1,46 @@
+.TH LIBJ2_J2I_IS_NEGATIVE 3 LIBJ2
+.SH NAME
+libj2_j2i_is_negative \- Check if value is negative
+
+.SH SYNOPSIS
+.nf
+#include <libj2.h>
+
+int \fBlibj2_j2i_is_negative\fP(const struct libj2_j2i *\fIa\fP);
+.fi
+.PP
+Link with
+.IR -lj2 .
+
+.SH DESCRIPTION
+The
+.BR libj2_j2i_is_negative ()
+function checks whether the
+value of
+.I a
+is negative.
+.PP
+.I a
+is assumed to be
+.RI non- NULL .
+
+.SH RETURN VALUE
+The function returns 1 if the value of
+.I a
+is negative, and 0 otherwise.
+
+.SH ERRORS
+The function cannot fail.
+
+.SH HISTORY
+The
+.BR libj2_j2i_is_negative ()
+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_positive (3),
+.BR libj2_sgn_j2i (3)