[ViewVC] Diff of: cvs/libecb/ecb.pod

Comparing libecb/ecb.pod (file contents):
Revision 1.24 by root, Tue May 31 21:10:37 2011 UTC vs.
Revision 1.25 by root, Tue May 31 21:52:31 2011 UTC

 =over 4
 =item x = ecb_mod (m, n)
-Returns the positive remainder of the modulo operation between C<m> and
+Returns C<m> modulo C<n>, which is the same as the positive remainder
-C<n>, using floored division. Unlike the C modulo operator C<%>, this
+of the division operation between C<m> and C<n>, using floored
-function ensures that the return value is always positive and that the two
+division. Unlike the C remainder operator C<%>, this function ensures that
+the return value is always positive and that the two numbers I<m> and
-numbers I<m> and I<m' = m + i * n> result in the same value modulo I<n> -
+I<m' = m + i * n> result in the same value modulo I<n> - in other words,
-the C<%> operator usually has a behaviour change at C<m = 0>.
+C<ecb_mod> implements the mathematical modulo operation, which is missing
+in the language.
 C<n> must be strictly positive (i.e. C<< >= 1 >>), while C<m> must be
 negatable, that is, both C<m> and C<-m> must be representable in its
-type.
+type (this typically includes the minimum signed integer value, the same
+limitation as for C</> and C<%> in C).
 Current GCC versions compile this into an efficient branchless sequence on
 many systems.
 For example, when you want to rotate forward through the members of an

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines