libzahl

commit f0aa2f671e01ce36c98f55718cb2ca62c69ac55a
parent 57a300ec29469afdd9c267b00b55701888114e0a
Author: Mattias Andrée <maandree@kth.se>
Date:   Mon,  9 May 2016 22:47:17 +0200

n ≠ qd + r, that would just complicate things

Signed-off-by: Mattias Andrée <maandree@kth.se>

Diffstat:
M
man/zdivmod.3
 | 
28
++++++++++++++++++++++++++++

1 file changed, 28 insertions(+), 0 deletions(-)
diff --git a/man/zdivmod.3 b/man/zdivmod.3
@@ -30,6 +30,34 @@ gets
 Mod
 .IR divisor .
 .P
+Be aware,
+.I remainder
+gets
+.RI | dividend |
+Mod
+.RI | divisor |,
+this means that it is only guaranteed to be true that
+.I dividend
+=
+.I quotient
+⋅
+.I divisor
++
+.IR remainder
+if
+.I dividend
+and
+.I divisor
+have the same sign.
+It is up to the user, to make the necessary adjustment to
+.I remainder
+to make this true or to satisfy any desired property. This
+exceptional behaviour has been choosen because it is the
+simplies, works just fine if you are working with natural
+numbers only, and there are two many ways to define
+modulus; this one is advantages when you want to make
+adjustments, it is straight-forward.
+.P
 It is safe to call
 .B zdivmod
 with non-unique parameters,