libzahl

big integer library
git clone git://git.suckless.org/libzahl
Log | Files | Refs | README | LICENSE

zmod.3 (734B)

      1 .TH ZMOD 3 libzahl
      2 .SH NAME
      3 zmod - Calculate the modulus of two big integer
      4 .SH SYNOPSIS
      5 .nf
      6 #include <zahl.h>
      7 
      8 void zmod(z_t \fIremainder\fP, z_t \fIdividend\fP, z_t \fIdivisor\fP);
      9 .fi
     10 .SH DESCRIPTION
     11 .B zmod
     12 calculates the remainder of a
     13 .I dividend
     14 and a
     15 .IR divisor ,
     16 and stores the result in
     17 .IR remainder .
     18 That is,
     19 .I remainder
     20 gets
     21 .I dividend
     22 Mod
     23 .IR divisor .
     24 .P
     25 The result
     26 .RI ( remainder )
     27 is negative if and only if the
     28 .I dividend
     29 is negative. To be more precise,
     30 a Mod b = (|a| Mod |b|) sgn a for all integers a
     31 and b.
     32 .P
     33 It is safe to call
     34 .B zmod
     35 with non-unique parameters.
     36 .SH SEE ALSO
     37 .BR zdivmod (3),
     38 .BR zstr (3),
     39 .BR zadd (3),
     40 .BR zsub (3),
     41 .BR zmul (3),
     42 .BR zdiv (3),
     43 .BR zneg (3),
     44 .BR zabs (3),
     45 .BR zpow (3)