aboutsummaryrefslogtreecommitdiffstats
path: root/libj2_abs_j2i.3
diff options
context:
space:
mode:
Diffstat (limited to 'libj2_abs_j2i.3')
-rw-r--r--libj2_abs_j2i.368
1 files changed, 68 insertions, 0 deletions
diff --git a/libj2_abs_j2i.3 b/libj2_abs_j2i.3
new file mode 100644
index 0000000..ca5d885
--- /dev/null
+++ b/libj2_abs_j2i.3
@@ -0,0 +1,68 @@
+.TH LIBJ2_ABS_J2I 3 LIBJ2
+.SH NAME
+libj2_abs_j2i \- Calculate absolute value
+
+.SH SYNOPSIS
+.nf
+#include <libj2.h>
+
+void \fBlibj2_abs_j2i\fP(struct libj2_j2i *\fIa\fP);
+void \fBlibj2_abs_j2i_to_j2i\fP(const struct libj2_j2i *\fIa\fP, struct libj2_j2i *\fIr\fP);
+void \fBlibj2_abs_j2i_to_j2u\fP(const struct libj2_j2i *\fIa\fP, struct libj2_j2u *\fIr\fP);
+.fi
+.PP
+Link with
+.IR -lj2 .
+
+.SH DESCRIPTION
+The
+.BR libj2_abs_j2i (),
+.BR libj2_abs_j2i_to_j2i (),
+and
+.BR libj2_abs_j2i_to_j2u ()
+functions calculate the absolute value of
+.IR a .
+.PP
+The
+.BR libj2_abs_j2i ()
+function stores the result in
+.IR a .
+.PP
+The
+.BR libj2_abs_j2i_to_j2i ()
+and
+.BR libj2_abs_j2i_to_j2u ()
+function stores the result in
+.IR r .
+.PP
+In the case that
+.I a
+is the minimum representable value, the
+calculation of the
+.BR libj2_abs_j2i ()
+and
+.BR libj2_abs_j2i_to_j2i ()
+functions overflow to the input value.
+.PP
+The arguments are assumed to be
+.RI non- NULL .
+
+.SH RETURN VALUE
+None.
+
+.SH ERRORS
+The above listed functions cannot fail.
+
+.SH HISTORY
+The
+.BR libj2_abs_j2i (),
+.BR libj2_abs_j2i_to_j2i (),
+and
+.BR libj2_abs_j2i_to_j2u ()
+functions were added in version 1.1 of
+.BR libj2 .
+
+.SH SEE ALSO
+.BR libj2 (7),
+.BR libj2_minus_j2i (3),
+.BR libj2_minus_abs_j2i (3)