Mod and Modulus (Float functions) - Revision history

JAL at 18:02, 2 November 2012

2012-11-02T18:02:09Z

← Older revision		Revision as of 18:02, 2 November 2012
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}}

JALWiccan: 1 revision

2011-05-04T17:46:34Z

1 revision

← Older revision	Revision as of 17:46, 4 May 2011
(No difference)

Goff: syntax terms

2011-05-04T17:46:32Z

syntax terms

← Older revision		Revision as of 17:46, 4 May 2011
Line 19:		Line 19:

	==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\|Sirius Mods]]</var> Version 7.3.</ul>

	==Examples==		==Examples==

Goff: syntax terms

2011-02-23T08:23:24Z

syntax terms

← Older revision		Revision as of 08:23, 23 February 2011
Line 13:		Line 13:
	<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 Float 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 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>
	</table>		</table>

Goff: fix div link

2011-02-22T10:42:39Z

fix div link

← Older revision		Revision as of 10:42, 22 February 2011
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>		<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}}

Goff: re-match syntax diagram to revised template;

2011-02-04T05:19:52Z

re-match syntax diagram to revised template;

← Older revision		Revision as of 05:19, 4 February 2011
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}}

Goff: match syntax diagram to revised template; fix tags and links

2011-02-04T01:26:48Z

match syntax diagram to revised template; fix tags and links

← Older revision		Revision as of 01:26, 4 February 2011
Line 1:		Line 1:
	{{Template:Float:Mod and Modulus subtitle}}		{{Template:Float:Mod and Modulus subtitle}}

	~~These~~ [[Intrinsic classes\|intrinsic]] functions return the remainder		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.
	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''.		<var>Mod</var> is a synonym for <var>Modulus</var>.

	~~The [[Div (Float function)\|Div function]] returns the integral quotient of a division.~~

	~~The Modulus function is available as of version 7.3 of the <var class=product>Sirius Mods</var>.~~
	==Syntax==		==Syntax==
	{{Template:Float:Mod syntax}}		{{Template:Float:Mod syntax}}
Line 16:		Line 10:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~mod~~ </th>		<tr><th>%number</th>
	<td>A variable to receive the integral remainder of the quotient of ''number'' / ~~''num''~~. </td></tr>		<td>A variable to receive the integral remainder of the quotient of <var class="term">float</var> / <var class="term">number</var>. </td></tr>
			<tr><th>float</th>
			<td>A Float value to be divided by the method argument, <var class="term">number</var>. </td></tr>
	<tr><th>number </th>		<tr><th>number </th>
	~~<td>A Float value to be divided by the method argument, ''num''. </td></tr>~~
	~~<tr><th>num </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>

			==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>

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

	==See also==		==See also==
			<ul><li>The <var>[[Div (Float function)\|"Div function"]]</var> returns the integral quotient of a division.
			<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}}

Wiccan: 1 revision

2011-01-26T21:27:31Z

1 revision

← Older revision	Revision as of 21:27, 26 January 2011
(No difference)

Wiccan: 1 revision

2011-01-26T21:27:30Z

1 revision

← Older revision		Revision as of 21:27, 26 January 2011
Line 44:		Line 44:
	==See also==		==See also==
	{{Template:Float:Mod and Modulus footer}}		{{Template:Float:Mod and Modulus footer}}



	~~<!--~~
	~~<section begin=dpl_desc />~~
	~~Remainder of integer division~~
	~~<section end=dpl_desc />~~
	~~-->~~

Wiccan: 1 revision

2011-01-26T20:52:22Z

1 revision

← Older revision	Revision as of 20:52, 26 January 2011
(No difference)