7.1.2 "COBOL Language Reference" IBM Library Server

7.1.2 Function Definitions

Table 52provides an overview of the argument type, function type and value returned for each of the intrinsic functions. Argument types and function types are abbreviated as follows:

A = alphabetic
I = integer
N = numeric
X = alphanumeric

X The behavior of functions marked "(DP)" depends on whether the DATEPROC or
X NODATEPROC compiler option is in effect:

X If the DATEPROC compiler option is in effect, the following intrinsic
X functions return date fields:
X Returned value has implicit DATE FORMAT...

X DATE-OF-INTEGER
YYYYXXXX

X DATE-TO-YYYYMMDD
YYYYXXXX

X DAY-OF-INTEGER
YYYYXXX

X DAY-TO-YYYYDDD
YYYYXXX

X YEAR-TO-YYYY
YYYY

X DATEVAL
Depends on the format specified by DATEVAL

X YEARWINDOW
YYYY
X If the NODATEPROC compiler option is in effect:
- X The following intrinsic functions return the same values as when
  X DATEPROC is in effect, but their returned values are non-dates:
  - X DAY-OF-INTEGER
  - X DATE-TO-YYYYMMDD
  - X DAY-TO-YYYYDDD
  - X YEAR-TO-YYYY
- X The DATEVAL and UNDATE intrinsic functions have no effect, and
  X simply return their (first) arguments unchanged
- X The YEARWINDOW intrinsic function returns 0 unconditionally

Function Name	Arguments	Type	Value Returned

Table 52. Table of Functions
ACOS	N1	N	Arccosine of N1
ANNUITY	N1, I2	N	Ratio of annuity paid for I2 periods at interest of N1 to initial investment of one
ASIN	N1	N	Arcsine of N1
ATAN	N1	N	Arctangent of N1
CHAR	I1	X	Character in position I1 of program collating sequence
COS	N1	N	Cosine of N1
CURRENT-DATE	None	X	Current date and time and difference from Greenwich Mean Time
DATE-OF-INTEGER ( X DP)	I1 X	I X	Standard date equivalent X (YYYYMMDD) of integer date
X DATE-TO-YYYYMMDD X (DP) X X X X X	X I1, I2 X X X X X X	X I X X X X X X	X Standard date equivalent X (YYYYMMDD) of I1 (standard date X with a windowed year, YYMMDD), X according to the 100-year X interval whose ending year is X specified by the sum of I2 and X the year at execution time
X DATEVAL (DP) X	X I1 or	X I	X Date field equivalent of I1 or X1 X
X DATEVAL (DP) X	X X1	X X	X Date field equivalent of I1 or X1 X
DAY-OF-INTEGER ( X DP)	I1 X	I X	Julian date equivalent (YYYYDDD) X of integer date
X DAY-TO-YYYYDDD X (DP) X X X X X	X I1, I2 X X X X X X	X I X X X X X X	X Julian date equivalent (YYYYDDD) X of I1 (Julian date with a X windowed year, YYDDD), according X to the 100-year interval whose X ending year is specified by the X sum of I2 and the year at X execution time
FACTORIAL	I1	I	Factorial of I1
INTEGER	N1	I	The greatest integer not greater than N1
INTEGER-OF-DATE	I1	I	Integer date equivalent of standard date (YYYYMMDD)
INTEGER-OF-DAY	I1	I	Integer date equivalent of Julian date (YYYYDDD)
INTEGER-PART	N1	I	Integer part of N1
LENGTH	A1, N1, or X1	I	Length of argument
LOG	N1	N	Natural logarithm of N1
LOG10	N1	N	Logarithm to base 10 of N1
LOWER-CASE	A1 or X1	X	All letters in the argument are set to lowercase
MAX	A1... or	X	Value of maximum argument; note that the type of function depends on the arguments
	I1... or	I
	N1... or	N
	X1...	X
MEAN	N1...	N	Arithmetic mean of arguments
MEDIAN	N1...	N	Median of arguments
MIDRANGE	N1...	N	Mean of minimum and maximum arguments
MIN	A1... or	X	Value of minimum argument; note that the type of function depends on the arguments
	I1... or	I
	N1... or	N
	X1...	X
MOD	I1,I2	I	I1 modulo I2
NUMVAL	X1	N	Numeric value of simple numeric string
NUMVAL-C	X1 or X1,X2	N	Numeric value of numeric string with optional commas and currency sign
ORD	A1 or X1	I	Ordinal position of the argument in collating sequence
ORD-MAX	A1..., N1..., or X1...	I	Ordinal position of maximum argument
ORD-MIN	A1..., N1..., or X1...	I	Ordinal position of minimum argument
PRESENT-VALUE	N1 or N2...	N	Present value of a series of future period-end amounts, N2, at a discount rate of N1
RANDOM	I1, none	N	Random number
RANGE	I1... or	I	Value of maximum argument minus value of minimum argument; note that the type of function depends on the arguments.
RANGE	N1...	N
REM	N1,N2	N	Remainder of N1/N2
REVERSE	A1 or X1	X	Reverse order of the characters of the argument
SIN	N1	N	Sine of N1
SQRT	N1	N	Square root of N1
STANDARD-DEVIATION	N1...	N	Standard deviation of arguments
SUM	I1... or	I	Sum of arguments; note that the type of function depends on the arguments.
SUM	N1...	N
TAN	N1	N	Tangent of N1
X UNDATE (DP) X X	X I1 or X ‘ X X1	X I X ‘ X X	X Non-date equivalent of date field X I1 or X1 X
UPPER-CASE	A1 or X1	X	All letters in the argument are set to uppercase
VARIANCE	N1...	N	Variance of arguments
WHEN-COMPILED	None	X	Date and time when program was compiled
X YEAR-TO-YYYY (DP) X X X X X	X I1, I2 X X X X X	X I X X X X X	X Expanded year equivalent (YYYY) X of I1 (windowed year, YY), X according to the 100-year X interval whose ending year is X specified by the sum of I2 and X the year at execution time
X YEARWINDOW (DP) X X X X X X	X None X X X X X X	X I X X X X X X	X If the DATEPROC compiler option X is in effect, returns the X starting year (in the format X YYYY) of the century window X specified by the YEARWINDOW X compiler option; if NODATEPROC is X in effect, returns 0

The following topics define each of the Intrinsic Functions summarized in the previous table.

Adobe, the Adobe logo, Acrobat, the Acrobat logo, and Acrobat Reader are registered trademarks of Adobe Systems incorporated.

7.1.2 Function Definitions

IBM Library Server Copyright 1989, 2005 IBM Corporation. All rights reserved.