This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.
Returns the remainder of X/Y as defined by Euclidean division, i.e.:
Mod[X,Y] = X - Quotient(X/Y)*Y0 <= Mod[X,Y] < Abs(Y)Fails ifY=0.
Verse using statement |
using { /Verse.org/Verse } |
Mod<public><native>(X:int, Y:int)<computes><decides>:int
Parameters
Mod takes the following parameters:
| Name | Type | Description |
|---|---|---|
X |
int |
|
Y |
int |
Attributes, Specifiers, and Effects
Specifiers
The following specifiers determine how you can interact with Mod in your programs. For the complete list of specifiers, see the Specifiers Page.
| Specifier | Meaning |
|---|---|
public |
The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data. |
native |
Indicates that the definition details of the element are implemented in C++. Verse definitions with the native specifier auto-generate C++ definitions that a developer can then fill out its implementation. You can use this specifier on classes, interfaces, enums, methods, and data. |
Effects
The following effects determine how Mod behaves in your programs. For the complete list of effects, see the Effect Specifers section of the Specifiers Page.
| Effect | Meaning |
|---|---|
computes |
This effect requires that the function has no side effects, and is not guaranteed to complete. There's an unchecked requirement that the function, when provided with the same arguments, produces the same result. Any function that doesn't have the native specifier that would otherwise have the converges effect is a good example of using the computes effect. |
decides |
Indicates that the function can fail, and that calling this function is a failable expression. Function definitions with the decides effect must also have the transacts effect, which means the actions performed by this function can be rolled back (as if the actions were never performed), if there's a failure anywhere in the function. |