[hackers] [libzahl] n ≠ qd + r, that would just complicate things || Mattias Andrée

[git]

commit f0aa2f671e01ce36c98f55718cb2ca62c69ac55a
Author:     Mattias Andrée <maand...@kth.se>
AuthorDate: Mon May 9 22:47:17 2016 +0200
Commit:     Mattias Andrée <maand...@kth.se>
CommitDate: Mon May 9 22:47:17 2016 +0200

    n ≠ qd + r, that would just complicate things
    
    Signed-off-by: Mattias Andrée <maand...@kth.se>

diff --git a/man/zdivmod.3 b/man/zdivmod.3
index f0cd9e4..7e486d4 100644
--- 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,