Mod and Modulus (Float functions): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to revised template; fix tags and links)
m (re-match syntax diagram to revised template;)
Line 11: Line 11:
<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">number</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 Float value to be divided by the method argument, <var class="term">number</var>. </td></tr>
<td>A Float value to be divided by the method argument, <var class="term">divisor</var>. </td></tr>
<tr><th>number </th>
<tr><th>divisor</th>
<td>A non-zero numeric value. 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 value of 0, or a value that rounds down to 0, causes a request cancellation.</td></tr>
</table>
</table>
Line 32: Line 32:
   %dividend = 9997
   %dividend = 9997
   %divisor  =  7
   %divisor  =  7
   printText {~} = {%dividend:div(%divisor)}
   <var>[[Intrinsic classes#printtext|printtext]]</var> {~} = {%dividend:div(%divisor)}
   printText {~} = {%dividend:mod(%divisor)}
   printText {~} = {%dividend:mod(%divisor)}
end</p>
end</p>
Line 40: Line 40:


==See also==
==See also==
<ul><li>The <var>[[Div (Float function)|"Div function"]]</var> returns the integral quotient of a division.
<ul><li>The <var>[[Div (Float function)|"Div function"]]</var> returns the integral quotient of a division.</ul>
<li><var>PrintText</var> is described in the <var>[[Intrinsic classes#printtext|"System Intrinsic Class"]]</var>.</ul>
{{Template:Float:Mod and Modulus footer}}
{{Template:Float:Mod and Modulus footer}}

Revision as of 05:19, 4 February 2011

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 value of 0, or a value that rounds down to 0, causes a request cancellation.

Usage notes

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

    so displays:

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

See also