diff options
| author | Mattias Andrée <m@maandree.se> | 2026-01-19 22:01:31 +0100 |
|---|---|---|
| committer | Mattias Andrée <m@maandree.se> | 2026-01-19 22:01:31 +0100 |
| commit | 3919e65b5a7600e9b9baa0e9f2fab7af051c8eb9 (patch) | |
| tree | d893b1607b2ec2612d17adf584b640d15b30b4cb /libj2_j2i_min_j2i.3 | |
| parent | Add man pages for bitwise connectives (diff) | |
| download | libj2-3919e65b5a7600e9b9baa0e9f2fab7af051c8eb9.tar.gz libj2-3919e65b5a7600e9b9baa0e9f2fab7af051c8eb9.tar.bz2 libj2-3919e65b5a7600e9b9baa0e9f2fab7af051c8eb9.tar.xz | |
Add some man pages
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
| -rw-r--r-- | libj2_j2i_min_j2i.3 | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/libj2_j2i_min_j2i.3 b/libj2_j2i_min_j2i.3 new file mode 100644 index 0000000..c677943 --- /dev/null +++ b/libj2_j2i_min_j2i.3 @@ -0,0 +1,68 @@ +.TH LIBJ2_J2I_MIN_J2I 3 LIBJ2 +.SH NAME +libj2_j2i_min_j2i \- Select minimum of two values + +.SH SYNOPSIS +.nf +#include <libj2.h> + +void \fBlibj2_j2i_min_j2i\fP(struct libj2_j2i *\fIa\fP, const struct libj2_j2i *\fIb\fP); +void \fBlibj2_j2i_min_j2i_to_j2i\fP(const struct libj2_j2i *\fIa\fP, const struct libj2_j2i *\fIb\fP, struct libj2_j2i *\fIr\fP); +void \fBlibj2_j2i_min_ji\fP(struct libj2_j2i *\fIa\fP, intmax_t \fIb\fP); +void \fBlibj2_j2i_min_ji_to_j2i\fP(const struct libj2_j2i *\fIa\fP, intmax_t \fIb\fP, struct libj2_j2i *\fIr\fP); +void \fBlibj2_j2u_min_j2u\fP(struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP); +void \fBlibj2_j2u_min_j2u_to_j2u\fP(const struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP, struct libj2_j2u *\fIr\fP); +void \fBlibj2_j2u_min_ju\fP(struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP); +void \fBlibj2_j2u_min_ju_to_j2u\fP(const struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP, struct libj2_j2u *\fIr\fP); +.fi +.PP +Link with +.IR -lj2 . + +.SH DESCRIPTION +The above listed functions +calculate selects the minimum value of +.I a +and +.I b +and stores the result in +.IR r , +or in +.I a +for the functions that does not have an +.I r +parameter. +.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_j2u_min_j2u (), +.BR libj2_j2u_min_j2u_to_j2u (), +.BR libj2_j2u_min_ju (), +and +.BR libj2_j2u_min_ju_to_j2u () +functions were added in version 1.0 of +.BR libj2 . +.PP +The +.BR libj2_j2i_min_j2i (), +.BR libj2_j2i_min_j2i_to_j2i (), +.BR libj2_j2i_min_ji (), +and +.BR libj2_j2i_min_ji_to_j2i () +functions were added in version 1.1 of +.BR libj2 . + +.SH SEE ALSO +.BR libj2 (7), +.BR libj2_j2i_max_j2i (3), +.BR libj2_min_j2i (3), +.BR libj2_max_j2i (3) |
