Home
Functions and Expressions
Use HCL Link functions and expressions to create component rules and map rules.
Math and statistics functions
Precede all MATHLIB functions with mathlib->
MOD
Use MOD when you need the modulus of an integer and a number.

Functions and Expressions
Use HCL Link functions and expressions to create component rules and map rules.
- Expressions and evaluations
  The documentation provided here describes HCL Link functions and expressions. Functions and expressions are used to create component rules and map rules.
- Using functions
  A function is an expression that generates an output by performing a certain operation on one or more inputs.
- Syntax of a function
  The following is an example of a function:
- Function argument syntax
  Arguments typically have some restrictions on the expression used for that argument.
- Character-set encoding functions
  Functions that use the HCL Link EXIT architecture convert data to the native character set of the platform as part of the function call.
- General functions
  There are several general functions you can call from map rule to process input.
- Bidirectional functions
  Bidirectional languages such as Arabic and Hebrew are languages in which the text is presented to the user ordered from right to left, but numbers and Latin alphabetic strings within the text are presented left to right.
- Bit manipulation and testing functions
  You can use this function to manipulate and to test a bit in a binary number.
- Cache functions
  Use cache functions to specify a value for each of the cache variables defined for a flow, and additionally, to alter an already specified value for a cache variable.
- Conversion functions
  You can use this function to convert an expression from one datatype to another datatype.
- Date/time functions
  You can use this function to perform various operations on date and time.
- Error handling functions
  You can use this function in evaluating the type of error during map execution.
- External interface functions
  You can use this function to retrieve data from a database from within in a map rule.
- Flow functions
  Use Flow functions to specify a value for each of the flow variables defined for a flow, and additionally, to alter an already specified value for a flow variable.
- Inspection functions
  You can use this function to test and inspect the object.
- Logical functions
  Logical functions provide a way to use logical conditions to display one of several values.
- Lookup and reference functions
  These function search operates by scanning the appropriate set of items in sequence, attempting to match the logical condition.
- Math and statistics functions
  Precede all MATHLIB functions with mathlib->
  - ABS
    The ABS function returns the absolute value of a number.
  - ACOSINE
    Use the ACOSINE function to calculate the arccosine of a value.
  - ASIN
    Use the ASIN function to calculate the arcsine of a value.
  - ATAN
    The ATAN function calculates the arctangent of a value.
  - ATAN2
    The ATAN2 function calculates the arctangent of y,x.
  - COSINE
    The COSINE function calculates the cosine of a value.
  - COSINEH
    The COSINEH function calculates the hyperbolic cosine of a value.
  - COUNT
    You can use the COUNT function to return an integer representing the number of valid input or output objects in a series.
  - COUNTABS
    You can use COUNTABS to count the input or output objects in a series, regardless of the validity of the object.
  - EXP
    The EXP function calculates the exponential of a value.
  - FACTORIAL
    The FACTORIAL function calculates the factorial of a value.
  - FROMBASETEN
    You can use FROMBASETEN when you need to convert numbers to a base other than 10.
  - INT
    You can use the INT function when you need only the integer portion of a number.
  - LOG
    The LOG function calculates the logarithms of a value.
  - LOG10
    The LOG10 function calculates the logarithms for base 10 of a value.
  - MAX
    The MAX function returns the maximum value from a series of number, date, time, or text values.
  - MIN
    Use MIN when you need the minimum value from a series of number, date, time, or text values.
  - MOD
    Use MOD when you need the modulus of an integer and a number.
  - POWER
    The POWER function calculates x raised to the power of y.
  - RAND
    The RAND function returns a pseudorandom number.
  - ROUND
    The ROUND function rounds a number to a specified number of decimal places.
  - SEED
    The SEED function primes the RAND and RANDDATA functions so they produce repeated results.
  - SIN
    The SIN function calculates the sine of a value.
  - SINH
    The SINH function calculates the hyperbolic sine of a value.
  - SQRT
    The SQRT function returns the square root of a number.
  - SUM
    The SUM function calculates the sum of a series of numbers.
  - TAN
    The TAN function calculates the tangent of a value.
  - TANH
    The TANH function calculates the hyperbolic tangent of a value.
  - TOBASETEN
    The TOBASETEN function converts a text item that can be interpreted as a number, using positional notation of the base specified, to a base 10 number.
  - TRUNCATE
    The TRUNCATE function removes decimal places from a number, leaving a specified number of decimal places.
- Text functions
  These functions are used to convert the text item in a map rule.
- XML functions
  There are several XML functions that you can call from component rules and map rules to process input XML data.
- Custom functions
  From the Type Designer or Map Designer, you can create custom functions to call external libraries.
- Date and time format strings
  You can use the listed format strings for numbers, dates and times in functions such as the CURRENTDATETIME, FROMNUMBER, TONUMBER, FROMDATETIME, and TODATETIME.
- Number format strings
  You can create custom number formats by using the given format strings.
- RUN function return codes
  The RUN function return codes and messages might result when using the RUN function.
- Character set codes for CPACKAGE, CSERIESTOTEXT, and CTEXT
  The second argument of the CPACKAGE, CSERIESTOTEXT, and CTEXT functions specifies the character set of the output of the function. The value of the second argument (the character set of the object content), must be a valid character set code.

MOD

Use MOD when you need the modulus of an integer and a number.

The MOD function returns the modulus that remains after a number is divided by an integer.

Syntax:: MOD (single-number-expression, single-integer-expression)
Meaning:: MOD (dividend , divisor)
Returns:: A single integer

The result is the remainder (modulus) after dividend is divided by divisor. The result has the same sign as divisor.

The dividend is first divided by the integer divisor, resulting in a quotient. The modulus is calculated by multiplying the integer portion of the quotient by divisor and then subtracting that product from dividend.

If divisor is 0, MOD returns "none".

Examples

MOD (3, 2) or MOD (-3, 2)
Returns 1
MOD (3, -2) or MOD (-3, -2)
Returns -1
MOD (-3, 2) or MOD (-3, -2)
Returns 1
MOD (-3, -2) or MOD (-3, -2)
Returns -1