aboutsummaryrefslogtreecommitdiffstats
path: root/man/zdivmod.3
blob: b11b8b6924903ebdf57a02033408eb1028e4b1a6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
.TH ZDIVMOD 3 libzahl
.SH NAME
zdivmod - Calculate the quotient and the remainder of two big integer
.SH SYNOPSIS
.nf
#include <zahl.h>

void zdivmod(z_t \fIquotient\fP, z_t \fIremainder\fP, z_t \fIdividend\fP, z_t \fIdivisor\fP);
.fi
.SH DESCRIPTION
.B zdivmod
calculates the quotient and the remainder of a
.I dividend
and a
.IR divisor ,
and stores the quotient in
.I quotient
and the remainder in
.IR remainder .
That is,
.I quotient
gets
.I dividend
/
.I divisor
and
.I remainder
gets
.I dividend
Mod
.IR divisor .
.P
It is safe to call
.B zdivmod
with non-unique parameters,
except it is
.I not
safe to call
.B zdivmod with
.IR "(quotient==remainder)" .
.SH RATIONALE
Calculating the remainder requires calculating division to
be performed, and performing a division gives the remainder
for free. It is often useful to calculate both.
.SH SEE ALSO
.BR zstr (3),
.BR zadd (3),
.BR zsub (3),
.BR zmul (3),
.BR zdiv (3),
.BR zmod (3),
.BR zneg (3),
.BR zabs (3),
.BR zpow (3)