Definitions of Functions

Table 1. Summary of Functions
Function-Name	Arguments	Type	Value Returned
The ABS Function	Int1, or Num1	Depends upon arguments	The absolute value of argument
The ACOS Function	Num1	Num	Arccosine of Num1
The ANNUITY Function	Num1, or Int2	Num	Ratio of annuity paid for Int2 periods at interest of Num1 to initial investment of one
The ASIN Function	Num1	Num	Arcsine of Num1
The ATAN Function	Num1	Num	Arctangent of Num1
The BIT-OF Function	Alph1, or Anum1, or Num1, or Int1, or Nat1 , or UTF81	Anum	Binary representation of argument
The BIT-TO-CHAR Function	Anum1	Anum	Character string of bytes corresponding to binary input
The BYTE-LENGTH Function	Alph1, or Anum1, or Num1, or Int1, or Nat1 , or UTF81	Int	Length, in bytes, of argument
The CHAR Function	Int1	Anum	Character in position Int1 of the alphanumeric program collating sequence
The CHAR-NATIONAL Function	Int1	Nat	Character in position Int1 of the national program collating sequence
The COMBINED-DATETIME Function	Int1, Num2	Num	A single numeric comprising a date and time.
The CONTENT-OF Function	Alph1, or Anum1, or Num1, or Int1, or Nat1 , or UTF81	Depends upon arguments	The contents of the argument
The COS Function	Num1	Num	Cosine of Num1
The CURRENT-DATE Function	None	Anum	Current date and time and difference from Greenwich Mean Time
The DATE-OF-INTEGER Function	Int1	Int	Standard date equivalent (YYYYMMDD) of integer date
The DATE-TO-YYYYMMDD Function	Int1, or Int2	Int	Argument-1 converted from YYMMDD to YYYYMMDD based on the value of argument-2
The DAY-OF-INTEGER Function	Int1	Int	Julian date equivalent (YYYYDDD) of integer date
The DAY-TO-YYYYDDD Function	Int1, or Int2	Int	Argument-1 converted from YYDDD to YYYYDDD based on the value of argument-2
The DISPLAY-OF Function	Num1, or Anum1 , or Nat1 , or UTF81	Anum	Usage display representation of argument Nat1
The E Function	None	Num	The value of `e`, the natural base
The EXP Function	Num1	Num	`e` raised to the power Num1
The EXP10 Function	Num1	Num	10 raised to the power Num1
The FACTORIAL Function	Int1	Int	Factorial of Int1
The FORMATTED-DATE Function	Anum1, or Nat1 , or UTF81, and Int2	Depends upon argument-1	A date string formatted corresponding to arg-1
The FORMATTED-DATETIME Function	Anum1, or Nat1 , or UTF81, and Int2, and Int3, and Int4	Depends upon argument-1	A datetime string formatted corresponding to arg-1
The FORMATTED-CURRENT-DATE	Alph1, or Nat1 , or UTF81	Depends upon argument*	Formatted current date/time
The FORMATTED-TIME Function	Anum1, or Nat1 , or UTF81, and Int2, and Int3	Depends upon argument-1	A time string formatted corresponding to arg-1
The FRACTION-PART Function	Num1	Num	Fraction part of Num1
The HEX-OF Function	Alph1, or Anum1, or Num1, or Int1, or Nat1 , or UTF81	Anum	Hexadecimal representation of argument
The HEX-TO-CHAR Function	Anum1	Anum	Character string of bytes corresponding to hexadecimal input
The INTEGER Function	Num1	Int	The greatest integer not greater than Num1
The INTEGER-OF-DATE Function	Int1	Int	The integer date equivalent of standard date (YYYYMMDD)
The INTEGER-OF-DAY Function	Int1	Int	The integer date equivalent of Julian date (YYYYDDD)
The INTEGER-OF-FORMATTED-DATE Function	Anum1, or Nat1 , or UTF81	Int	The integer date equivalent of a given date
The INTEGER-PART Function	Num1	Int	Integer part of Num1
The LENGTH Function	Alph1, or Anum1, or Num1 , or Nat1 , or UTF81	Int	Length of argument in number of character positions
The LENGTH-AN Function	Alph1, or Anum1, or Int1, or Nat1, or Num1	Int	Length of argument in number of alphanumeric character positions
The LOG Function	Num1	Num	Natural logarithm of Num1
The LOG10 Function	Num1	Num	Logarithm to base 10 of Num1
The LOWER-CASE Function	Alph1, or Anum1, or Nat1 , or UTF81	Depends upon argument*	All letters in the argument are set to lowercase
The MAX Function	Alph1 ..., or Anum1 ..., or Int1 ..., or Nat1 ... , or Num1 ...	Depends upon arguments*	Value of maximum argument
The MEAN Function	Num1 ...	Num	Arithmetic mean of arguments
The MEDIAN Function	Num1 ...	Num	Median of arguments
The MIDRANGE Function	Num1 ...	Num	Mean of minimum and maximum arguments
The MIN Function	Alph1 ..., or Anum1 ..., or Int1 ..., or Nat1 ..., or Num1 ...	Depends upon arguments*	Value of minimum argument
The MOD Function	Int1, or Int2	Int	Int1 modulo Int2
The NATIONAL-OF Function	Anum1, or Num1 , or Nat1 , or UTF81	Nat	Usage national representation of argument Anum1
The NUMVAL Function	Anum1, or Nat1	Num	Numeric value of simple numeric string
The NUMVAL-C Function	Anum1 and Anum2, or Nat1 and Nat2	Num	Numeric value of numeric string with optional commas and currency string
The NUMVAL-F Function	Anum1, or Nat1	Num	A floating-point approximation of the numeric value represented by Anum1 or Nat1
The ORD Function	Alph1, or Anum1, or Nat1	Int	Ordinal position of the argument in collating sequence
The ORD-MAX Function	Alph1 ..., or Anum1 ..., or Nat1 ... , or Num1 ...	Int	Ordinal position of maximum argument
The ORD-MIN Function	Alph1 ..., or Anum1 ..., or Nat1 ... , or Num1 ...	Int	Ordinal position of minimum argument
The PI Function	None	Num	Value of
The PRESENT-VALUE Function	Num1 ..., or Num2 ...	Num	Present value of a series of future period-end amounts, Num2, at a discount rate of Num1
The RANDOM Function	Int1	Num	Random number
The RANGE Function	Int1 ..., or Num1 ...	Depends upon arguments*	Value of maximum argument minus value of minimum arguments
The REM Function	Num1, or Num2	Num	Remainder of Num1/Num2
The REVERSE Function	Alph1, or Anum1, or Nat1	Depends upon argument*	Reverse order of the characters of the argument
The SECONDS-FROM-FORMATTED-TIME Function	Anum1, or Nat1 , or UTF81	Num	A numeric value representing a formatted time past midnight
The SECONDS-PAST-MIDNIGHT Function	None	Num	A numeric value representing the number of seconds past midnight
The SIGN Function	Num1	Int	The sign of Num1
The SIN Function	Num1	Num	Sine of Num1
The SQRT Function	Num1	Num	Square root of Num1
The STANDARD-DEVIATION Function	Num1 ...	Num	Standard deviation of arguments
The SUM Function	Int1 ..., or Num1 ...	Depends upon arguments	Sum of arguments
The TAN Function	Num1	Num	Tangent of Num1
The TEST-DATE-YYYYMMDD Function	Num1	Num	Numerical value indicating validity
The TEST-DAY-YYYYDDD Function	Num1	Num	Numerical value indicating validity
The TEST-FORMATTED-DATETIME Function	Anum1, or Nat1 , or UTF81	Int	A positive integer representing the given date as the number of days succeeding 31 December, 1600 in the Gregorian calendar
The TEST-NUMVAL Function	Anum1, or Nat1	Int	Zero if argument conforms to NUMVAL function specification, or numeric value indicating the position of first character that doesn't conform.
The TEST-NUMVAL-C Function	Anum1, or Nat1	Int	Zero if argument conforms to NUMVAL-C function specification, or numeric value indicating the position of first character that doesn't conform.
The TEST-NUMVAL-F Function	Anum1, or Nat1	Int	Zero if argument conforms to NUMVAL-C function specification, or numeric value indicating the position of first character that doesn't conform.
The TRIM Function	Alph1, or Anum1, or Nat1 , or UTF81	Depends upon argument*	Argument with leading spaces, trailing spaces, or both, removed
The ULENGTH Function	Alph1, or Anum1, or Nat1 , or UTF81	Int	Number of characters in `argument-1`
The UPOS Function	Alph1, or Anum1, or Int1, or Nat1 , or UTF81	Int	Position of `n`th UTF-8 or UTF-16 char in `argument-1`
The UPPER-CASE Function	Alph1, or Anum1, or Nat1 , or UTF81	Depends upon argument*	All letters in the argument are set to uppercase
The USUBSTR Function	Alph1, or Anum1, or Num1, or Num2, or Nat1 , or UTF81	Anum	Substring of a character string argument that is encoded in UTF-8 or UTF-16
The USUPPLEMENTARY Function	Alph1, or Anum1, or Nat1 , or UTF81	Int	Integer value that is equal to the index of the first Unicode supplementary character in a character string argument that is encoded in UTF-8 or UTF-16
The UUID4 Function	None	Anum	A unique 36-character identifier
The UVALID Function	Alph1, or Anum1, or Nat1 , or UTF81	Int	Zero if character string consists of valid Unicode UTF-8 or UTF-16 data; non-zero if not.
The UWIDTH Function	Alph1, or Anum1, or Int1, or Nat1 , or UTF81	Int	integer value that is equal to the width in bytes of the `n`th UTF-8 or UTF-16 character in a character string
The VARIANCE Function	Num1 ...	Num	Variance of argument
The WHEN-COMPILED Function	None	Anum	Date and time program was compiled
The YEAR-TO-YYYY Function	Int1, or Int2	Int	Argument-1 converted from YY to YYYY based on the value of argument-2

The ABS Function
The ABS function returns the absolute value of the argument.

The ACOS Function
The ACOS function returns a numeric value in radians that approximates the arccosine of argument-1. The type of this function is numeric.

The ANNUITY Function
The ANNUITY function (annuity immediate) returns a numeric value that approximates the ratio of an annuity paid at the end of each period for the number of periods specified by argument-2 to an initial investment of one. Interest is earned at the rate specified by argument-1 and is applied at the end of the period, before the payment. The type of this function is numeric.

The ASIN Function
The ASIN function returns a numeric value in radians that approximates the arcsine of argument-1. The type of this function is numeric.

The ATAN Function
The ATAN function returns a numeric value in radians that approximates the arctangent of argument-1. The type of this function is numeric.

The BIT-OF Function
The BIT-OF function returns an alphanumeric character string of '1' and '0' characters, which represents the binary value of each byte in the argument used on input.

The BIT-TO-CHAR Function
The BIT-TO-CHAR function returns a character string that represents a bit pattern supplied on input.

The BOOLEAN-OF-INTEGER Statement
The BOOLEAN-OF-INTEGER function returns a boolean item of usage bit representing the binary value of argument-1. Argument-2 specifies the length of the boolean data item that is returned.

The BYTE-LENGTH Function

The CHAR Function
The CHAR function returns a one-character alphanumeric value that is a character in the program collating sequence having the ordinal position equal to the value of argument-1. The type of this function is alphanumeric.

The CHAR-NATIONAL Function
The CHAR-NATIONAL (national character) function returns a one-character value that is a character in the national program collating sequence having the ordinal position equal to the value of the argument.

The COMBINED-DATETIME function
The COMBINED-DATETIME function returns a single numeric item representing a date time combination from a supplied date in integer date form and a time in standard numeric time.

The CONTENT-OF Function
The CONTENT-OF function returns the content of the specified argument. The type of this function depends on the argument type.

The COS Function
The COS function returns a numeric value that approximates the cosine of an angle or arc, expressed in radians, that is specified by argument-1. The type of this function is numeric.

The CURRENT-DATE Function
The CURRENT-DATE function returns a 21-character alphanumeric value that represents the calendar date, time of day, and local time differential factor provided by the system on which the function is evaluated. The type of this function is alphanumeric.

The DATE-OF-INTEGER Function
The DATE-OF-INTEGER function converts a date in the Gregorian calendar from integer date form to standard date form (YYYYMMDD). The type of this function is integer.

The DATE-TO-YYYYMMDD Function
The DATE-TO-YYYYMMDD function converts argument-1 from the form YYmmdd to the form YYYYmmdd. Argument-2, when added to the year at the time of execution, defines the ending year of a 100-year interval, or sliding window, into which the year of argument-1 falls. The type of this function is integer.

The DAY-OF-INTEGER Function
The DAY-OF-INTEGER function converts a date in the Gregorian calendar from integer date form to Julian date form (YYYYDDD). The type of this function is integer.

The DAY-TO-YYYYDDD Function
The DAY-TO-YYYYDDD function converts argument-1 from the form YYnnn to the form YYYYnnn. Argument-2, when added to the year at the time of execution, defines the ending year of a 100-year interval, or sliding window, into which the year of argument-1 falls. The type of this function is integer.

The DISPLAY-OF Function
The DISPLAY-OF function returns a character string containing the alphanumeric character representation - the external format representation - of a national or UTF-8 character string.

The E Function
The E function returns an approximation of e, the base of natural logarithms.

The EXP Function
The EXP function returns an approximation of the value of e raised to the power of the argument.

The EXP10 Function
The EXP10 function returns an approximation of the value of 10 raised to the power of the argument.

The FACTORIAL Function
The FACTORIAL function returns an integer that is the factorial of argument-1. The type of this function is integer.

The FORMATTED-CURRENT-DATE Function
The FORMATTED-CURRENT-DATE function returns the current date and time in the specified format.

The FORMATTED-DATE function
The FORMATTED-DATE function returns a date string in the requested format from a supplied date in integer date form.

The FORMATTED-DATETIME function
The FORMATTED-DATETIME function returns a combined date time string, in a requested format, from a supplied date in integer date form and time in standard numeric time form.

The FORMATTED-TIME function
The FORMATTED-TIME function returns a time string, in a requested format, from a supplied time in standard numeric time form.

The FRACTION-PART Function
The FRACTION-PART function returns a numeric value that is the fraction portion of the argument.

The HEX-OF Function
The HEX-OF function returns an alphanumeric character string consisting of a hexadecimal representation of the argument used on input.

The HEX-TO-CHAR Function
The HEX-TO-CHAR function returns a character string that represents the hexadecimal digit characters supplied on input.

The INTEGER Function
The INTEGER function returns the greatest integer value that is less than or equal to the argument. The type of this function is integer.

The INTEGER-OF-BOOLEAN Statement
The INTEGER-OF-BOOLEAN function returns the numeric value of the boolean string in argument-1.

The INTEGER-OF-DATE Function
The INTEGER-OF-DATE function converts a date in the Gregorian calendar from standard date form (YYYYMMDD) to integer date form. The type of this function is integer.

The INTEGER-OF-DAY Function
The INTEGER-OF-DAY function converts a date in the Gregorian calendar from Julian date form (YYYYDDD) to integer date form. The type of this function is integer.

The INTEGER-OF-FORMATTED-DATE Function
The INTEGER-OF-FORMATTED-DATE function returns an integer data format representing a specified date.

The INTEGER-PART Function
The INTEGER-PART function returns an integer that is the integer portion of argument-1. The type of this function is integer.

The LENGTH Function
The LENGTH function returns an integer equal to the length of the argument in alphanumeric

, national or UTF-8 character positions, depending on the class of the argument.

The LENGTH-AN Function
The LENGTH-AN function returns an integer equal to the length of the argument in number of alphanumeric character positions.

The LOG Function
The LOG function returns a numeric value that approximates the logarithm to the base e (natural log) of argument-1. The type of this function is numeric.

The LOG10 Function
The LOG10 function returns a numeric value that approximates the logarithm to the base 10 of argument-1. The type of this function is numeric.

The LOWER-CASE Function
The LOWER-CASE function returns a character string that is the same length as argument-1 with each upper-case letter replaced by the corresponding lower-case letter. The type of this function depends on the argument as follows:

The MAX Function
The MAX function returns the content of the argument-1 that contains the maximum value. The type of this function depends upon the argument types as follows:

The MEAN Function
The MEAN function returns a numeric value that is the arithmetic mean (average) of its arguments. The type of this function is numeric.

The MEDIAN Function
The MEDIAN function returns the content of the argument whose value is the middle value in the list formed by arranging the arguments in sorted order. The type of this function is numeric.

The MIDRANGE Function
The MIDRANGE (middle range) function returns a numeric value that is the arithmetic mean (average) of the values of the minimum argument and the maximum argument. The type of this function is numeric.

The MIN Function
The MIN function returns the content of the argument-1 that contains the minimum value. The type of this function depends upon the argument types as follows:

The MOD Function
The MOD function returns an integer value that is argument-1 modulo argument-2. The type of this function is integer.

The NATIONAL-OF Function
The NATIONAL-OF function returns a character string containing the national character internal representation of the characters in the argument.

The NUMVAL Function
The NUMVAL function returns the numeric value represented by the character string specified by argument-1. Leading and trailing spaces are ignored. The type of this function is numeric.

The NUMVAL-C Function
The NUMVAL-C function returns the numeric value represented by the character string specified by argument-1. Any optional currency string specified by argument-2 and any optional commas preceding the decimal point are ignored. The type of this function is numeric.

The NUMVAL-F Function
The NUMVAL-F function returns the numeric value represented by the alphanumeric character string or national character string specified by argument-1. Leading or trailing spaces in the string are removed from the resulting numeric value.

The ORD Function
The ORD function returns an integer value that is the ordinal position of argument-1 in the collating sequence for the program. The lowest ordinal position is 1. The type of this function is integer.

The ORD-MAX Function
The ORD-MAX function returns a value that is the ordinal number of the argument-1 that contains the maximum value. The type of this function is integer.

The ORD-MIN Function
The ORD-MIN function returns a value that is the ordinal number of the argument-1 that contains the minimum value. The type of this function is integer.

The PI Function
The PI function returns a value that is an approximation of the ratio of the circumference of a circle to its diameter.

The PRESENT-VALUE Function
The PRESENT-VALUE function returns a value that approximates the present value of a series of future period-end amounts specified by argument-2 at a discount rate specified by argument-1. The type of this function is numeric.

The RANDOM Function
The RANDOM function returns a numeric value that is a pseudo-random number from a rectangular distribution. The type of this function is numeric.

The RANGE Function
The RANGE function returns a value that is equal to the value of the maximum argument minus the value of the minimum argument. The type of this function depends upon the argument types as follows:

The REM Function
The REM function returns a numeric value that is the remainder of argument-1 divided by argument-2. The type of this function is numeric.

The REVERSE Function
The REVERSE function returns a character string whose length and characters are exactly the same as argument-1, except that the characters are in reverse order.

The SECONDS-FROM-FORMATTED-TIME Function
The SECONDS-FROM-FORMATTED-TIME function returns a numeric value representing the number of seconds after midnight for a given time.

The SECONDS-PAST-MIDNIGHT Function
The SECONDS-PAST-MIDNIGHT function returns a numeric value representing the number of seconds after midnight for the current time.

The SIGN Function
The SIGN function returns +1, 0, or -1 depending on the sign of the argument.

The SIN Function
The SIN function returns a numeric value that approximates the sine of an angle or arc, expressed in radians, that is specified by argument-1. The type of this function is numeric.

The SQRT Function
The SQRT function returns a numeric value that approximates the square root of argument-1. The type of this function is numeric.

The STANDARD-DEVIATION Function
The STANDARD-DEVIATION function returns a numeric value that approximates the standard deviation of its arguments. The type of this function is numeric.

The SUM Function
The SUM function returns a value that is the sum of the arguments. The type of this function depends upon the argument types as follows:

The TAN Function
The TAN function returns a value that approximates the tangent of an angle or arc, expressed in radians, that is specified by argument-1. The type of this function is numeric.

The TEST-DATE-YYYYMMDD Function
The TEST-DATE-YYYYMMDD function tests the validity of a date in standard date form (YYYYMMDD) against the Gregorian calendar.

The TEST-DAY-YYYYDDD Function
The TEST-DAY-YYYYDDD function tests the validity of a date in Julian date form (YYYYDDD) against the Gregorian calendar

The TEST-FORMATTED-DATETIME Function
The TEST-FORMATTED-DATETIME function tests the validity of a specified date, time or combined-datetime according to the format specified.

The TEST-NUMVAL Function
The TEST-NUMVAL function verifies that argument-1 adheres to the specification for the NUMVAL function.

The TEST-NUMVAL-C Function
The TEST-NUMVAL-C function verifies that the contents of argument-1 adheres to the specification for the NUMVAL-C function.

The TEST-NUMVAL-F Function
The TEST-NUMVAL-F function verifies that the contents of argument-1 adheres to the specification for the NUMVAL-F function.

The TRIM Function
The TRIM function returns a character string that trims the leading and/or trailing spaces from the argument supplied on input.

The ULENGTH Function
The ULENGTH function returns an integer value that is equal to the number of UTF-8 or UTF-16 characters in a character string that contains UTF-8 or UTF-16 data.

The UPOS Function
The UPOS function returns an integer value that is equal to the index of the nth UTF-8 or UTF-16 character in a character string argument that is encoded in UTF-8 or UTF-16.

The USUBSTR Function
The USUBSTR function returns a substring of the data in a character data item argument that contains UTF-8 or UTF-16 data. The type of this function depends on the argument as follows:

The USUPPLEMENTARY Function
The USUPPLEMENTARY function returns an integer value that is equal to the index of the first Unicode supplementary character in a character string argument that is encoded in UTF-8 or UTF-16.

The UUID4 Function
The UUID4 function returns a unique 36-character identifier each time it is called with subsequent calls returning a different identifier.

The UVALID Function
If a character string consists of valid Unicode UTF-8 or UTF-16 data, the UVALID function returns the value zero. If a character string contains invalid Unicode data, the UVALID function returns the index of the first invalid element.

The UWIDTH Function
The UWIDTH function returns an integer value that is equal to the width in bytes of the nth UTF-8 or UTF-16 character in a character string argument that is encoded in UTF-8 or UTF-16.

The UPPER-CASE Function
The UPPER-CASE function returns a character string that is the same length as argument-1 with each lower-case letter replaced by the corresponding upper-case letter. The type of this function depends on the argument as follows:

The VARIANCE Function
The VARIANCE function returns a numeric value that approximates the variance of its arguments. The type of this function is numeric.

The WHEN-COMPILED Function
The WHEN-COMPILED function returns the date and time the program was compiled. The type of this function is alphanumeric.

The YEAR-TO-YYYY Function
The YEAR-TO-YYYY function converts argument-1, the two low-order digits of a year, to a four-digit year. Argument-2, when added to the year at the time of execution, defines the ending year of a 100-year interval, or sliding window, into which the year of argument-1 falls. The type of this function is integer.

Alph	means alphabetic
Anum	means alphanumeric
Int	means integer
Nat	means national
Num	means numeric
UTF8	means UTF-8