View source for Documentation:OCLOperators Number::ieeereminder(r:Number):Integer

<message>Write the content here to display this box</message>
Returns the remainder resulting from the division of a specified number by another specified number.
 public static double IEEERemainder (double x, double y);

==== Parameters ====
<code>x</code>  Double

A dividend.

<code>y</code> Double

A divisor.

==== Returns ====
Double

A number equal to <code>x</code> - (<code>y</code> Q), where Q is the quotient of <code>x</code> / <code>y</code> rounded to the nearest integer (if <code>x</code> / <code>y</code> falls halfway between two integers, the even integer is returned).

If <code>x</code> - (<code>y</code> Q) is zero, the value +0 is returned if <code>x</code> is positive, or -0 if <code>x</code> is negative.

If <code>y</code> = 0, NaN is returned.

=== Examples ===
The following example contrasts the remainder returned by the IEEERemainder method with the remainder returned by the remainder operator.
  using System;

  public class Example
  {
    public static void Main()
    {
       Console.WriteLine($"{"IEEERemainder",35} {"Remainder operator",20}");
       ShowRemainders(3, 2);
       ShowRemainders(4, 2);
       ShowRemainders(10, 3);
       ShowRemainders(11, 3);
       ShowRemainders(27, 4);
       ShowRemainders(28, 5);
       ShowRemainders(17.8, 4);
       ShowRemainders(17.8, 4.1);
       ShowRemainders(-16.3, 4.1);
       ShowRemainders(17.8, -4.1);
       ShowRemainders(-17.8, -4.1);
    }
   
   private static void ShowRemainders(double number1, double number2)
    {
       var formula = $"{number1} / {number2} = ";
       var ieeeRemainder = Math.IEEERemainder(number1, number2);
       var remainder = number1 % number2;
       Console.WriteLine($"{formula,-16} {ieeeRemainder,18} {remainder,20}");
    }
 }
 // The example displays the following output:
 //
 //
 //                       IEEERemainder   Remainder operator
 // 3 / 2 =                          -1                    1
 // 4 / 2 =                           0                    0
 // 10 / 3 =                          1                    1
 // 11 / 3 =                         -1                    2
 // 27 / 4 =                         -1                    3
 // 28 / 5 =                         -2                    3
 // 17.8 / 4 =                      1.8                  1.8
 // 17.8 / 4.1 =                    1.4                  1.4
 // -16.3 / 4.1 =    0.0999999999999979                   -4
 // 17.8 / -4.1 =                   1.4                  1.4
 // -17.8 / -4.1 =                 -1.4                 -1.4 

=== Remarks ===
This operation complies with the remainder operation defined in Section 5.1 of ANSI/IEEE Std 754-1985; IEEE Standard for Binary Floating-Point Arithmetic; Institute of Electrical and Electronics Engineers, Inc; 1985.

The IEEERemainder method is not the same as the remainder operator. Although both return the remainder after division, the formulas they use are different. The formula for the IEEERemainder method is:
 IEEERemainder = dividend - (divisor * Math.Round(dividend / divisor))
In contrast, the formula for the remainder operator is:
 Remainder = (Math.Abs(dividend) - (Math.Abs(divisor) *   
            (Math.Floor(Math.Abs(dividend) / Math.Abs(divisor))))) *   
            Math.Sign(dividend)
{{Edited|July|12|2024}}
[[Category:OCL Number Operators]]
[[Category:TOC]]