Mod and Modulus (Float functions): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (syntax terms)
mNo edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Template:Float:Mod and Modulus subtitle}}
{{Template:Float:Mod and Modulus subtitle}}


The <var>Mod</var> and <var>Modulus</var> <var>[[Intrinsic classes|intrinsic]]</var> functions return the remainder from the division of the method object by the method argument.  The numbers to be divided are first rounded to an integer, including zero, so the remainder is always an integer or zero.
The <var>Mod</var> and <var>Modulus</var> [[Intrinsic classes|intrinsic]] functions return the remainder from the division of the method object by the method argument.  The numbers to be divided are first rounded to an integer, including zero, so the remainder is always an integer or zero.


<var>Mod</var> is a synonym for <var>Modulus</var>.
<var>Mod</var> is a synonym for <var>Modulus</var>.
Line 8: Line 8:
{{Template:Float:Mod syntax}}
{{Template:Float:Mod syntax}}
{{Template:Float:Modulus syntax}}
{{Template:Float:Modulus syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%number</th>
<tr><th>%number</th>
<td>A variable to receive the integral remainder of the quotient of <var class="term">float</var> / <var class="term">divisor</var>. </td></tr>
<td>A variable to receive the integral remainder of the quotient of <var class="term">float</var> / <var class="term">divisor</var>. </td></tr>
<tr><th>float</th>
<tr><th>float</th>
<td>A <var>Float</var> value to be divided by the method argument, <var class="term">divisor</var>. </td></tr>
<td>A <var>Float</var> value to be divided by the method argument, <var class="term">divisor</var>. </td></tr>
<tr><th>divisor</th>
<tr><th>divisor</th>
<td>A non-zero numeric value. A <var>divisor</var> with a value of 0, or a value that rounds down to 0, causes a request cancellation.</td></tr>
<td>A non-zero numeric value. A <var>divisor</var> with a value of 0, or a value that rounds down to 0, causes a request cancellation.</td></tr>
Line 19: Line 22:


==Usage notes==
==Usage notes==
<ul><li><var>Mod</var> / <var>Modulus</var> are available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3.</ul>
<ul>
<li><var>Mod</var> / <var>Modulus</var> are available as of <var class="product">Sirius Mods</var> Version 7.3.
</ul>


==Examples==
==Examples==
<ol><li>The following statement returns to <code>%z</code> the remainder from the division of the number in <code>%x</code> (rounded) by the number in <code>%y</code> (rounded):
<ol><li>The following statement returns to <code>%z</code> the remainder from the division of the number in <code>%x</code> (rounded) by the number in <code>%y</code> (rounded):
<p class="code">  %z = %x:mod(%y)</p>
<p class="code">  %z = %x:mod(%y)</p>
<li>The following statement returns '<code>-1</code>' to <code>%z</code>:
 
<p class="code">   %z = -191.4:mod(2.0)</p>
<li>The following statement returns <code>-1</code> to <code>%z</code>:
<p class="code">%z = -191.4:mod(2.0)</p>
 
<li>The following displays the quotient and remainder when dividing <code>9997</code> by <code>7</code>:
<li>The following displays the quotient and remainder when dividing <code>9997</code> by <code>7</code>:
<p class="code">begin
<p class="code">begin
Line 35: Line 42:
   printText {~} = {%dividend:mod(%divisor)}
   printText {~} = {%dividend:mod(%divisor)}
end</p>
end</p>
so displays:
The result is:
<p class="output">%dividend:div(%divisor) = 1428
<p class="output">%dividend:div(%divisor) = 1428
%dividend:mod(%divisor) = 1</p></ol>
%dividend:mod(%divisor) = 1</p>
</ol>


==See also==
==See also==
<ul><li>The <var>[[Div (Float function)|Div]]</var> function returns the integral quotient of a division.</ul>
<ul>
<li>The <var>[[Div (Float function)|Div]]</var> function returns the integral quotient of a division.
</ul>
 
{{Template:Float:Mod and Modulus footer}}
{{Template:Float:Mod and Modulus footer}}

Latest revision as of 18:02, 2 November 2012

Remainder of integer division (Float class)


The Mod and Modulus intrinsic functions return the remainder from the division of the method object by the method argument. The numbers to be divided are first rounded to an integer, including zero, so the remainder is always an integer or zero.

Mod is a synonym for Modulus.

Syntax

%number = float:Mod( divisor)

%number = float:Modulus( divisor)

Syntax terms

%number A variable to receive the integral remainder of the quotient of float / divisor.
float A Float value to be divided by the method argument, divisor.
divisor A non-zero numeric value. A divisor with a value of 0, or a value that rounds down to 0, causes a request cancellation.

Usage notes

  • Mod / Modulus are available as of Sirius Mods Version 7.3.

Examples

  1. The following statement returns to %z the remainder from the division of the number in %x (rounded) by the number in %y (rounded):

    %z = %x:mod(%y)

  2. The following statement returns -1 to %z:

    %z = -191.4:mod(2.0)

  3. The following displays the quotient and remainder when dividing 9997 by 7:

    begin %dividend is float %divisor is float %dividend = 9997 %divisor = 7 printtext {~} = {%dividend:div(%divisor)} printText {~} = {%dividend:mod(%divisor)} end

    The result is:

    %dividend:div(%divisor) = 1428 %dividend:mod(%divisor) = 1

See also

  • The Div function returns the integral quotient of a division.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Mod_and_Modulus_(Float_functions)&oldid=4086"