diff options
Diffstat (limited to '')
| -rw-r--r-- | libj2_j2i_add_j2i.3 | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/libj2_j2i_add_j2i.3 b/libj2_j2i_add_j2i.3 new file mode 100644 index 0000000..c58cc76 --- /dev/null +++ b/libj2_j2i_add_j2i.3 @@ -0,0 +1,134 @@ +.TH LIBJ2_J2I_ADD_J2I 3 LIBJ2 +.SH NAME +libj2_j2i_add_j2i \- Calculate sum + +.SH SYNOPSIS +.nf +#include <libj2.h> + +void \fBlibj2_j2i_add_j2i\fP(struct libj2_j2i *\fIa\fP, const struct libj2_j2i *\fIb\fP); +void \fBlibj2_j2i_add_j2i_to_j2i\fP(const struct libj2_j2i *\fIa\fP, const struct libj2_j2i *\fIb\fP, struct libj2_j2i *\fIr\fP); +void \fBlibj2_j2i_add_ji\fP(struct libj2_j2i *\fIa\fP, intmax_t \fIb\fP); +void \fBlibj2_j2i_add_ji_to_j2i\fP(const struct libj2_j2i *\fIa\fP, intmax_t \fIb\fP, struct libj2_j2i *\fIr\fP); +void \fBlibj2_ji_add_j2i_to_j2i\fP(intmax_t \fIa\fP, const struct libj2_j2i *\fIb\fP, struct libj2_j2i *\fIr\fP); +void \fBlibj2_ji_add_ji_to_j2i\fP(intmax_t \fIa\fP, intmax_t \fIb\fP, struct libj2_j2i *\fIr\fP); + +int \fBlibj2_j2i_add_j2i_overflow\fP(struct libj2_j2i *\fIa\fP, const struct libj2_j2i *\fIb\fP); +int \fBlibj2_j2i_add_j2i_to_j2i_overflow\fP(const struct libj2_j2i *\fIa\fP, const struct libj2_j2i *\fIb\fP, struct libj2_j2i *\fIr\fP); +int \fBlibj2_j2i_add_ji_overflow\fP(struct libj2_j2i *\fIa\fP, intmax_t \fIb\fP); +int \fBlibj2_j2i_add_ji_to_j2i_overflow\fP(const struct libj2_j2i *\fIa\fP, intmax_t \fIb\fP, struct libj2_j2i *\fIr\fP); +int \fBlibj2_ji_add_j2i_to_j2i_overflow\fP(intmax_t \fIa\fP, const struct libj2_j2i *\fIb\fP, struct libj2_j2i *\fIr\fP); + +int \fBlibj2_j2i_add_j2i_overflow_p\fP(const struct libj2_j2i *\fIa\fP, const struct libj2_j2i *\fIb\fP); +int \fBlibj2_j2i_add_ji_overflow_p\fP(const struct libj2_j2i *\fIa\fP, intmax_t \fIb\fP); +int \fBlibj2_ji_add_j2i_overflow_p\fP(intmax_t \fIa\fP, const struct libj2_j2i *\fIb\fP); + +void \fBlibj2_j2u_add_j2u\fP(struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP); +void \fBlibj2_j2u_add_j2u_to_j2u\fP(const struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP, struct libj2_j2u *\fIr\fP); +void \fBlibj2_j2u_add_ju\fP(struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP); +void \fBlibj2_j2u_add_ju_to_j2u\fP(const struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP, struct libj2_j2u *\fIr\fP); +void \fBlibj2_ju_add_j2u_to_j2u\fP(uintmax_t \fIa\fP, const struct libj2_j2u *\fIb\fP, struct libj2_j2u *\fIr\fP); +void \fBlibj2_ju_add_ju_to_j2u\fP(uintmax_t \fIa\fP, uintmax_t \fIb\fP, struct libj2_j2u *\fIr\fP); + +int \fBlibj2_j2u_add_j2u_overflow\fP(struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP); +int \fBlibj2_j2u_add_j2u_to_j2u_overflow\fP(const struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP, struct libj2_j2u *\fIr\fP); +int \fBlibj2_j2u_add_ju_overflow\fP(struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP); +int \fBlibj2_j2u_add_ju_to_j2u_overflow\fP(const struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP, struct libj2_j2u *\fIr\fP); +int \fBlibj2_ju_add_j2u_to_j2u_overflow\fP(uintmax_t \fIa\fP, const struct libj2_j2u *\fIb\fP, struct libj2_j2u *\fIr\fP); + +int \fBlibj2_j2u_add_j2u_overflow_p\fP(const struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP); +int \fBlibj2_j2u_add_ju_overflow_p\fP(const struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP); +int \fBlibj2_ju_add_j2u_overflow_p\fP(uintmax_t \fIa\fP, const struct libj2_j2u *\fIb\fP); +.fi +.PP +Link with +.IR -lj2 . + +.SH DESCRIPTION +The above listed functions calculate the +sum of the values of +.I a +and +.IR b . +The functions with the parameter +.I r +store the result in +.IR r , +the other functions store the result in +.IR a , +except the functions +.BR libj2_j2i_add_j2i_overflow_p (), +.BR libj2_j2i_add_ji_overflow_p (), +.BR libj2_ji_add_j2i_overflow_p (), +.BR libj2_j2u_add_j2u_overflow_p (), +.BR libj2_j2u_add_ju_overflow_p (), +and +.BR libj2_ju_add_j2u_overflow_p () +only predict overflow, and do not calculate +the sum, and therefore does store it anywhere. +.PP +The value-returning functions (that is, those +with word +.B overflow +in their name), detect arithmetic overflow. +.PP +The result is truncated to the least significant +bits, as many as can be stored, in case of overflow; +that is, modular arithmetics is used. + +.PP +The arguments are assumed to be +.RI non- NULL . + +.SH RETURN VALUE +For functions with a return value, the functions +return +1 if the result is positive but too large +to be represented, -1 if the result is negative +(not only possible with functions where the result is a +.IR "struct libj2_j2i" ) +but too large, and 0 otherwise. + +.SH ERRORS +The above listed functions cannot fail. + +.SH HISTORY +The +.BR libj2_j2u_add_j2u (3), +.BR libj2_j2u_add_j2u_to_j2u (3), +.BR libj2_j2u_add_ju (3), +.BR libj2_j2u_add_ju_to_j2u (3), +.BR libj2_ju_add_j2u_to_j2u (3), +.BR libj2_ju_add_ju_to_j2u (3), +.BR libj2_j2u_add_j2u_overflow (3), +.BR libj2_j2u_add_j2u_to_j2u_overflow (3), +.BR libj2_j2u_add_ju_overflow (3), +.BR libj2_j2u_add_ju_to_j2u_overflow (3), +.BR libj2_ju_add_j2u_to_j2u_overflow (3), +.BR libj2_j2u_add_j2u_overflow_p (3), +.BR libj2_j2u_add_ju_overflow_p (3), +and +.BR libj2_ju_add_j2u_overflow_p (3) +functions were added in version 1.0 of +.BR libj2 . +.PP +The +.BR libj2_j2i_add_j2i (3), +.BR libj2_j2i_add_j2i_to_j2i (3), +.BR libj2_j2i_add_ji (3), +.BR libj2_j2i_add_ji_to_j2i (3), +.BR libj2_ji_add_j2i_to_j2i (3), +.BR libj2_ji_add_ji_to_j2i (3), +.BR libj2_j2i_add_j2i_overflow (3), +.BR libj2_j2i_add_j2i_to_j2i_overflow (3), +.BR libj2_j2i_add_ji_overflow (3), +.BR libj2_j2i_add_ji_to_j2i_overflow (3), +.BR libj2_ji_add_j2i_to_j2i_overflow (3), +.BR libj2_j2i_add_j2i_overflow_p (3), +.BR libj2_j2i_add_ji_overflow_p (3), +and +.BR libj2_ji_add_j2i_overflow_p (3) +functions were added in version 1.1 of +.BR libj2 . + +.SH SEE ALSO +.BR libj2 (7) |