Core.Terms.Modulo

From emotive
Jump to navigation Jump to search

Classification

Name Modulo
Short Description Returns the remainder of a division
Class Term
Extension OTX Core library
Group Operations
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

NumericValue = NumericTerm1 % NumericTerm2;

Description

Modulo is a NumericTerm which returns the remainder of a division. The following operator can be used: %

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Integer, Float The remainder of a division of the two operands. If one or more operands is of type float, the return value is float. Otherwise, the return value of the type is integer.

Properties

Name Data Type Class Default Cardinality Description
Numeral Integer, Float Term - [1] A numeric term which represents the dividend value
Divisor Integer, Float Term - [1] A numeric term which represents the divisor value

OTL Examples

/// Local Declarations

Integer MyValue1 = 1;
Integer MyValue2 = 5;
Integer Result1;
Float Result2;

/// Flow

Result1 = 17 % MyValue1;
Result2 = 17.5 % MyValue2;

See also

Add
Subtract
Multiply
Divide
Quantities Modulo
AbsoluteValue
Round
Negate