Div (Float function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax diagram to revised template; fix tags and links) |
mNo edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Float:Div subtitle}} | {{Template:Float:Div subtitle}} | ||
The <var>Div</ | The <var>Div</var> [[Intrinsic classes|intrinsic]] function returns the integer part of the result of dividing the method object by the method argument. | ||
The numbers to be divided are first rounded to the nearest integer, including zero. Any remainder from the division is ignored. | The numbers to be divided are first rounded to the nearest integer, including zero. Any remainder from the division is ignored. | ||
| Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
{{Template:Float:Div syntax}} | {{Template:Float:Div syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A variable to receive the integer part of the quotient. </td></tr> | <td>A variable to receive the integer part of the quotient. </td></tr> | ||
<tr><th>float</th> | <tr><th>float</th> | ||
<td>A <var>Float</var> value to be divided by the method argument, | <td>A <var>Float</var> value to be divided by the method argument, <var class="term">divisor</var>. </td></tr> | ||
<tr><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> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li><var>Div</var> is available as of <var class="product"> | <ul> | ||
<li><var>Div</var> is available as of <var class="product">Sirius Mods</var> Version 7.3. | |||
</ul> | |||
==Examples== | ==Examples== | ||
<ol><li>The following statement | <ol> | ||
<li>The following statement sets <code>%z</code> to the integer quotient from the division of the number in <code>%x</code> (rounded) by the number in <code>%y</code> (rounded): | |||
<p class="code">%z = %x:div(%y) | <p class="code">%z = %x:div(%y) | ||
</p> | </p> | ||
<li>The following statement | <li>The following statement sets <code>%z</code> to <code>-95</code>: | ||
<p class="code">%z = -191.4:div(2.3) | <p class="code">%z = -191.4:div(2.3) | ||
</p></ol> | </p></ol> | ||
==See also== | ==See also== | ||
The <var>[[Modulus_(Float_function)|Modulus | The <var>[[Modulus_(Float_function)|Modulus]]</var> function returns the remainder of a division. | ||
{{Template:Float:Div footer}} | {{Template:Float:Div footer}} | ||
Latest revision as of 17:36, 2 November 2012
Integer division (Float class)
The Div intrinsic function returns the integer part of the result of dividing the method object by the method argument.
The numbers to be divided are first rounded to the nearest integer, including zero. Any remainder from the division is ignored.
Syntax
%number = float:Div( divisor)
Syntax terms
| %number | A variable to receive the integer part of the quotient. |
|---|---|
| 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
- Div is available as of Sirius Mods Version 7.3.
Examples
- The following statement sets
%zto the integer quotient from the division of the number in%x(rounded) by the number in%y(rounded):%z = %x:div(%y)
- The following statement sets
%zto-95:%z = -191.4:div(2.3)
See also
The Modulus function returns the remainder of a division.