# Difference between revisions of "Div (Float function)"

Jump to navigation
Jump to search

m (match syntax diagram to revised template; fix tags and links) |
m (re-match syntx to resided template) |
||

Line 9: | Line 9: | ||

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

## Revision as of 05:12, 4 February 2011

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 returns to %z 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 returns '
**-95'**to %z:%z = -191.4:div(2.3)

## See also

The `Modulus function` returns the remainder of a division.