diff options
| author | Mattias Andrée <m@maandree.se> | 2025-12-28 18:59:16 +0100 |
|---|---|---|
| committer | Mattias Andrée <m@maandree.se> | 2025-12-28 18:59:16 +0100 |
| commit | 687876add148fe3193e11d941c649989c09a89b6 (patch) | |
| tree | 8797a3fb3d5cf416e78a0ee68e05ed95e0cfb2b8 /libj2_j2i_is_max.3 | |
| parent | Add man pages for regular subtraction functions (diff) | |
| download | libj2-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 'libj2_j2i_is_max.3')
| -rw-r--r-- | libj2_j2i_is_max.3 | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/libj2_j2i_is_max.3 b/libj2_j2i_is_max.3 new file mode 100644 index 0000000..0d05dd5 --- /dev/null +++ b/libj2_j2i_is_max.3 @@ -0,0 +1,57 @@ +.TH LIBJ2_J2I_IS_MAX 3 LIBJ2 +.SH NAME +libj2_j2i_is_max \- Compare against maximum representable value + +.SH SYNOPSIS +.nf +#include <libj2.h> + +int \fBlibj2_j2i_is_max\fP(const struct libj2_j2i *\fIa\fP); +int \fBlibj2_j2u_is_max\fP(const struct libj2_j2u *\fIa\fP); +.fi +.PP +Link with +.IR -lj2 . + +.SH DESCRIPTION +The +.BR libj2_j2i_is_max () +and +.BR libj2_j2u_is_max () +functions check whether +.I a +is the largest positive number. +.PP +.I a +is assumed to be +.RI non- NULL . + +.SH RETURN VALUE +The functions return 1 if +.I a +is the maximum representable value, +and 0 otherwise. + +.SH ERRORS +The functions cannot fail. + +.SH HISTORY +The +.BR libj2_j2u_is_max () +function was added in version 1.0 of +.BR libj2 . +.PP +The +.BR libj2_j2i_is_max () +function was added in version 1.1 of +.BR libj2 . + +.SH SEE ALSO +.BR libj2 (7), +.BR libj2_j2i_max (3), +.BR libj2_j2i_cmp_j2i (3), +.BR libj2_j2i_is_min (3), +.BR libj2_j2i_is_zero (3), +.BR libj2_j2i_is_positive (3), +.BR libj2_j2i_is_negative (3), +.BR libj2_sgn_j2i (3) |