2 Copyright (C) 2005, 2006, 2007, 2008
3 Free Software Foundation, Inc.
4 This is part of the GNU Fortran manual.
5 For copying conditions, see the file gfortran.texi.
7 Permission is granted to copy, distribute and/or modify this document
8 under the terms of the GNU Free Documentation License, Version 1.2 or
9 any later version published by the Free Software Foundation; with the
10 Invariant Sections being ``Funding Free Software'', the Front-Cover
11 Texts being (a) (see below), and with the Back-Cover Texts being (b)
12 (see below). A copy of the license is included in the gfdl(7) man page.
15 Some basic guidelines for editing this document:
17 (1) The intrinsic procedures are to be listed in alphabetical order.
18 (2) The generic name is to be used.
19 (3) The specific names are included in the function index and in a
20 table at the end of the node (See ABS entry).
21 (4) Try to maintain the same style for each entry.
27 \gdef\acos{\mathop{\rm acos}\nolimits}
28 \gdef\asin{\mathop{\rm asin}\nolimits}
29 \gdef\atan{\mathop{\rm atan}\nolimits}
30 \gdef\acosh{\mathop{\rm acosh}\nolimits}
31 \gdef\asinh{\mathop{\rm asinh}\nolimits}
32 \gdef\atanh{\mathop{\rm atanh}\nolimits}
36 @node Intrinsic Procedures
37 @chapter Intrinsic Procedures
38 @cindex intrinsic procedures
41 * Introduction: Introduction to Intrinsics
42 * @code{ABORT}: ABORT, Abort the program
43 * @code{ABS}: ABS, Absolute value
44 * @code{ACCESS}: ACCESS, Checks file access modes
45 * @code{ACHAR}: ACHAR, Character in @acronym{ASCII} collating sequence
46 * @code{ACOS}: ACOS, Arccosine function
47 * @code{ACOSH}: ACOSH, Hyperbolic arccosine function
48 * @code{ADJUSTL}: ADJUSTL, Left adjust a string
49 * @code{ADJUSTR}: ADJUSTR, Right adjust a string
50 * @code{AIMAG}: AIMAG, Imaginary part of complex number
51 * @code{AINT}: AINT, Truncate to a whole number
52 * @code{ALARM}: ALARM, Set an alarm clock
53 * @code{ALL}: ALL, Determine if all values are true
54 * @code{ALLOCATED}: ALLOCATED, Status of allocatable entity
55 * @code{AND}: AND, Bitwise logical AND
56 * @code{ANINT}: ANINT, Nearest whole number
57 * @code{ANY}: ANY, Determine if any values are true
58 * @code{ASIN}: ASIN, Arcsine function
59 * @code{ASINH}: ASINH, Hyperbolic arcsine function
60 * @code{ASSOCIATED}: ASSOCIATED, Status of a pointer or pointer/target pair
61 * @code{ATAN}: ATAN, Arctangent function
62 * @code{ATAN2}: ATAN2, Arctangent function
63 * @code{ATANH}: ATANH, Hyperbolic arctangent function
64 * @code{BESSEL_J0}: BESSEL_J0, Bessel function of the first kind of order 0
65 * @code{BESSEL_J1}: BESSEL_J1, Bessel function of the first kind of order 1
66 * @code{BESSEL_JN}: BESSEL_JN, Bessel function of the first kind
67 * @code{BESSEL_Y0}: BESSEL_Y0, Bessel function of the second kind of order 0
68 * @code{BESSEL_Y1}: BESSEL_Y1, Bessel function of the second kind of order 1
69 * @code{BESSEL_YN}: BESSEL_YN, Bessel function of the second kind
70 * @code{BIT_SIZE}: BIT_SIZE, Bit size inquiry function
71 * @code{BTEST}: BTEST, Bit test function
72 * @code{C_ASSOCIATED}: C_ASSOCIATED, Status of a C pointer
73 * @code{C_F_POINTER}: C_F_POINTER, Convert C into Fortran pointer
74 * @code{C_F_PROCPOINTER}: C_F_PROCPOINTER, Convert C into Fortran procedure pointer
75 * @code{C_FUNLOC}: C_FUNLOC, Obtain the C address of a procedure
76 * @code{C_LOC}: C_LOC, Obtain the C address of an object
77 * @code{C_SIZEOF}: C_SIZEOF, Size in bytes of an expression
78 * @code{CEILING}: CEILING, Integer ceiling function
79 * @code{CHAR}: CHAR, Integer-to-character conversion function
80 * @code{CHDIR}: CHDIR, Change working directory
81 * @code{CHMOD}: CHMOD, Change access permissions of files
82 * @code{CMPLX}: CMPLX, Complex conversion function
83 * @code{COMMAND_ARGUMENT_COUNT}: COMMAND_ARGUMENT_COUNT, Get number of command line arguments
84 * @code{COMPLEX}: COMPLEX, Complex conversion function
85 * @code{CONJG}: CONJG, Complex conjugate function
86 * @code{COS}: COS, Cosine function
87 * @code{COSH}: COSH, Hyperbolic cosine function
88 * @code{COUNT}: COUNT, Count occurrences of TRUE in an array
89 * @code{CPU_TIME}: CPU_TIME, CPU time subroutine
90 * @code{CSHIFT}: CSHIFT, Circular shift elements of an array
91 * @code{CTIME}: CTIME, Subroutine (or function) to convert a time into a string
92 * @code{DATE_AND_TIME}: DATE_AND_TIME, Date and time subroutine
93 * @code{DBLE}: DBLE, Double precision conversion function
94 * @code{DCMPLX}: DCMPLX, Double complex conversion function
95 * @code{DFLOAT}: DFLOAT, Double precision conversion function
96 * @code{DIGITS}: DIGITS, Significant digits function
97 * @code{DIM}: DIM, Positive difference
98 * @code{DOT_PRODUCT}: DOT_PRODUCT, Dot product function
99 * @code{DPROD}: DPROD, Double product function
100 * @code{DREAL}: DREAL, Double real part function
101 * @code{DTIME}: DTIME, Execution time subroutine (or function)
102 * @code{EOSHIFT}: EOSHIFT, End-off shift elements of an array
103 * @code{EPSILON}: EPSILON, Epsilon function
104 * @code{ERF}: ERF, Error function
105 * @code{ERFC}: ERFC, Complementary error function
106 * @code{ERFC_SCALED}: ERFC_SCALED, Exponentially-scaled complementary error function
107 * @code{ETIME}: ETIME, Execution time subroutine (or function)
108 * @code{EXIT}: EXIT, Exit the program with status.
109 * @code{EXP}: EXP, Exponential function
110 * @code{EXPONENT}: EXPONENT, Exponent function
111 * @code{FDATE}: FDATE, Subroutine (or function) to get the current time as a string
112 * @code{FGET}: FGET, Read a single character in stream mode from stdin
113 * @code{FGETC}: FGETC, Read a single character in stream mode
114 * @code{FLOAT}: FLOAT, Convert integer to default real
115 * @code{FLOOR}: FLOOR, Integer floor function
116 * @code{FLUSH}: FLUSH, Flush I/O unit(s)
117 * @code{FNUM}: FNUM, File number function
118 * @code{FPUT}: FPUT, Write a single character in stream mode to stdout
119 * @code{FPUTC}: FPUTC, Write a single character in stream mode
120 * @code{FRACTION}: FRACTION, Fractional part of the model representation
121 * @code{FREE}: FREE, Memory de-allocation subroutine
122 * @code{FSEEK}: FSEEK, Low level file positioning subroutine
123 * @code{FSTAT}: FSTAT, Get file status
124 * @code{FTELL}: FTELL, Current stream position
125 * @code{GAMMA}: GAMMA, Gamma function
126 * @code{GERROR}: GERROR, Get last system error message
127 * @code{GETARG}: GETARG, Get command line arguments
128 * @code{GET_COMMAND}: GET_COMMAND, Get the entire command line
129 * @code{GET_COMMAND_ARGUMENT}: GET_COMMAND_ARGUMENT, Get command line arguments
130 * @code{GETCWD}: GETCWD, Get current working directory
131 * @code{GETENV}: GETENV, Get an environmental variable
132 * @code{GET_ENVIRONMENT_VARIABLE}: GET_ENVIRONMENT_VARIABLE, Get an environmental variable
133 * @code{GETGID}: GETGID, Group ID function
134 * @code{GETLOG}: GETLOG, Get login name
135 * @code{GETPID}: GETPID, Process ID function
136 * @code{GETUID}: GETUID, User ID function
137 * @code{GMTIME}: GMTIME, Convert time to GMT info
138 * @code{HOSTNM}: HOSTNM, Get system host name
139 * @code{HUGE}: HUGE, Largest number of a kind
140 * @code{HYPOT}: HYPOT, Euclidian distance function
141 * @code{IACHAR}: IACHAR, Code in @acronym{ASCII} collating sequence
142 * @code{IAND}: IAND, Bitwise logical and
143 * @code{IARGC}: IARGC, Get the number of command line arguments
144 * @code{IBCLR}: IBCLR, Clear bit
145 * @code{IBITS}: IBITS, Bit extraction
146 * @code{IBSET}: IBSET, Set bit
147 * @code{ICHAR}: ICHAR, Character-to-integer conversion function
148 * @code{IDATE}: IDATE, Current local time (day/month/year)
149 * @code{IEOR}: IEOR, Bitwise logical exclusive or
150 * @code{IERRNO}: IERRNO, Function to get the last system error number
151 * @code{INDEX}: INDEX intrinsic, Position of a substring within a string
152 * @code{INT}: INT, Convert to integer type
153 * @code{INT2}: INT2, Convert to 16-bit integer type
154 * @code{INT8}: INT8, Convert to 64-bit integer type
155 * @code{IOR}: IOR, Bitwise logical or
156 * @code{IRAND}: IRAND, Integer pseudo-random number
157 * @code{IS_IOSTAT_END}: IS_IOSTAT_END, Test for end-of-file value
158 * @code{IS_IOSTAT_EOR}: IS_IOSTAT_EOR, Test for end-of-record value
159 * @code{ISATTY}: ISATTY, Whether a unit is a terminal device
160 * @code{ISHFT}: ISHFT, Shift bits
161 * @code{ISHFTC}: ISHFTC, Shift bits circularly
162 * @code{ISNAN}: ISNAN, Tests for a NaN
163 * @code{ITIME}: ITIME, Current local time (hour/minutes/seconds)
164 * @code{KILL}: KILL, Send a signal to a process
165 * @code{KIND}: KIND, Kind of an entity
166 * @code{LBOUND}: LBOUND, Lower dimension bounds of an array
167 * @code{LEADZ}: LEADZ, Number of leading zero bits of an integer
168 * @code{LEN}: LEN, Length of a character entity
169 * @code{LEN_TRIM}: LEN_TRIM, Length of a character entity without trailing blank characters
170 * @code{LOG_GAMMA}: LOG_GAMMA, Logarithm of the Gamma function
171 * @code{LGE}: LGE, Lexical greater than or equal
172 * @code{LGT}: LGT, Lexical greater than
173 * @code{LINK}: LINK, Create a hard link
174 * @code{LLE}: LLE, Lexical less than or equal
175 * @code{LLT}: LLT, Lexical less than
176 * @code{LNBLNK}: LNBLNK, Index of the last non-blank character in a string
177 * @code{LOC}: LOC, Returns the address of a variable
178 * @code{LOG}: LOG, Logarithm function
179 * @code{LOG10}: LOG10, Base 10 logarithm function
180 * @code{LOGICAL}: LOGICAL, Convert to logical type
181 * @code{LONG}: LONG, Convert to integer type
182 * @code{LSHIFT}: LSHIFT, Left shift bits
183 * @code{LSTAT}: LSTAT, Get file status
184 * @code{LTIME}: LTIME, Convert time to local time info
185 * @code{MALLOC}: MALLOC, Dynamic memory allocation function
186 * @code{MATMUL}: MATMUL, matrix multiplication
187 * @code{MAX}: MAX, Maximum value of an argument list
188 * @code{MAXEXPONENT}: MAXEXPONENT, Maximum exponent of a real kind
189 * @code{MAXLOC}: MAXLOC, Location of the maximum value within an array
190 * @code{MAXVAL}: MAXVAL, Maximum value of an array
191 * @code{MCLOCK}: MCLOCK, Time function
192 * @code{MCLOCK8}: MCLOCK8, Time function (64-bit)
193 * @code{MERGE}: MERGE, Merge arrays
194 * @code{MIN}: MIN, Minimum value of an argument list
195 * @code{MINEXPONENT}: MINEXPONENT, Minimum exponent of a real kind
196 * @code{MINLOC}: MINLOC, Location of the minimum value within an array
197 * @code{MINVAL}: MINVAL, Minimum value of an array
198 * @code{MOD}: MOD, Remainder function
199 * @code{MODULO}: MODULO, Modulo function
200 * @code{MOVE_ALLOC}: MOVE_ALLOC, Move allocation from one object to another
201 * @code{MVBITS}: MVBITS, Move bits from one integer to another
202 * @code{NEAREST}: NEAREST, Nearest representable number
203 * @code{NEW_LINE}: NEW_LINE, New line character
204 * @code{NINT}: NINT, Nearest whole number
205 * @code{NOT}: NOT, Logical negation
206 * @code{NULL}: NULL, Function that returns an disassociated pointer
207 * @code{OR}: OR, Bitwise logical OR
208 * @code{PACK}: PACK, Pack an array into an array of rank one
209 * @code{PERROR}: PERROR, Print system error message
210 * @code{PRECISION}: PRECISION, Decimal precision of a real kind
211 * @code{PRESENT}: PRESENT, Determine whether an optional dummy argument is specified
212 * @code{PRODUCT}: PRODUCT, Product of array elements
213 * @code{RADIX}: RADIX, Base of a data model
214 * @code{RANDOM_NUMBER}: RANDOM_NUMBER, Pseudo-random number
215 * @code{RANDOM_SEED}: RANDOM_SEED, Initialize a pseudo-random number sequence
216 * @code{RAND}: RAND, Real pseudo-random number
217 * @code{RANGE}: RANGE, Decimal exponent range
218 * @code{RAN}: RAN, Real pseudo-random number
219 * @code{REAL}: REAL, Convert to real type
220 * @code{RENAME}: RENAME, Rename a file
221 * @code{REPEAT}: REPEAT, Repeated string concatenation
222 * @code{RESHAPE}: RESHAPE, Function to reshape an array
223 * @code{RRSPACING}: RRSPACING, Reciprocal of the relative spacing
224 * @code{RSHIFT}: RSHIFT, Right shift bits
225 * @code{SCALE}: SCALE, Scale a real value
226 * @code{SCAN}: SCAN, Scan a string for the presence of a set of characters
227 * @code{SECNDS}: SECNDS, Time function
228 * @code{SECOND}: SECOND, CPU time function
229 * @code{SELECTED_CHAR_KIND}: SELECTED_CHAR_KIND, Choose character kind
230 * @code{SELECTED_INT_KIND}: SELECTED_INT_KIND, Choose integer kind
231 * @code{SELECTED_REAL_KIND}: SELECTED_REAL_KIND, Choose real kind
232 * @code{SET_EXPONENT}: SET_EXPONENT, Set the exponent of the model
233 * @code{SHAPE}: SHAPE, Determine the shape of an array
234 * @code{SIGN}: SIGN, Sign copying function
235 * @code{SIGNAL}: SIGNAL, Signal handling subroutine (or function)
236 * @code{SIN}: SIN, Sine function
237 * @code{SINH}: SINH, Hyperbolic sine function
238 * @code{SIZE}: SIZE, Function to determine the size of an array
239 * @code{SIZEOF}: SIZEOF, Determine the size in bytes of an expression
240 * @code{SLEEP}: SLEEP, Sleep for the specified number of seconds
241 * @code{SNGL}: SNGL, Convert double precision real to default real
242 * @code{SPACING}: SPACING, Smallest distance between two numbers of a given type
243 * @code{SPREAD}: SPREAD, Add a dimension to an array
244 * @code{SQRT}: SQRT, Square-root function
245 * @code{SRAND}: SRAND, Reinitialize the random number generator
246 * @code{STAT}: STAT, Get file status
247 * @code{SUM}: SUM, Sum of array elements
248 * @code{SYMLNK}: SYMLNK, Create a symbolic link
249 * @code{SYSTEM}: SYSTEM, Execute a shell command
250 * @code{SYSTEM_CLOCK}: SYSTEM_CLOCK, Time function
251 * @code{TAN}: TAN, Tangent function
252 * @code{TANH}: TANH, Hyperbolic tangent function
253 * @code{TIME}: TIME, Time function
254 * @code{TIME8}: TIME8, Time function (64-bit)
255 * @code{TINY}: TINY, Smallest positive number of a real kind
256 * @code{TRAILZ}: TRAILZ, Number of trailing zero bits of an integer
257 * @code{TRANSFER}: TRANSFER, Transfer bit patterns
258 * @code{TRANSPOSE}: TRANSPOSE, Transpose an array of rank two
259 * @code{TRIM}: TRIM, Remove trailing blank characters of a string
260 * @code{TTYNAM}: TTYNAM, Get the name of a terminal device.
261 * @code{UBOUND}: UBOUND, Upper dimension bounds of an array
262 * @code{UMASK}: UMASK, Set the file creation mask
263 * @code{UNLINK}: UNLINK, Remove a file from the file system
264 * @code{UNPACK}: UNPACK, Unpack an array of rank one into an array
265 * @code{VERIFY}: VERIFY, Scan a string for the absence of a set of characters
266 * @code{XOR}: XOR, Bitwise logical exclusive or
269 @node Introduction to Intrinsics
270 @section Introduction to intrinsic procedures
272 The intrinsic procedures provided by GNU Fortran include all of the
273 intrinsic procedures required by the Fortran 95 standard, a set of
274 intrinsic procedures for backwards compatibility with G77, and a
275 selection of intrinsic procedures from the Fortran 2003 and Fortran 2008
276 standards. Any conflict between a description here and a description in
277 either the Fortran 95 standard, the Fortran 2003 standard or the Fortran
278 2008 standard is unintentional, and the standard(s) should be considered
281 The enumeration of the @code{KIND} type parameter is processor defined in
282 the Fortran 95 standard. GNU Fortran defines the default integer type and
283 default real type by @code{INTEGER(KIND=4)} and @code{REAL(KIND=4)},
284 respectively. The standard mandates that both data types shall have
285 another kind, which have more precision. On typical target architectures
286 supported by @command{gfortran}, this kind type parameter is @code{KIND=8}.
287 Hence, @code{REAL(KIND=8)} and @code{DOUBLE PRECISION} are equivalent.
288 In the description of generic intrinsic procedures, the kind type parameter
289 will be specified by @code{KIND=*}, and in the description of specific
290 names for an intrinsic procedure the kind type parameter will be explicitly
291 given (e.g., @code{REAL(KIND=4)} or @code{REAL(KIND=8)}). Finally, for
292 brevity the optional @code{KIND=} syntax will be omitted.
294 Many of the intrinsic procedures take one or more optional arguments.
295 This document follows the convention used in the Fortran 95 standard,
296 and denotes such arguments by square brackets.
298 GNU Fortran offers the @option{-std=f95} and @option{-std=gnu} options,
299 which can be used to restrict the set of intrinsic procedures to a
300 given standard. By default, @command{gfortran} sets the @option{-std=gnu}
301 option, and so all intrinsic procedures described here are accepted. There
302 is one caveat. For a select group of intrinsic procedures, @command{g77}
303 implemented both a function and a subroutine. Both classes
304 have been implemented in @command{gfortran} for backwards compatibility
305 with @command{g77}. It is noted here that these functions and subroutines
306 cannot be intermixed in a given subprogram. In the descriptions that follow,
307 the applicable standard for each intrinsic procedure is noted.
312 @section @code{ABORT} --- Abort the program
314 @cindex program termination, with core dump
315 @cindex terminate program, with core dump
319 @item @emph{Description}:
320 @code{ABORT} causes immediate termination of the program. On operating
321 systems that support a core dump, @code{ABORT} will produce a core dump even if
322 the option @option{-fno-dump-core} is in effect, which is suitable for debugging
324 @c TODO: Check if this (with -fno-dump-core) is correct.
326 @item @emph{Standard}:
335 @item @emph{Return value}:
338 @item @emph{Example}:
341 integer :: i = 1, j = 2
342 if (i /= j) call abort
343 end program test_abort
346 @item @emph{See also}:
347 @ref{EXIT}, @ref{KILL}
354 @section @code{ABS} --- Absolute value
361 @cindex absolute value
364 @item @emph{Description}:
365 @code{ABS(A)} computes the absolute value of @code{A}.
367 @item @emph{Standard}:
368 Fortran 77 and later, has overloads that are GNU extensions
374 @code{RESULT = ABS(A)}
376 @item @emph{Arguments}:
377 @multitable @columnfractions .15 .70
378 @item @var{A} @tab The type of the argument shall be an @code{INTEGER},
379 @code{REAL}, or @code{COMPLEX}.
382 @item @emph{Return value}:
383 The return value is of the same type and
384 kind as the argument except the return value is @code{REAL} for a
385 @code{COMPLEX} argument.
387 @item @emph{Example}:
392 complex :: z = (-1.e0,0.e0)
399 @item @emph{Specific names}:
400 @multitable @columnfractions .20 .20 .20 .25
401 @item Name @tab Argument @tab Return type @tab Standard
402 @item @code{CABS(A)} @tab @code{COMPLEX(4) Z} @tab @code{REAL(4)} @tab Fortran 77 and later
403 @item @code{DABS(A)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
404 @item @code{IABS(A)} @tab @code{INTEGER(4) I} @tab @code{INTEGER(4)} @tab Fortran 77 and later
405 @item @code{ZABS(A)} @tab @code{COMPLEX(8) Z} @tab @code{COMPLEX(8)} @tab GNU extension
406 @item @code{CDABS(A)} @tab @code{COMPLEX(8) Z} @tab @code{COMPLEX(8)} @tab GNU extension
413 @section @code{ACCESS} --- Checks file access modes
415 @cindex file system, access mode
418 @item @emph{Description}:
419 @code{ACCESS(NAME, MODE)} checks whether the file @var{NAME}
420 exists, is readable, writable or executable. Except for the
421 executable check, @code{ACCESS} can be replaced by
422 Fortran 95's @code{INQUIRE}.
424 @item @emph{Standard}:
431 @code{RESULT = ACCESS(NAME, MODE)}
433 @item @emph{Arguments}:
434 @multitable @columnfractions .15 .70
435 @item @var{NAME} @tab Scalar @code{CHARACTER} of default kind with the
436 file name. Tailing blank are ignored unless the character @code{achar(0)}
437 is present, then all characters up to and excluding @code{achar(0)} are
439 @item @var{MODE} @tab Scalar @code{CHARACTER} of default kind with the
440 file access mode, may be any concatenation of @code{"r"} (readable),
441 @code{"w"} (writable) and @code{"x"} (executable), or @code{" "} to check
445 @item @emph{Return value}:
446 Returns a scalar @code{INTEGER}, which is @code{0} if the file is
447 accessible in the given mode; otherwise or if an invalid argument
448 has been given for @code{MODE} the value @code{1} is returned.
450 @item @emph{Example}:
454 character(len=*), parameter :: file = 'test.dat'
455 character(len=*), parameter :: file2 = 'test.dat '//achar(0)
456 if(access(file,' ') == 0) print *, trim(file),' is exists'
457 if(access(file,'r') == 0) print *, trim(file),' is readable'
458 if(access(file,'w') == 0) print *, trim(file),' is writable'
459 if(access(file,'x') == 0) print *, trim(file),' is executable'
460 if(access(file2,'rwx') == 0) &
461 print *, trim(file2),' is readable, writable and executable'
462 end program access_test
464 @item @emph{Specific names}:
465 @item @emph{See also}:
472 @section @code{ACHAR} --- Character in @acronym{ASCII} collating sequence
474 @cindex @acronym{ASCII} collating sequence
475 @cindex collating sequence, @acronym{ASCII}
478 @item @emph{Description}:
479 @code{ACHAR(I)} returns the character located at position @code{I}
480 in the @acronym{ASCII} collating sequence.
482 @item @emph{Standard}:
483 Fortran 77 and later, with @var{KIND} argument Fortran 2003 and later
489 @code{RESULT = ACHAR(I [, KIND])}
491 @item @emph{Arguments}:
492 @multitable @columnfractions .15 .70
493 @item @var{I} @tab The type shall be @code{INTEGER}.
494 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
495 expression indicating the kind parameter of the result.
498 @item @emph{Return value}:
499 The return value is of type @code{CHARACTER} with a length of one.
500 If the @var{KIND} argument is present, the return value is of the
501 specified kind and of the default kind otherwise.
503 @item @emph{Example}:
508 end program test_achar
512 See @ref{ICHAR} for a discussion of converting between numerical values
513 and formatted string representations.
515 @item @emph{See also}:
516 @ref{CHAR}, @ref{IACHAR}, @ref{ICHAR}
523 @section @code{ACOS} --- Arccosine function
526 @cindex trigonometric function, cosine, inverse
527 @cindex cosine, inverse
530 @item @emph{Description}:
531 @code{ACOS(X)} computes the arccosine of @var{X} (inverse of @code{COS(X)}).
533 @item @emph{Standard}:
540 @code{RESULT = ACOS(X)}
542 @item @emph{Arguments}:
543 @multitable @columnfractions .15 .70
544 @item @var{X} @tab The type shall be @code{REAL} with a magnitude that is
545 less than or equal to one.
548 @item @emph{Return value}:
549 The return value is of type @code{REAL} and it lies in the
550 range @math{ 0 \leq \acos(x) \leq \pi}. The return value if of the same
553 @item @emph{Example}:
556 real(8) :: x = 0.866_8
558 end program test_acos
561 @item @emph{Specific names}:
562 @multitable @columnfractions .20 .20 .20 .25
563 @item Name @tab Argument @tab Return type @tab Standard
564 @item @code{DACOS(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
567 @item @emph{See also}:
568 Inverse function: @ref{COS}
575 @section @code{ACOSH} --- Hyperbolic arccosine function
578 @cindex area hyperbolic cosine
579 @cindex hyperbolic arccosine
580 @cindex hyperbolic function, cosine, inverse
581 @cindex cosine, hyperbolic, inverse
584 @item @emph{Description}:
585 @code{ACOSH(X)} computes the hyperbolic arccosine of @var{X} (inverse of
588 @item @emph{Standard}:
589 Fortran 2008 and later
595 @code{RESULT = ACOSH(X)}
597 @item @emph{Arguments}:
598 @multitable @columnfractions .15 .70
599 @item @var{X} @tab The type shall be @code{REAL} or @code{COMPLEX}.
602 @item @emph{Return value}:
603 The return value has the same type and kind as @var{X}
605 @item @emph{Example}:
608 REAL(8), DIMENSION(3) :: x = (/ 1.0, 2.0, 3.0 /)
613 @item @emph{Specific names}:
614 @multitable @columnfractions .20 .20 .20 .25
615 @item Name @tab Argument @tab Return type @tab Standard
616 @item @code{DACOSH(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
619 @item @emph{See also}:
620 Inverse function: @ref{COSH}
626 @section @code{ADJUSTL} --- Left adjust a string
628 @cindex string, adjust left
629 @cindex adjust string
632 @item @emph{Description}:
633 @code{ADJUSTL(STRING)} will left adjust a string by removing leading spaces.
634 Spaces are inserted at the end of the string as needed.
636 @item @emph{Standard}:
643 @code{RESULT = ADJUSTL(STRING)}
645 @item @emph{Arguments}:
646 @multitable @columnfractions .15 .70
647 @item @var{STRING} @tab The type shall be @code{CHARACTER}.
650 @item @emph{Return value}:
651 The return value is of type @code{CHARACTER} and of the same kind as
652 @var{STRING} where leading spaces are removed and the same number of
653 spaces are inserted on the end of @var{STRING}.
655 @item @emph{Example}:
658 character(len=20) :: str = ' gfortran'
661 end program test_adjustl
664 @item @emph{See also}:
665 @ref{ADJUSTR}, @ref{TRIM}
671 @section @code{ADJUSTR} --- Right adjust a string
673 @cindex string, adjust right
674 @cindex adjust string
677 @item @emph{Description}:
678 @code{ADJUSTR(STRING)} will right adjust a string by removing trailing spaces.
679 Spaces are inserted at the start of the string as needed.
681 @item @emph{Standard}:
688 @code{RESULT = ADJUSTR(STRING)}
690 @item @emph{Arguments}:
691 @multitable @columnfractions .15 .70
692 @item @var{STR} @tab The type shall be @code{CHARACTER}.
695 @item @emph{Return value}:
696 The return value is of type @code{CHARACTER} and of the same kind as
697 @var{STRING} where trailing spaces are removed and the same number of
698 spaces are inserted at the start of @var{STRING}.
700 @item @emph{Example}:
703 character(len=20) :: str = 'gfortran'
706 end program test_adjustr
709 @item @emph{See also}:
710 @ref{ADJUSTL}, @ref{TRIM}
716 @section @code{AIMAG} --- Imaginary part of complex number
721 @cindex complex numbers, imaginary part
724 @item @emph{Description}:
725 @code{AIMAG(Z)} yields the imaginary part of complex argument @code{Z}.
726 The @code{IMAG(Z)} and @code{IMAGPART(Z)} intrinsic functions are provided
727 for compatibility with @command{g77}, and their use in new code is
728 strongly discouraged.
730 @item @emph{Standard}:
731 Fortran 77 and later, has overloads that are GNU extensions
737 @code{RESULT = AIMAG(Z)}
739 @item @emph{Arguments}:
740 @multitable @columnfractions .15 .70
741 @item @var{Z} @tab The type of the argument shall be @code{COMPLEX}.
744 @item @emph{Return value}:
745 The return value is of type @code{REAL} with the
746 kind type parameter of the argument.
748 @item @emph{Example}:
753 z4 = cmplx(1.e0_4, 0.e0_4)
754 z8 = cmplx(0.e0_8, 1.e0_8)
755 print *, aimag(z4), dimag(z8)
756 end program test_aimag
759 @item @emph{Specific names}:
760 @multitable @columnfractions .20 .20 .20 .25
761 @item Name @tab Argument @tab Return type @tab Standard
762 @item @code{DIMAG(Z)} @tab @code{COMPLEX(8) Z} @tab @code{REAL(8)} @tab GNU extension
763 @item @code{IMAG(Z)} @tab @code{COMPLEX Z} @tab @code{REAL} @tab GNU extension
764 @item @code{IMAGPART(Z)} @tab @code{COMPLEX Z} @tab @code{REAL} @tab GNU extension
771 @section @code{AINT} --- Truncate to a whole number
775 @cindex rounding, floor
778 @item @emph{Description}:
779 @code{AINT(A [, KIND])} truncates its argument to a whole number.
781 @item @emph{Standard}:
788 @code{RESULT = AINT(A [, KIND])}
790 @item @emph{Arguments}:
791 @multitable @columnfractions .15 .70
792 @item @var{A} @tab The type of the argument shall be @code{REAL}.
793 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
794 expression indicating the kind parameter of the result.
797 @item @emph{Return value}:
798 The return value is of type @code{REAL} with the kind type parameter of the
799 argument if the optional @var{KIND} is absent; otherwise, the kind
800 type parameter will be given by @var{KIND}. If the magnitude of
801 @var{X} is less than one, @code{AINT(X)} returns zero. If the
802 magnitude is equal to or greater than one then it returns the largest
803 whole number that does not exceed its magnitude. The sign is the same
804 as the sign of @var{X}.
806 @item @emph{Example}:
813 print *, aint(x4), dint(x8)
815 end program test_aint
818 @item @emph{Specific names}:
819 @multitable @columnfractions .20 .20 .20 .25
820 @item Name @tab Argument @tab Return type @tab Standard
821 @item @code{DINT(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
828 @section @code{ALARM} --- Execute a routine after a given delay
830 @cindex delayed execution
833 @item @emph{Description}:
834 @code{ALARM(SECONDS, HANDLER [, STATUS])} causes external subroutine @var{HANDLER}
835 to be executed after a delay of @var{SECONDS} by using @code{alarm(2)} to
836 set up a signal and @code{signal(2)} to catch it. If @var{STATUS} is
837 supplied, it will be returned with the number of seconds remaining until
838 any previously scheduled alarm was due to be delivered, or zero if there
839 was no previously scheduled alarm.
841 @item @emph{Standard}:
848 @code{CALL ALARM(SECONDS, HANDLER [, STATUS])}
850 @item @emph{Arguments}:
851 @multitable @columnfractions .15 .70
852 @item @var{SECONDS} @tab The type of the argument shall be a scalar
853 @code{INTEGER}. It is @code{INTENT(IN)}.
854 @item @var{HANDLER} @tab Signal handler (@code{INTEGER FUNCTION} or
855 @code{SUBROUTINE}) or dummy/global @code{INTEGER} scalar. The scalar
856 values may be either @code{SIG_IGN=1} to ignore the alarm generated
857 or @code{SIG_DFL=0} to set the default action. It is @code{INTENT(IN)}.
858 @item @var{STATUS} @tab (Optional) @var{STATUS} shall be a scalar
859 variable of the default @code{INTEGER} kind. It is @code{INTENT(OUT)}.
862 @item @emph{Example}:
865 external handler_print
867 call alarm (3, handler_print, i)
870 end program test_alarm
872 This will cause the external routine @var{handler_print} to be called
879 @section @code{ALL} --- All values in @var{MASK} along @var{DIM} are true
881 @cindex array, apply condition
882 @cindex array, condition testing
885 @item @emph{Description}:
886 @code{ALL(MASK [, DIM])} determines if all the values are true in @var{MASK}
887 in the array along dimension @var{DIM}.
889 @item @emph{Standard}:
893 Transformational function
896 @code{RESULT = ALL(MASK [, DIM])}
898 @item @emph{Arguments}:
899 @multitable @columnfractions .15 .70
900 @item @var{MASK} @tab The type of the argument shall be @code{LOGICAL} and
901 it shall not be scalar.
902 @item @var{DIM} @tab (Optional) @var{DIM} shall be a scalar integer
903 with a value that lies between one and the rank of @var{MASK}.
906 @item @emph{Return value}:
907 @code{ALL(MASK)} returns a scalar value of type @code{LOGICAL} where
908 the kind type parameter is the same as the kind type parameter of
909 @var{MASK}. If @var{DIM} is present, then @code{ALL(MASK, DIM)} returns
910 an array with the rank of @var{MASK} minus 1. The shape is determined from
911 the shape of @var{MASK} where the @var{DIM} dimension is elided.
915 @code{ALL(MASK)} is true if all elements of @var{MASK} are true.
916 It also is true if @var{MASK} has zero size; otherwise, it is false.
918 If the rank of @var{MASK} is one, then @code{ALL(MASK,DIM)} is equivalent
919 to @code{ALL(MASK)}. If the rank is greater than one, then @code{ALL(MASK,DIM)}
920 is determined by applying @code{ALL} to the array sections.
923 @item @emph{Example}:
927 l = all((/.true., .true., .true./))
932 integer a(2,3), b(2,3)
936 print *, all(a .eq. b, 1)
937 print *, all(a .eq. b, 2)
938 end subroutine section
946 @section @code{ALLOCATED} --- Status of an allocatable entity
948 @cindex allocation, status
951 @item @emph{Description}:
952 @code{ALLOCATED(ARRAY)} checks the status of whether @var{X} is allocated.
954 @item @emph{Standard}:
961 @code{RESULT = ALLOCATED(ARRAY)}
963 @item @emph{Arguments}:
964 @multitable @columnfractions .15 .70
965 @item @var{ARRAY} @tab The argument shall be an @code{ALLOCATABLE} array.
968 @item @emph{Return value}:
969 The return value is a scalar @code{LOGICAL} with the default logical
970 kind type parameter. If @var{ARRAY} is allocated, @code{ALLOCATED(ARRAY)}
971 is @code{.TRUE.}; otherwise, it returns @code{.FALSE.}
973 @item @emph{Example}:
975 program test_allocated
977 real(4), allocatable :: x(:)
978 if (.not. allocated(x)) allocate(x(i))
979 end program test_allocated
986 @section @code{AND} --- Bitwise logical AND
988 @cindex bitwise logical and
989 @cindex logical and, bitwise
992 @item @emph{Description}:
993 Bitwise logical @code{AND}.
995 This intrinsic routine is provided for backwards compatibility with
996 GNU Fortran 77. For integer arguments, programmers should consider
997 the use of the @ref{IAND} intrinsic defined by the Fortran standard.
999 @item @emph{Standard}:
1005 @item @emph{Syntax}:
1006 @code{RESULT = AND(I, J)}
1008 @item @emph{Arguments}:
1009 @multitable @columnfractions .15 .70
1010 @item @var{I} @tab The type shall be either a scalar @code{INTEGER}
1011 type or a scalar @code{LOGICAL} type.
1012 @item @var{J} @tab The type shall be the same as the type of @var{I}.
1015 @item @emph{Return value}:
1016 The return type is either a scalar @code{INTEGER} or a scalar
1017 @code{LOGICAL}. If the kind type parameters differ, then the
1018 smaller kind type is implicitly converted to larger kind, and the
1019 return has the larger kind.
1021 @item @emph{Example}:
1024 LOGICAL :: T = .TRUE., F = .FALSE.
1026 DATA a / Z'F' /, b / Z'3' /
1028 WRITE (*,*) AND(T, T), AND(T, F), AND(F, T), AND(F, F)
1029 WRITE (*,*) AND(a, b)
1033 @item @emph{See also}:
1034 Fortran 95 elemental function: @ref{IAND}
1040 @section @code{ANINT} --- Nearest whole number
1044 @cindex rounding, ceiling
1047 @item @emph{Description}:
1048 @code{ANINT(A [, KIND])} rounds its argument to the nearest whole number.
1050 @item @emph{Standard}:
1051 Fortran 77 and later
1056 @item @emph{Syntax}:
1057 @code{RESULT = ANINT(A [, KIND])}
1059 @item @emph{Arguments}:
1060 @multitable @columnfractions .15 .70
1061 @item @var{A} @tab The type of the argument shall be @code{REAL}.
1062 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
1063 expression indicating the kind parameter of the result.
1066 @item @emph{Return value}:
1067 The return value is of type real with the kind type parameter of the
1068 argument if the optional @var{KIND} is absent; otherwise, the kind
1069 type parameter will be given by @var{KIND}. If @var{A} is greater than
1070 zero, @code{ANINT(A)} returns @code{AINT(X+0.5)}. If @var{A} is
1071 less than or equal to zero then it returns @code{AINT(X-0.5)}.
1073 @item @emph{Example}:
1080 print *, anint(x4), dnint(x8)
1082 end program test_anint
1085 @item @emph{Specific names}:
1086 @multitable @columnfractions .20 .20 .20 .25
1087 @item Name @tab Argument @tab Return type @tab Standard
1088 @item @code{DNINT(A)} @tab @code{REAL(8) A} @tab @code{REAL(8)} @tab Fortran 77 and later
1095 @section @code{ANY} --- Any value in @var{MASK} along @var{DIM} is true
1097 @cindex array, apply condition
1098 @cindex array, condition testing
1101 @item @emph{Description}:
1102 @code{ANY(MASK [, DIM])} determines if any of the values in the logical array
1103 @var{MASK} along dimension @var{DIM} are @code{.TRUE.}.
1105 @item @emph{Standard}:
1106 Fortran 95 and later
1109 Transformational function
1111 @item @emph{Syntax}:
1112 @code{RESULT = ANY(MASK [, DIM])}
1114 @item @emph{Arguments}:
1115 @multitable @columnfractions .15 .70
1116 @item @var{MASK} @tab The type of the argument shall be @code{LOGICAL} and
1117 it shall not be scalar.
1118 @item @var{DIM} @tab (Optional) @var{DIM} shall be a scalar integer
1119 with a value that lies between one and the rank of @var{MASK}.
1122 @item @emph{Return value}:
1123 @code{ANY(MASK)} returns a scalar value of type @code{LOGICAL} where
1124 the kind type parameter is the same as the kind type parameter of
1125 @var{MASK}. If @var{DIM} is present, then @code{ANY(MASK, DIM)} returns
1126 an array with the rank of @var{MASK} minus 1. The shape is determined from
1127 the shape of @var{MASK} where the @var{DIM} dimension is elided.
1131 @code{ANY(MASK)} is true if any element of @var{MASK} is true;
1132 otherwise, it is false. It also is false if @var{MASK} has zero size.
1134 If the rank of @var{MASK} is one, then @code{ANY(MASK,DIM)} is equivalent
1135 to @code{ANY(MASK)}. If the rank is greater than one, then @code{ANY(MASK,DIM)}
1136 is determined by applying @code{ANY} to the array sections.
1139 @item @emph{Example}:
1143 l = any((/.true., .true., .true./))
1148 integer a(2,3), b(2,3)
1152 print *, any(a .eq. b, 1)
1153 print *, any(a .eq. b, 2)
1154 end subroutine section
1155 end program test_any
1162 @section @code{ASIN} --- Arcsine function
1165 @cindex trigonometric function, sine, inverse
1166 @cindex sine, inverse
1169 @item @emph{Description}:
1170 @code{ASIN(X)} computes the arcsine of its @var{X} (inverse of @code{SIN(X)}).
1172 @item @emph{Standard}:
1173 Fortran 77 and later
1178 @item @emph{Syntax}:
1179 @code{RESULT = ASIN(X)}
1181 @item @emph{Arguments}:
1182 @multitable @columnfractions .15 .70
1183 @item @var{X} @tab The type shall be @code{REAL}, and a magnitude that is
1184 less than or equal to one.
1187 @item @emph{Return value}:
1188 The return value is of type @code{REAL} and it lies in the
1189 range @math{-\pi / 2 \leq \asin (x) \leq \pi / 2}. The kind type
1190 parameter is the same as @var{X}.
1192 @item @emph{Example}:
1195 real(8) :: x = 0.866_8
1197 end program test_asin
1200 @item @emph{Specific names}:
1201 @multitable @columnfractions .20 .20 .20 .25
1202 @item Name @tab Argument @tab Return type @tab Standard
1203 @item @code{DASIN(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
1206 @item @emph{See also}:
1207 Inverse function: @ref{SIN}
1214 @section @code{ASINH} --- Hyperbolic arcsine function
1217 @cindex area hyperbolic sine
1218 @cindex hyperbolic arcsine
1219 @cindex hyperbolic function, sine, inverse
1220 @cindex sine, hyperbolic, inverse
1223 @item @emph{Description}:
1224 @code{ASINH(X)} computes the hyperbolic arcsine of @var{X} (inverse of @code{SINH(X)}).
1226 @item @emph{Standard}:
1227 Fortran 2008 and later
1232 @item @emph{Syntax}:
1233 @code{RESULT = ASINH(X)}
1235 @item @emph{Arguments}:
1236 @multitable @columnfractions .15 .70
1237 @item @var{X} @tab The type shall be @code{REAL} or @code{COMPLEX}.
1240 @item @emph{Return value}:
1241 The return value is of the same type and kind as @var{X}.
1243 @item @emph{Example}:
1246 REAL(8), DIMENSION(3) :: x = (/ -1.0, 0.0, 1.0 /)
1247 WRITE (*,*) ASINH(x)
1251 @item @emph{Specific names}:
1252 @multitable @columnfractions .20 .20 .20 .25
1253 @item Name @tab Argument @tab Return type @tab Standard
1254 @item @code{DASINH(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension.
1257 @item @emph{See also}:
1258 Inverse function: @ref{SINH}
1264 @section @code{ASSOCIATED} --- Status of a pointer or pointer/target pair
1266 @cindex pointer, status
1267 @cindex association status
1270 @item @emph{Description}:
1271 @code{ASSOCIATED(POINTER [, TARGET])} determines the status of the pointer
1272 @var{POINTER} or if @var{POINTER} is associated with the target @var{TARGET}.
1274 @item @emph{Standard}:
1275 Fortran 95 and later
1280 @item @emph{Syntax}:
1281 @code{RESULT = ASSOCIATED(POINTER [, TARGET])}
1283 @item @emph{Arguments}:
1284 @multitable @columnfractions .15 .70
1285 @item @var{POINTER} @tab @var{POINTER} shall have the @code{POINTER} attribute
1286 and it can be of any type.
1287 @item @var{TARGET} @tab (Optional) @var{TARGET} shall be a pointer or
1288 a target. It must have the same type, kind type parameter, and
1289 array rank as @var{POINTER}.
1291 The association status of neither @var{POINTER} nor @var{TARGET} shall be
1294 @item @emph{Return value}:
1295 @code{ASSOCIATED(POINTER)} returns a scalar value of type @code{LOGICAL(4)}.
1296 There are several cases:
1298 @item (A) When the optional @var{TARGET} is not present then
1299 @code{ASSOCIATED(POINTER)} is true if @var{POINTER} is associated with a target; otherwise, it returns false.
1300 @item (B) If @var{TARGET} is present and a scalar target, the result is true if
1301 @var{TARGET} is not a zero-sized storage sequence and the target associated with @var{POINTER} occupies the same storage units. If @var{POINTER} is
1302 disassociated, the result is false.
1303 @item (C) If @var{TARGET} is present and an array target, the result is true if
1304 @var{TARGET} and @var{POINTER} have the same shape, are not zero-sized arrays,
1305 are arrays whose elements are not zero-sized storage sequences, and
1306 @var{TARGET} and @var{POINTER} occupy the same storage units in array element
1308 As in case(B), the result is false, if @var{POINTER} is disassociated.
1309 @item (D) If @var{TARGET} is present and an scalar pointer, the result is true
1310 if @var{TARGET} is associated with @var{POINTER}, the target associated with
1311 @var{TARGET} are not zero-sized storage sequences and occupy the same storage
1313 The result is false, if either @var{TARGET} or @var{POINTER} is disassociated.
1314 @item (E) If @var{TARGET} is present and an array pointer, the result is true if
1315 target associated with @var{POINTER} and the target associated with @var{TARGET}
1316 have the same shape, are not zero-sized arrays, are arrays whose elements are
1317 not zero-sized storage sequences, and @var{TARGET} and @var{POINTER} occupy
1318 the same storage units in array element order.
1319 The result is false, if either @var{TARGET} or @var{POINTER} is disassociated.
1322 @item @emph{Example}:
1324 program test_associated
1326 real, target :: tgt(2) = (/1., 2./)
1327 real, pointer :: ptr(:)
1329 if (associated(ptr) .eqv. .false.) call abort
1330 if (associated(ptr,tgt) .eqv. .false.) call abort
1331 end program test_associated
1334 @item @emph{See also}:
1341 @section @code{ATAN} --- Arctangent function
1344 @cindex trigonometric function, tangent, inverse
1345 @cindex tangent, inverse
1348 @item @emph{Description}:
1349 @code{ATAN(X)} computes the arctangent of @var{X}.
1351 @item @emph{Standard}:
1352 Fortran 77 and later
1357 @item @emph{Syntax}:
1358 @code{RESULT = ATAN(X)}
1360 @item @emph{Arguments}:
1361 @multitable @columnfractions .15 .70
1362 @item @var{X} @tab The type shall be @code{REAL}.
1365 @item @emph{Return value}:
1366 The return value is of type @code{REAL} and it lies in the
1367 range @math{ - \pi / 2 \leq \atan (x) \leq \pi / 2}.
1369 @item @emph{Example}:
1372 real(8) :: x = 2.866_8
1374 end program test_atan
1377 @item @emph{Specific names}:
1378 @multitable @columnfractions .20 .20 .20 .25
1379 @item Name @tab Argument @tab Return type @tab Standard
1380 @item @code{DATAN(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
1383 @item @emph{See also}:
1384 Inverse function: @ref{TAN}
1391 @section @code{ATAN2} --- Arctangent function
1394 @cindex trigonometric function, tangent, inverse
1395 @cindex tangent, inverse
1398 @item @emph{Description}:
1399 @code{ATAN2(Y, X)} computes the arctangent of the complex number
1402 @item @emph{Standard}:
1403 Fortran 77 and later
1408 @item @emph{Syntax}:
1409 @code{RESULT = ATAN2(Y, X)}
1411 @item @emph{Arguments}:
1412 @multitable @columnfractions .15 .70
1413 @item @var{Y} @tab The type shall be @code{REAL}.
1414 @item @var{X} @tab The type and kind type parameter shall be the same as @var{Y}.
1415 If @var{Y} is zero, then @var{X} must be nonzero.
1418 @item @emph{Return value}:
1419 The return value has the same type and kind type parameter as @var{Y}.
1420 It is the principal value of the complex number @math{X + i Y}. If
1421 @var{X} is nonzero, then it lies in the range @math{-\pi \le \atan (x) \leq \pi}.
1422 The sign is positive if @var{Y} is positive. If @var{Y} is zero, then
1423 the return value is zero if @var{X} is positive and @math{\pi} if @var{X}
1424 is negative. Finally, if @var{X} is zero, then the magnitude of the result
1427 @item @emph{Example}:
1430 real(4) :: x = 1.e0_4, y = 0.5e0_4
1432 end program test_atan2
1435 @item @emph{Specific names}:
1436 @multitable @columnfractions .20 .20 .20 .25
1437 @item Name @tab Argument @tab Return type @tab Standard
1438 @item @code{DATAN2(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
1445 @section @code{ATANH} --- Hyperbolic arctangent function
1448 @cindex area hyperbolic tangent
1449 @cindex hyperbolic arctangent
1450 @cindex hyperbolic function, tangent, inverse
1451 @cindex tangent, hyperbolic, inverse
1454 @item @emph{Description}:
1455 @code{ATANH(X)} computes the hyperbolic arctangent of @var{X} (inverse
1458 @item @emph{Standard}:
1459 Fortran 2008 and later
1464 @item @emph{Syntax}:
1465 @code{RESULT = ATANH(X)}
1467 @item @emph{Arguments}:
1468 @multitable @columnfractions .15 .70
1469 @item @var{X} @tab The type shall be @code{REAL} or @code{COMPLEX}.
1472 @item @emph{Return value}:
1473 The return value has same type and kind as @var{X}.
1475 @item @emph{Example}:
1478 REAL, DIMENSION(3) :: x = (/ -1.0, 0.0, 1.0 /)
1479 WRITE (*,*) ATANH(x)
1483 @item @emph{Specific names}:
1484 @multitable @columnfractions .20 .20 .20 .25
1485 @item Name @tab Argument @tab Return type @tab Standard
1486 @item @code{DATANH(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
1489 @item @emph{See also}:
1490 Inverse function: @ref{TANH}
1496 @section @code{BESSEL_J0} --- Bessel function of the first kind of order 0
1500 @cindex Bessel function, first kind
1503 @item @emph{Description}:
1504 @code{BESSEL_J0(X)} computes the Bessel function of the first kind of
1505 order 0 of @var{X}. This function is available under the name
1506 @code{BESJ0} as a GNU extension.
1508 @item @emph{Standard}:
1509 Fortran 2008 and later
1514 @item @emph{Syntax}:
1515 @code{RESULT = BESSEL_J0(X)}
1517 @item @emph{Arguments}:
1518 @multitable @columnfractions .15 .70
1519 @item @var{X} @tab The type shall be @code{REAL}, and it shall be scalar.
1522 @item @emph{Return value}:
1523 The return value is of type @code{REAL} and lies in the
1524 range @math{ - 0.4027... \leq Bessel (0,x) \leq 1}. It has the same
1527 @item @emph{Example}:
1530 real(8) :: x = 0.0_8
1532 end program test_besj0
1535 @item @emph{Specific names}:
1536 @multitable @columnfractions .20 .20 .20 .25
1537 @item Name @tab Argument @tab Return type @tab Standard
1538 @item @code{DBESJ0(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
1545 @section @code{BESSEL_J1} --- Bessel function of the first kind of order 1
1549 @cindex Bessel function, first kind
1552 @item @emph{Description}:
1553 @code{BESSEL_J1(X)} computes the Bessel function of the first kind of
1554 order 1 of @var{X}. This function is available under the name
1555 @code{BESJ1} as a GNU extension.
1557 @item @emph{Standard}:
1563 @item @emph{Syntax}:
1564 @code{RESULT = BESSEL_J1(X)}
1566 @item @emph{Arguments}:
1567 @multitable @columnfractions .15 .70
1568 @item @var{X} @tab The type shall be @code{REAL}, and it shall be scalar.
1571 @item @emph{Return value}:
1572 The return value is of type @code{REAL} and it lies in the
1573 range @math{ - 0.5818... \leq Bessel (0,x) \leq 0.5818 }. It has the same
1576 @item @emph{Example}:
1579 real(8) :: x = 1.0_8
1581 end program test_besj1
1584 @item @emph{Specific names}:
1585 @multitable @columnfractions .20 .20 .20 .25
1586 @item Name @tab Argument @tab Return type @tab Standard
1587 @item @code{DBESJ1(X)}@tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
1594 @section @code{BESSEL_JN} --- Bessel function of the first kind
1598 @cindex Bessel function, first kind
1601 @item @emph{Description}:
1602 @code{BESSEL_JN(N, X)} computes the Bessel function of the first kind of
1603 order @var{N} of @var{X}. This function is available under the name
1604 @code{BESJN} as a GNU extension.
1606 If both arguments are arrays, their ranks and shapes shall conform.
1608 @item @emph{Standard}:
1609 Fortran 2008 and later
1614 @item @emph{Syntax}:
1615 @code{RESULT = BESSEL_JN(N, X)}
1617 @item @emph{Arguments}:
1618 @multitable @columnfractions .15 .70
1619 @item @var{N} @tab Shall be a scalar or an array of type @code{INTEGER}.
1620 @item @var{X} @tab Shall be a scalar or an array of type @code{REAL}.
1623 @item @emph{Return value}:
1624 The return value is a scalar of type @code{REAL}. It has the same
1627 @item @emph{Example}:
1630 real(8) :: x = 1.0_8
1632 end program test_besjn
1635 @item @emph{Specific names}:
1636 @multitable @columnfractions .20 .20 .20 .25
1637 @item Name @tab Argument @tab Return type @tab Standard
1638 @item @code{DBESJN(X)} @tab @code{INTEGER N} @tab @code{REAL(8)} @tab GNU extension
1639 @item @tab @code{REAL(8) X} @tab @tab
1646 @section @code{BESSEL_Y0} --- Bessel function of the second kind of order 0
1650 @cindex Bessel function, second kind
1653 @item @emph{Description}:
1654 @code{BESSEL_Y0(X)} computes the Bessel function of the second kind of
1655 order 0 of @var{X}. This function is available under the name
1656 @code{BESY0} as a GNU extension.
1658 @item @emph{Standard}:
1659 Fortran 2008 and later
1664 @item @emph{Syntax}:
1665 @code{RESULT = BESSEL_Y0(X)}
1667 @item @emph{Arguments}:
1668 @multitable @columnfractions .15 .70
1669 @item @var{X} @tab The type shall be @code{REAL}, and it shall be scalar.
1672 @item @emph{Return value}:
1673 The return value is a scalar of type @code{REAL}. It has the same
1676 @item @emph{Example}:
1679 real(8) :: x = 0.0_8
1681 end program test_besy0
1684 @item @emph{Specific names}:
1685 @multitable @columnfractions .20 .20 .20 .25
1686 @item Name @tab Argument @tab Return type @tab Standard
1687 @item @code{DBESY0(X)}@tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
1694 @section @code{BESSEL_Y1} --- Bessel function of the second kind of order 1
1698 @cindex Bessel function, second kind
1701 @item @emph{Description}:
1702 @code{BESSEL_Y1(X)} computes the Bessel function of the second kind of
1703 order 1 of @var{X}. This function is available under the name
1704 @code{BESY1} as a GNU extension.
1706 @item @emph{Standard}:
1707 Fortran 2008 and later
1712 @item @emph{Syntax}:
1713 @code{RESULT = BESSEL_Y1(X)}
1715 @item @emph{Arguments}:
1716 @multitable @columnfractions .15 .70
1717 @item @var{X} @tab The type shall be @code{REAL}, and it shall be scalar.
1720 @item @emph{Return value}:
1721 The return value is a scalar of type @code{REAL}. It has the same
1724 @item @emph{Example}:
1727 real(8) :: x = 1.0_8
1729 end program test_besy1
1732 @item @emph{Specific names}:
1733 @multitable @columnfractions .20 .20 .20 .25
1734 @item Name @tab Argument @tab Return type @tab Standard
1735 @item @code{DBESY1(X)}@tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
1742 @section @code{BESSEL_YN} --- Bessel function of the second kind
1746 @cindex Bessel function, second kind
1749 @item @emph{Description}:
1750 @code{BESSEL_YN(N, X)} computes the Bessel function of the second kind of
1751 order @var{N} of @var{X}. This function is available under the name
1752 @code{BESYN} as a GNU extension.
1754 If both arguments are arrays, their ranks and shapes shall conform.
1756 @item @emph{Standard}:
1757 Fortran 2008 and later
1762 @item @emph{Syntax}:
1763 @code{RESULT = BESSEL_YN(N, X)}
1765 @item @emph{Arguments}:
1766 @multitable @columnfractions .15 .70
1767 @item @var{N} @tab Shall be a scalar or an array of type @code{INTEGER}.
1768 @item @var{X} @tab Shall be a scalar or an array of type @code{REAL}.
1771 @item @emph{Return value}:
1772 The return value is a scalar of type @code{REAL}. It has the same
1775 @item @emph{Example}:
1778 real(8) :: x = 1.0_8
1780 end program test_besyn
1783 @item @emph{Specific names}:
1784 @multitable @columnfractions .20 .20 .20 .25
1785 @item Name @tab Argument @tab Return type @tab Standard
1786 @item @code{DBESYN(N,X)} @tab @code{INTEGER N} @tab @code{REAL(8)} @tab GNU extension
1787 @item @tab @code{REAL(8) X} @tab @tab
1794 @section @code{BIT_SIZE} --- Bit size inquiry function
1796 @cindex bits, number of
1797 @cindex size of a variable, in bits
1800 @item @emph{Description}:
1801 @code{BIT_SIZE(I)} returns the number of bits (integer precision plus sign bit)
1802 represented by the type of @var{I}. The result of @code{BIT_SIZE(I)} is
1803 independent of the actual value of @var{I}.
1805 @item @emph{Standard}:
1806 Fortran 95 and later
1811 @item @emph{Syntax}:
1812 @code{RESULT = BIT_SIZE(I)}
1814 @item @emph{Arguments}:
1815 @multitable @columnfractions .15 .70
1816 @item @var{I} @tab The type shall be @code{INTEGER}.
1819 @item @emph{Return value}:
1820 The return value is of type @code{INTEGER}
1822 @item @emph{Example}:
1824 program test_bit_size
1829 end program test_bit_size
1836 @section @code{BTEST} --- Bit test function
1838 @cindex bits, testing
1841 @item @emph{Description}:
1842 @code{BTEST(I,POS)} returns logical @code{.TRUE.} if the bit at @var{POS}
1843 in @var{I} is set. The counting of the bits starts at 0.
1845 @item @emph{Standard}:
1846 Fortran 95 and later
1851 @item @emph{Syntax}:
1852 @code{RESULT = BTEST(I, POS)}
1854 @item @emph{Arguments}:
1855 @multitable @columnfractions .15 .70
1856 @item @var{I} @tab The type shall be @code{INTEGER}.
1857 @item @var{POS} @tab The type shall be @code{INTEGER}.
1860 @item @emph{Return value}:
1861 The return value is of type @code{LOGICAL}
1863 @item @emph{Example}:
1866 integer :: i = 32768 + 1024 + 64
1870 bool = btest(i, pos)
1873 end program test_btest
1879 @section @code{C_ASSOCIATED} --- Status of a C pointer
1880 @fnindex C_ASSOCIATED
1881 @cindex association status, C pointer
1882 @cindex pointer, C association status
1885 @item @emph{Description}:
1886 @code{C_ASSOCIATED(c_prt_1[, c_ptr_2])} determines the status of the C pointer
1887 @var{c_ptr_1} or if @var{c_ptr_1} is associated with the target @var{c_ptr_2}.
1889 @item @emph{Standard}:
1890 Fortran 2003 and later
1895 @item @emph{Syntax}:
1896 @code{RESULT = C_ASSOCIATED(c_prt_1[, c_ptr_2])}
1898 @item @emph{Arguments}:
1899 @multitable @columnfractions .15 .70
1900 @item @var{c_ptr_1} @tab Scalar of the type @code{C_PTR} or @code{C_FUNPTR}.
1901 @item @var{c_ptr_2} @tab (Optional) Scalar of the same type as @var{c_ptr_1}.
1904 @item @emph{Return value}:
1905 The return value is of type @code{LOGICAL}; it is @code{.false.} if either
1906 @var{c_ptr_1} is a C NULL pointer or if @var{c_ptr1} and @var{c_ptr_2}
1907 point to different addresses.
1909 @item @emph{Example}:
1911 subroutine association_test(a,b)
1912 use iso_c_binding, only: c_associated, c_loc, c_ptr
1916 if(c_associated(b, c_loc(a))) &
1917 stop 'b and a do not point to same target'
1918 end subroutine association_test
1921 @item @emph{See also}:
1922 @ref{C_LOC}, @ref{C_FUNLOC}
1927 @section @code{C_FUNLOC} --- Obtain the C address of a procedure
1929 @cindex pointer, C address of procedures
1932 @item @emph{Description}:
1933 @code{C_FUNLOC(x)} determines the C address of the argument.
1935 @item @emph{Standard}:
1936 Fortran 2003 and later
1941 @item @emph{Syntax}:
1942 @code{RESULT = C_FUNLOC(x)}
1944 @item @emph{Arguments}:
1945 @multitable @columnfractions .15 .70
1946 @item @var{x} @tab Interoperable function or pointer to such function.
1949 @item @emph{Return value}:
1950 The return value is of type @code{C_FUNPTR} and contains the C address
1953 @item @emph{Example}:
1959 subroutine sub(a) bind(c)
1969 subroutine my_routine(p) bind(c,name='myC_func')
1971 type(c_funptr), intent(in) :: p
1974 call my_routine(c_funloc(sub))
1978 @item @emph{See also}:
1979 @ref{C_ASSOCIATED}, @ref{C_LOC}, @ref{C_F_POINTER}, @ref{C_F_PROCPOINTER}
1983 @node C_F_PROCPOINTER
1984 @section @code{C_F_PROCPOINTER} --- Convert C into Fortran procedure pointer
1985 @fnindex C_F_PROCPOINTER
1986 @cindex pointer, C address of pointers
1989 @item @emph{Description}:
1990 @code{C_F_PROCPOINTER(CPTR, FPTR)} Assign the target of the C function pointer
1991 @var{CPTR} to the Fortran procedure pointer @var{FPTR}.
1993 Note: Due to the currently lacking support of procedure pointers in GNU Fortran
1994 this function is not fully operable.
1996 @item @emph{Standard}:
1997 Fortran 2003 and later
2002 @item @emph{Syntax}:
2003 @code{CALL C_F_PROCPOINTER(cptr, fptr)}
2005 @item @emph{Arguments}:
2006 @multitable @columnfractions .15 .70
2007 @item @var{CPTR} @tab scalar of the type @code{C_FUNPTR}. It is
2009 @item @var{FPTR} @tab procedure pointer interoperable with @var{cptr}. It is
2013 @item @emph{Example}:
2021 real(c_float), intent(in) :: a
2022 real(c_float) :: func
2026 function getIterFunc() bind(c,name="getIterFunc")
2028 type(c_funptr) :: getIterFunc
2031 type(c_funptr) :: cfunptr
2032 procedure(func), pointer :: myFunc
2033 cfunptr = getIterFunc()
2034 call c_f_procpointer(cfunptr, myFunc)
2038 @item @emph{See also}:
2039 @ref{C_LOC}, @ref{C_F_POINTER}
2044 @section @code{C_F_POINTER} --- Convert C into Fortran pointer
2045 @fnindex C_F_POINTER
2046 @cindex pointer, convert C to Fortran
2049 @item @emph{Description}:
2050 @code{C_F_POINTER(CPTR, FPTR[, SHAPE])} Assign the target the C pointer
2051 @var{CPTR} to the Fortran pointer @var{FPTR} and specify its
2054 @item @emph{Standard}:
2055 Fortran 2003 and later
2060 @item @emph{Syntax}:
2061 @code{CALL C_F_POINTER(CPTR, FPTR[, SHAPE])}
2063 @item @emph{Arguments}:
2064 @multitable @columnfractions .15 .70
2065 @item @var{CPTR} @tab scalar of the type @code{C_PTR}. It is
2067 @item @var{FPTR} @tab pointer interoperable with @var{cptr}. It is
2069 @item @var{SHAPE} @tab (Optional) Rank-one array of type @code{INTEGER}
2070 with @code{INTENT(IN)}. It shall be present
2071 if and only if @var{fptr} is an array. The size
2072 must be equal to the rank of @var{fptr}.
2075 @item @emph{Example}:
2081 subroutine my_routine(p) bind(c,name='myC_func')
2083 type(c_ptr), intent(out) :: p
2087 real,pointer :: a(:)
2088 call my_routine(cptr)
2089 call c_f_pointer(cptr, a, [12])
2093 @item @emph{See also}:
2094 @ref{C_LOC}, @ref{C_F_PROCPOINTER}
2099 @section @code{C_LOC} --- Obtain the C address of an object
2101 @cindex procedure pointer, convert C to Fortran
2104 @item @emph{Description}:
2105 @code{C_LOC(X)} determines the C address of the argument.
2107 @item @emph{Standard}:
2108 Fortran 2003 and later
2113 @item @emph{Syntax}:
2114 @code{RESULT = C_LOC(X)}
2116 @item @emph{Arguments}:
2117 @multitable @columnfractions .15 .70
2118 @item @var{X} @tab Associated scalar pointer or interoperable scalar
2119 or allocated allocatable variable with @code{TARGET} attribute.
2122 @item @emph{Return value}:
2123 The return value is of type @code{C_PTR} and contains the C address
2126 @item @emph{Example}:
2128 subroutine association_test(a,b)
2129 use iso_c_binding, only: c_associated, c_loc, c_ptr
2133 if(c_associated(b, c_loc(a))) &
2134 stop 'b and a do not point to same target'
2135 end subroutine association_test
2138 @item @emph{See also}:
2139 @ref{C_ASSOCIATED}, @ref{C_FUNLOC}, @ref{C_F_POINTER}, @ref{C_F_PROCPOINTER}
2144 @section @code{C_SIZEOF} --- Size in bytes of an expression
2146 @cindex expression size
2147 @cindex size of an expression
2150 @item @emph{Description}:
2151 @code{C_SIZEOF(X)} calculates the number of bytes of storage the
2152 expression @code{X} occupies.
2154 @item @emph{Standard}:
2160 @item @emph{Syntax}:
2161 @code{N = C_SIZEOF(X)}
2163 @item @emph{Arguments}:
2164 @multitable @columnfractions .15 .70
2165 @item @var{X} @tab The argument shall be of any type, rank or shape.
2168 @item @emph{Return value}:
2169 The return value is of type integer and of the system-dependent kind
2170 @var{C_SIZE_T} (from the @var{ISO_C_BINDING} module). Its value is the
2171 number of bytes occupied by the argument. If the argument has the
2172 @code{POINTER} attribute, the number of bytes of the storage area pointed
2173 to is returned. If the argument is of a derived type with @code{POINTER}
2174 or @code{ALLOCATABLE} components, the return value doesn't account for
2175 the sizes of the data pointed to by these components.
2177 @item @emph{Example}:
2181 real(c_float) :: r, s(5)
2182 print *, (c_sizeof(s)/c_sizeof(r) == 5)
2185 The example will print @code{.TRUE.} unless you are using a platform
2186 where default @code{REAL} variables are unusually padded.
2188 @item @emph{See also}:
2194 @section @code{CEILING} --- Integer ceiling function
2197 @cindex rounding, ceiling
2200 @item @emph{Description}:
2201 @code{CEILING(A)} returns the least integer greater than or equal to @var{A}.
2203 @item @emph{Standard}:
2204 Fortran 95 and later
2209 @item @emph{Syntax}:
2210 @code{RESULT = CEILING(A [, KIND])}
2212 @item @emph{Arguments}:
2213 @multitable @columnfractions .15 .70
2214 @item @var{A} @tab The type shall be @code{REAL}.
2215 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
2216 expression indicating the kind parameter of the result.
2219 @item @emph{Return value}:
2220 The return value is of type @code{INTEGER(KIND)} if @var{KIND} is present
2221 and a default-kind @code{INTEGER} otherwise.
2223 @item @emph{Example}:
2225 program test_ceiling
2228 print *, ceiling(x) ! returns 64
2229 print *, ceiling(y) ! returns -63
2230 end program test_ceiling
2233 @item @emph{See also}:
2234 @ref{FLOOR}, @ref{NINT}
2241 @section @code{CHAR} --- Character conversion function
2243 @cindex conversion, to character
2246 @item @emph{Description}:
2247 @code{CHAR(I [, KIND])} returns the character represented by the integer @var{I}.
2249 @item @emph{Standard}:
2250 Fortran 77 and later
2255 @item @emph{Syntax}:
2256 @code{RESULT = CHAR(I [, KIND])}
2258 @item @emph{Arguments}:
2259 @multitable @columnfractions .15 .70
2260 @item @var{I} @tab The type shall be @code{INTEGER}.
2261 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
2262 expression indicating the kind parameter of the result.
2265 @item @emph{Return value}:
2266 The return value is of type @code{CHARACTER(1)}
2268 @item @emph{Example}:
2274 print *, i, c ! returns 'J'
2275 end program test_char
2279 See @ref{ICHAR} for a discussion of converting between numerical values
2280 and formatted string representations.
2282 @item @emph{See also}:
2283 @ref{ACHAR}, @ref{IACHAR}, @ref{ICHAR}
2290 @section @code{CHDIR} --- Change working directory
2292 @cindex system, working directory
2295 @item @emph{Description}:
2296 Change current working directory to a specified path.
2298 This intrinsic is provided in both subroutine and function forms; however,
2299 only one form can be used in any given program unit.
2301 @item @emph{Standard}:
2305 Subroutine, function
2307 @item @emph{Syntax}:
2308 @multitable @columnfractions .80
2309 @item @code{CALL CHDIR(NAME [, STATUS])}
2310 @item @code{STATUS = CHDIR(NAME)}
2313 @item @emph{Arguments}:
2314 @multitable @columnfractions .15 .70
2315 @item @var{NAME} @tab The type shall be @code{CHARACTER} of default
2316 kind and shall specify a valid path within the file system.
2317 @item @var{STATUS} @tab (Optional) @code{INTEGER} status flag of the default
2318 kind. Returns 0 on success, and a system specific and nonzero error code
2322 @item @emph{Example}:
2325 CHARACTER(len=255) :: path
2327 WRITE(*,*) TRIM(path)
2330 WRITE(*,*) TRIM(path)
2334 @item @emph{See also}:
2341 @section @code{CHMOD} --- Change access permissions of files
2343 @cindex file system, change access mode
2346 @item @emph{Description}:
2347 @code{CHMOD} changes the permissions of a file. This function invokes
2348 @code{/bin/chmod} and might therefore not work on all platforms.
2350 This intrinsic is provided in both subroutine and function forms; however,
2351 only one form can be used in any given program unit.
2353 @item @emph{Standard}:
2357 Subroutine, function
2359 @item @emph{Syntax}:
2360 @multitable @columnfractions .80
2361 @item @code{CALL CHMOD(NAME, MODE[, STATUS])}
2362 @item @code{STATUS = CHMOD(NAME, MODE)}
2365 @item @emph{Arguments}:
2366 @multitable @columnfractions .15 .70
2368 @item @var{NAME} @tab Scalar @code{CHARACTER} of default kind with the
2369 file name. Trailing blanks are ignored unless the character
2370 @code{achar(0)} is present, then all characters up to and excluding
2371 @code{achar(0)} are used as the file name.
2373 @item @var{MODE} @tab Scalar @code{CHARACTER} of default kind giving the
2374 file permission. @var{MODE} uses the same syntax as the @var{MODE}
2375 argument of @code{/bin/chmod}.
2377 @item @var{STATUS} @tab (optional) scalar @code{INTEGER}, which is
2378 @code{0} on success and nonzero otherwise.
2381 @item @emph{Return value}:
2382 In either syntax, @var{STATUS} is set to @code{0} on success and nonzero
2385 @item @emph{Example}:
2386 @code{CHMOD} as subroutine
2391 call chmod('test.dat','u+x',status)
2392 print *, 'Status: ', status
2393 end program chmod_test
2395 @code{CHMOD} as function:
2400 status = chmod('test.dat','u+x')
2401 print *, 'Status: ', status
2402 end program chmod_test
2410 @section @code{CMPLX} --- Complex conversion function
2412 @cindex complex numbers, conversion to
2413 @cindex conversion, to complex
2416 @item @emph{Description}:
2417 @code{CMPLX(X [, Y [, KIND]])} returns a complex number where @var{X} is converted to
2418 the real component. If @var{Y} is present it is converted to the imaginary
2419 component. If @var{Y} is not present then the imaginary component is set to
2420 0.0. If @var{X} is complex then @var{Y} must not be present.
2422 @item @emph{Standard}:
2423 Fortran 77 and later
2428 @item @emph{Syntax}:
2429 @code{RESULT = CMPLX(X [, Y [, KIND]])}
2431 @item @emph{Arguments}:
2432 @multitable @columnfractions .15 .70
2433 @item @var{X} @tab The type may be @code{INTEGER}, @code{REAL},
2435 @item @var{Y} @tab (Optional; only allowed if @var{X} is not
2436 @code{COMPLEX}.) May be @code{INTEGER} or @code{REAL}.
2437 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
2438 expression indicating the kind parameter of the result.
2441 @item @emph{Return value}:
2442 The return value is of @code{COMPLEX} type, with a kind equal to
2443 @var{KIND} if it is specified. If @var{KIND} is not specified, the
2444 result is of the default @code{COMPLEX} kind, regardless of the kinds of
2445 @var{X} and @var{Y}.
2447 @item @emph{Example}:
2454 print *, z, cmplx(x)
2455 end program test_cmplx
2458 @item @emph{See also}:
2464 @node COMMAND_ARGUMENT_COUNT
2465 @section @code{COMMAND_ARGUMENT_COUNT} --- Get number of command line arguments
2466 @fnindex COMMAND_ARGUMENT_COUNT
2467 @cindex command-line arguments
2468 @cindex command-line arguments, number of
2469 @cindex arguments, to program
2472 @item @emph{Description}:
2473 @code{COMMAND_ARGUMENT_COUNT()} returns the number of arguments passed on the
2474 command line when the containing program was invoked.
2476 @item @emph{Standard}:
2477 Fortran 2003 and later
2482 @item @emph{Syntax}:
2483 @code{RESULT = COMMAND_ARGUMENT_COUNT()}
2485 @item @emph{Arguments}:
2486 @multitable @columnfractions .15 .70
2490 @item @emph{Return value}:
2491 The return value is of type @code{INTEGER(4)}
2493 @item @emph{Example}:
2495 program test_command_argument_count
2497 count = command_argument_count()
2499 end program test_command_argument_count
2502 @item @emph{See also}:
2503 @ref{GET_COMMAND}, @ref{GET_COMMAND_ARGUMENT}
2509 @section @code{COMPLEX} --- Complex conversion function
2511 @cindex complex numbers, conversion to
2512 @cindex conversion, to complex
2515 @item @emph{Description}:
2516 @code{COMPLEX(X, Y)} returns a complex number where @var{X} is converted
2517 to the real component and @var{Y} is converted to the imaginary
2520 @item @emph{Standard}:
2526 @item @emph{Syntax}:
2527 @code{RESULT = COMPLEX(X, Y)}
2529 @item @emph{Arguments}:
2530 @multitable @columnfractions .15 .70
2531 @item @var{X} @tab The type may be @code{INTEGER} or @code{REAL}.
2532 @item @var{Y} @tab The type may be @code{INTEGER} or @code{REAL}.
2535 @item @emph{Return value}:
2536 If @var{X} and @var{Y} are both of @code{INTEGER} type, then the return
2537 value is of default @code{COMPLEX} type.
2539 If @var{X} and @var{Y} are of @code{REAL} type, or one is of @code{REAL}
2540 type and one is of @code{INTEGER} type, then the return value is of
2541 @code{COMPLEX} type with a kind equal to that of the @code{REAL}
2542 argument with the highest precision.
2544 @item @emph{Example}:
2546 program test_complex
2549 print *, complex(i, x)
2550 end program test_complex
2553 @item @emph{See also}:
2560 @section @code{CONJG} --- Complex conjugate function
2563 @cindex complex conjugate
2566 @item @emph{Description}:
2567 @code{CONJG(Z)} returns the conjugate of @var{Z}. If @var{Z} is @code{(x, y)}
2568 then the result is @code{(x, -y)}
2570 @item @emph{Standard}:
2571 Fortran 77 and later, has overloads that are GNU extensions
2576 @item @emph{Syntax}:
2579 @item @emph{Arguments}:
2580 @multitable @columnfractions .15 .70
2581 @item @var{Z} @tab The type shall be @code{COMPLEX}.
2584 @item @emph{Return value}:
2585 The return value is of type @code{COMPLEX}.
2587 @item @emph{Example}:
2590 complex :: z = (2.0, 3.0)
2591 complex(8) :: dz = (2.71_8, -3.14_8)
2596 end program test_conjg
2599 @item @emph{Specific names}:
2600 @multitable @columnfractions .20 .20 .20 .25
2601 @item Name @tab Argument @tab Return type @tab Standard
2602 @item @code{DCONJG(Z)} @tab @code{COMPLEX(8) Z} @tab @code{COMPLEX(8)} @tab GNU extension
2609 @section @code{COS} --- Cosine function
2615 @cindex trigonometric function, cosine
2619 @item @emph{Description}:
2620 @code{COS(X)} computes the cosine of @var{X}.
2622 @item @emph{Standard}:
2623 Fortran 77 and later, has overloads that are GNU extensions
2628 @item @emph{Syntax}:
2629 @code{RESULT = COS(X)}
2631 @item @emph{Arguments}:
2632 @multitable @columnfractions .15 .70
2633 @item @var{X} @tab The type shall be @code{REAL} or
2637 @item @emph{Return value}:
2638 The return value is of type @code{REAL} and it lies in the
2639 range @math{ -1 \leq \cos (x) \leq 1}. The kind type
2640 parameter is the same as @var{X}.
2642 @item @emph{Example}:
2647 end program test_cos
2650 @item @emph{Specific names}:
2651 @multitable @columnfractions .20 .20 .20 .25
2652 @item Name @tab Argument @tab Return type @tab Standard
2653 @item @code{DCOS(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
2654 @item @code{CCOS(X)} @tab @code{COMPLEX(4) X} @tab @code{COMPLEX(4)} @tab Fortran 77 and later
2655 @item @code{ZCOS(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab GNU extension
2656 @item @code{CDCOS(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab GNU extension
2659 @item @emph{See also}:
2660 Inverse function: @ref{ACOS}
2667 @section @code{COSH} --- Hyperbolic cosine function
2670 @cindex hyperbolic cosine
2671 @cindex hyperbolic function, cosine
2672 @cindex cosine, hyperbolic
2675 @item @emph{Description}:
2676 @code{COSH(X)} computes the hyperbolic cosine of @var{X}.
2678 @item @emph{Standard}:
2679 Fortran 77 and later
2684 @item @emph{Syntax}:
2687 @item @emph{Arguments}:
2688 @multitable @columnfractions .15 .70
2689 @item @var{X} @tab The type shall be @code{REAL}.
2692 @item @emph{Return value}:
2693 The return value is of type @code{REAL} and it is positive
2694 (@math{ \cosh (x) \geq 0 }). For a @code{REAL} argument @var{X},
2695 @math{ \cosh (x) \geq 1 }.
2696 The return value is of the same kind as @var{X}.
2698 @item @emph{Example}:
2701 real(8) :: x = 1.0_8
2703 end program test_cosh
2706 @item @emph{Specific names}:
2707 @multitable @columnfractions .20 .20 .20 .25
2708 @item Name @tab Argument @tab Return type @tab Standard
2709 @item @code{DCOSH(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
2712 @item @emph{See also}:
2713 Inverse function: @ref{ACOSH}
2720 @section @code{COUNT} --- Count function
2722 @cindex array, conditionally count elements
2723 @cindex array, element counting
2724 @cindex array, number of elements
2727 @item @emph{Description}:
2729 @code{COUNT(MASK [, DIM [, KIND]])} counts the number of @code{.TRUE.}
2730 elements of @var{MASK} along the dimension of @var{DIM}. If @var{DIM} is
2731 omitted it is taken to be @code{1}. @var{DIM} is a scalar of type
2732 @code{INTEGER} in the range of @math{1 /leq DIM /leq n)} where @math{n}
2733 is the rank of @var{MASK}.
2735 @item @emph{Standard}:
2736 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
2739 Transformational function
2741 @item @emph{Syntax}:
2742 @code{RESULT = COUNT(MASK [, DIM [, KIND]])}
2744 @item @emph{Arguments}:
2745 @multitable @columnfractions .15 .70
2746 @item @var{MASK} @tab The type shall be @code{LOGICAL}.
2747 @item @var{DIM} @tab (Optional) The type shall be @code{INTEGER}.
2748 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
2749 expression indicating the kind parameter of the result.
2752 @item @emph{Return value}:
2753 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
2754 @var{KIND} is absent, the return value is of default integer kind.
2755 The result has a rank equal to that of @var{MASK}.
2757 @item @emph{Example}:
2760 integer, dimension(2,3) :: a, b
2761 logical, dimension(2,3) :: mask
2762 a = reshape( (/ 1, 2, 3, 4, 5, 6 /), (/ 2, 3 /))
2763 b = reshape( (/ 0, 7, 3, 4, 5, 8 /), (/ 2, 3 /))
2764 print '(3i3)', a(1,:)
2765 print '(3i3)', a(2,:)
2767 print '(3i3)', b(1,:)
2768 print '(3i3)', b(2,:)
2771 print '(3l3)', mask(1,:)
2772 print '(3l3)', mask(2,:)
2774 print '(3i3)', count(mask)
2776 print '(3i3)', count(mask, 1)
2778 print '(3i3)', count(mask, 2)
2779 end program test_count
2786 @section @code{CPU_TIME} --- CPU elapsed time in seconds
2788 @cindex time, elapsed
2791 @item @emph{Description}:
2792 Returns a @code{REAL} value representing the elapsed CPU time in
2793 seconds. This is useful for testing segments of code to determine
2796 If a time source is available, time will be reported with microsecond
2797 resolution. If no time source is available, @var{TIME} is set to
2800 Note that @var{TIME} may contain a, system dependent, arbitrary offset
2801 and may not start with @code{0.0}. For @code{CPU_TIME}, the absolute
2802 value is meaningless, only differences between subsequent calls to
2803 this subroutine, as shown in the example below, should be used.
2806 @item @emph{Standard}:
2807 Fortran 95 and later
2812 @item @emph{Syntax}:
2813 @code{CALL CPU_TIME(TIME)}
2815 @item @emph{Arguments}:
2816 @multitable @columnfractions .15 .70
2817 @item @var{TIME} @tab The type shall be @code{REAL} with @code{INTENT(OUT)}.
2820 @item @emph{Return value}:
2823 @item @emph{Example}:
2825 program test_cpu_time
2826 real :: start, finish
2827 call cpu_time(start)
2828 ! put code to test here
2829 call cpu_time(finish)
2830 print '("Time = ",f6.3," seconds.")',finish-start
2831 end program test_cpu_time
2834 @item @emph{See also}:
2835 @ref{SYSTEM_CLOCK}, @ref{DATE_AND_TIME}
2841 @section @code{CSHIFT} --- Circular shift elements of an array
2843 @cindex array, shift circularly
2844 @cindex array, permutation
2845 @cindex array, rotate
2848 @item @emph{Description}:
2849 @code{CSHIFT(ARRAY, SHIFT [, DIM])} performs a circular shift on elements of
2850 @var{ARRAY} along the dimension of @var{DIM}. If @var{DIM} is omitted it is
2851 taken to be @code{1}. @var{DIM} is a scalar of type @code{INTEGER} in the
2852 range of @math{1 /leq DIM /leq n)} where @math{n} is the rank of @var{ARRAY}.
2853 If the rank of @var{ARRAY} is one, then all elements of @var{ARRAY} are shifted
2854 by @var{SHIFT} places. If rank is greater than one, then all complete rank one
2855 sections of @var{ARRAY} along the given dimension are shifted. Elements
2856 shifted out one end of each rank one section are shifted back in the other end.
2858 @item @emph{Standard}:
2859 Fortran 95 and later
2862 Transformational function
2864 @item @emph{Syntax}:
2865 @code{RESULT = CSHIFT(ARRAY, SHIFT [, DIM])}
2867 @item @emph{Arguments}:
2868 @multitable @columnfractions .15 .70
2869 @item @var{ARRAY} @tab Shall be an array of any type.
2870 @item @var{SHIFT} @tab The type shall be @code{INTEGER}.
2871 @item @var{DIM} @tab The type shall be @code{INTEGER}.
2874 @item @emph{Return value}:
2875 Returns an array of same type and rank as the @var{ARRAY} argument.
2877 @item @emph{Example}:
2880 integer, dimension(3,3) :: a
2881 a = reshape( (/ 1, 2, 3, 4, 5, 6, 7, 8, 9 /), (/ 3, 3 /))
2882 print '(3i3)', a(1,:)
2883 print '(3i3)', a(2,:)
2884 print '(3i3)', a(3,:)
2885 a = cshift(a, SHIFT=(/1, 2, -1/), DIM=2)
2887 print '(3i3)', a(1,:)
2888 print '(3i3)', a(2,:)
2889 print '(3i3)', a(3,:)
2890 end program test_cshift
2897 @section @code{CTIME} --- Convert a time into a string
2899 @cindex time, conversion to string
2900 @cindex conversion, to string
2903 @item @emph{Description}:
2904 @code{CTIME} converts a system time value, such as returned by
2905 @code{TIME8()}, to a string of the form @samp{Sat Aug 19 18:13:14 1995}.
2907 This intrinsic is provided in both subroutine and function forms; however,
2908 only one form can be used in any given program unit.
2910 @item @emph{Standard}:
2914 Subroutine, function
2916 @item @emph{Syntax}:
2917 @multitable @columnfractions .80
2918 @item @code{CALL CTIME(TIME, RESULT)}.
2919 @item @code{RESULT = CTIME(TIME)}, (not recommended).
2922 @item @emph{Arguments}:
2923 @multitable @columnfractions .15 .70
2924 @item @var{TIME} @tab The type shall be of type @code{INTEGER(KIND=8)}.
2925 @item @var{RESULT} @tab The type shall be of type @code{CHARACTER} and
2929 @item @emph{Return value}:
2930 The converted date and time as a string.
2932 @item @emph{Example}:
2936 character(len=30) :: date
2939 ! Do something, main part of the program
2942 print *, 'Program was started on ', date
2943 end program test_ctime
2946 @item @emph{See Also}:
2947 @ref{GMTIME}, @ref{LTIME}, @ref{TIME}, @ref{TIME8}
2953 @section @code{DATE_AND_TIME} --- Date and time subroutine
2954 @fnindex DATE_AND_TIME
2955 @cindex date, current
2956 @cindex current date
2957 @cindex time, current
2958 @cindex current time
2961 @item @emph{Description}:
2962 @code{DATE_AND_TIME(DATE, TIME, ZONE, VALUES)} gets the corresponding date and
2963 time information from the real-time system clock. @var{DATE} is
2964 @code{INTENT(OUT)} and has form ccyymmdd. @var{TIME} is @code{INTENT(OUT)} and
2965 has form hhmmss.sss. @var{ZONE} is @code{INTENT(OUT)} and has form (+-)hhmm,
2966 representing the difference with respect to Coordinated Universal Time (UTC).
2967 Unavailable time and date parameters return blanks.
2969 @var{VALUES} is @code{INTENT(OUT)} and provides the following:
2971 @multitable @columnfractions .15 .30 .40
2972 @item @tab @code{VALUE(1)}: @tab The year
2973 @item @tab @code{VALUE(2)}: @tab The month
2974 @item @tab @code{VALUE(3)}: @tab The day of the month
2975 @item @tab @code{VALUE(4)}: @tab Time difference with UTC in minutes
2976 @item @tab @code{VALUE(5)}: @tab The hour of the day
2977 @item @tab @code{VALUE(6)}: @tab The minutes of the hour
2978 @item @tab @code{VALUE(7)}: @tab The seconds of the minute
2979 @item @tab @code{VALUE(8)}: @tab The milliseconds of the second
2982 @item @emph{Standard}:
2983 Fortran 95 and later
2988 @item @emph{Syntax}:
2989 @code{CALL DATE_AND_TIME([DATE, TIME, ZONE, VALUES])}
2991 @item @emph{Arguments}:
2992 @multitable @columnfractions .15 .70
2993 @item @var{DATE} @tab (Optional) The type shall be @code{CHARACTER(LEN=8)}
2994 or larger, and of default kind.
2995 @item @var{TIME} @tab (Optional) The type shall be @code{CHARACTER(LEN=10)}
2996 or larger, and of default kind.
2997 @item @var{ZONE} @tab (Optional) The type shall be @code{CHARACTER(LEN=5)}
2998 or larger, and of default kind.
2999 @item @var{VALUES}@tab (Optional) The type shall be @code{INTEGER(8)}.
3002 @item @emph{Return value}:
3005 @item @emph{Example}:
3007 program test_time_and_date
3008 character(8) :: date
3009 character(10) :: time
3010 character(5) :: zone
3011 integer,dimension(8) :: values
3012 ! using keyword arguments
3013 call date_and_time(date,time,zone,values)
3014 call date_and_time(DATE=date,ZONE=zone)
3015 call date_and_time(TIME=time)
3016 call date_and_time(VALUES=values)
3017 print '(a,2x,a,2x,a)', date, time, zone
3018 print '(8i5))', values
3019 end program test_time_and_date
3022 @item @emph{See also}:
3023 @ref{CPU_TIME}, @ref{SYSTEM_CLOCK}
3029 @section @code{DBLE} --- Double conversion function
3031 @cindex conversion, to real
3034 @item @emph{Description}:
3035 @code{DBLE(A)} Converts @var{A} to double precision real type.
3037 @item @emph{Standard}:
3038 Fortran 77 and later
3043 @item @emph{Syntax}:
3044 @code{RESULT = DBLE(A)}
3046 @item @emph{Arguments}:
3047 @multitable @columnfractions .15 .70
3048 @item @var{A} @tab The type shall be @code{INTEGER}, @code{REAL},
3052 @item @emph{Return value}:
3053 The return value is of type double precision real.
3055 @item @emph{Example}:
3060 complex :: z = (2.3,1.14)
3061 print *, dble(x), dble(i), dble(z)
3062 end program test_dble
3065 @item @emph{See also}:
3066 @ref{DFLOAT}, @ref{FLOAT}, @ref{REAL}
3072 @section @code{DCMPLX} --- Double complex conversion function
3074 @cindex complex numbers, conversion to
3075 @cindex conversion, to complex
3078 @item @emph{Description}:
3079 @code{DCMPLX(X [,Y])} returns a double complex number where @var{X} is
3080 converted to the real component. If @var{Y} is present it is converted to the
3081 imaginary component. If @var{Y} is not present then the imaginary component is
3082 set to 0.0. If @var{X} is complex then @var{Y} must not be present.
3084 @item @emph{Standard}:
3090 @item @emph{Syntax}:
3091 @code{RESULT = DCMPLX(X [, Y])}
3093 @item @emph{Arguments}:
3094 @multitable @columnfractions .15 .70
3095 @item @var{X} @tab The type may be @code{INTEGER}, @code{REAL},
3097 @item @var{Y} @tab (Optional if @var{X} is not @code{COMPLEX}.) May be
3098 @code{INTEGER} or @code{REAL}.
3101 @item @emph{Return value}:
3102 The return value is of type @code{COMPLEX(8)}
3104 @item @emph{Example}:
3114 print *, dcmplx(x,i)
3115 end program test_dcmplx
3122 @section @code{DFLOAT} --- Double conversion function
3124 @cindex conversion, to real
3127 @item @emph{Description}:
3128 @code{DFLOAT(A)} Converts @var{A} to double precision real type.
3130 @item @emph{Standard}:
3136 @item @emph{Syntax}:
3137 @code{RESULT = DFLOAT(A)}
3139 @item @emph{Arguments}:
3140 @multitable @columnfractions .15 .70
3141 @item @var{A} @tab The type shall be @code{INTEGER}.
3144 @item @emph{Return value}:
3145 The return value is of type double precision real.
3147 @item @emph{Example}:
3152 end program test_dfloat
3155 @item @emph{See also}:
3156 @ref{DBLE}, @ref{FLOAT}, @ref{REAL}
3162 @section @code{DIGITS} --- Significant binary digits function
3164 @cindex model representation, significant digits
3167 @item @emph{Description}:
3168 @code{DIGITS(X)} returns the number of significant binary digits of the internal
3169 model representation of @var{X}. For example, on a system using a 32-bit
3170 floating point representation, a default real number would likely return 24.
3172 @item @emph{Standard}:
3173 Fortran 95 and later
3178 @item @emph{Syntax}:
3179 @code{RESULT = DIGITS(X)}
3181 @item @emph{Arguments}:
3182 @multitable @columnfractions .15 .70
3183 @item @var{X} @tab The type may be @code{INTEGER} or @code{REAL}.
3186 @item @emph{Return value}:
3187 The return value is of type @code{INTEGER}.
3189 @item @emph{Example}:
3192 integer :: i = 12345
3198 end program test_digits
3205 @section @code{DIM} --- Positive difference
3209 @cindex positive difference
3212 @item @emph{Description}:
3213 @code{DIM(X,Y)} returns the difference @code{X-Y} if the result is positive;
3214 otherwise returns zero.
3216 @item @emph{Standard}:
3217 Fortran 77 and later
3222 @item @emph{Syntax}:
3223 @code{RESULT = DIM(X, Y)}
3225 @item @emph{Arguments}:
3226 @multitable @columnfractions .15 .70
3227 @item @var{X} @tab The type shall be @code{INTEGER} or @code{REAL}
3228 @item @var{Y} @tab The type shall be the same type and kind as @var{X}.
3231 @item @emph{Return value}:
3232 The return value is of type @code{INTEGER} or @code{REAL}.
3234 @item @emph{Example}:
3240 x = dim(4.345_8, 2.111_8)
3243 end program test_dim
3246 @item @emph{Specific names}:
3247 @multitable @columnfractions .20 .20 .20 .25
3248 @item Name @tab Argument @tab Return type @tab Standard
3249 @item @code{IDIM(X,Y)} @tab @code{INTEGER(4) X,Y} @tab @code{INTEGER(4)} @tab Fortran 77 and later
3250 @item @code{DDIM(X,Y)} @tab @code{REAL(8) X,Y} @tab @code{REAL(8)} @tab Fortran 77 and later
3257 @section @code{DOT_PRODUCT} --- Dot product function
3258 @fnindex DOT_PRODUCT
3260 @cindex vector product
3261 @cindex product, vector
3264 @item @emph{Description}:
3265 @code{DOT_PRODUCT(VECTOR_A, VECTOR_B)} computes the dot product multiplication
3266 of two vectors @var{VECTOR_A} and @var{VECTOR_B}. The two vectors may be
3267 either numeric or logical and must be arrays of rank one and of equal size. If
3268 the vectors are @code{INTEGER} or @code{REAL}, the result is
3269 @code{SUM(VECTOR_A*VECTOR_B)}. If the vectors are @code{COMPLEX}, the result
3270 is @code{SUM(CONJG(VECTOR_A)*VECTOR_B)}. If the vectors are @code{LOGICAL},
3271 the result is @code{ANY(VECTOR_A .AND. VECTOR_B)}.
3273 @item @emph{Standard}:
3274 Fortran 95 and later
3277 Transformational function
3279 @item @emph{Syntax}:
3280 @code{RESULT = DOT_PRODUCT(VECTOR_A, VECTOR_B)}
3282 @item @emph{Arguments}:
3283 @multitable @columnfractions .15 .70
3284 @item @var{VECTOR_A} @tab The type shall be numeric or @code{LOGICAL}, rank 1.
3285 @item @var{VECTOR_B} @tab The type shall be numeric if @var{VECTOR_A} is of numeric type or @code{LOGICAL} if @var{VECTOR_A} is of type @code{LOGICAL}. @var{VECTOR_B} shall be a rank-one array.
3288 @item @emph{Return value}:
3289 If the arguments are numeric, the return value is a scalar of numeric type,
3290 @code{INTEGER}, @code{REAL}, or @code{COMPLEX}. If the arguments are
3291 @code{LOGICAL}, the return value is @code{.TRUE.} or @code{.FALSE.}.
3293 @item @emph{Example}:
3295 program test_dot_prod
3296 integer, dimension(3) :: a, b
3303 print *, dot_product(a,b)
3304 end program test_dot_prod
3311 @section @code{DPROD} --- Double product function
3313 @cindex product, double-precision
3316 @item @emph{Description}:
3317 @code{DPROD(X,Y)} returns the product @code{X*Y}.
3319 @item @emph{Standard}:
3320 Fortran 77 and later
3325 @item @emph{Syntax}:
3326 @code{RESULT = DPROD(X, Y)}
3328 @item @emph{Arguments}:
3329 @multitable @columnfractions .15 .70
3330 @item @var{X} @tab The type shall be @code{REAL}.
3331 @item @var{Y} @tab The type shall be @code{REAL}.
3334 @item @emph{Return value}:
3335 The return value is of type @code{REAL(8)}.
3337 @item @emph{Example}:
3345 end program test_dprod
3352 @section @code{DREAL} --- Double real part function
3354 @cindex complex numbers, real part
3357 @item @emph{Description}:
3358 @code{DREAL(Z)} returns the real part of complex variable @var{Z}.
3360 @item @emph{Standard}:
3366 @item @emph{Syntax}:
3367 @code{RESULT = DREAL(A)}
3369 @item @emph{Arguments}:
3370 @multitable @columnfractions .15 .70
3371 @item @var{A} @tab The type shall be @code{COMPLEX(8)}.
3374 @item @emph{Return value}:
3375 The return value is of type @code{REAL(8)}.
3377 @item @emph{Example}:
3380 complex(8) :: z = (1.3_8,7.2_8)
3382 end program test_dreal
3385 @item @emph{See also}:
3393 @section @code{DTIME} --- Execution time subroutine (or function)
3395 @cindex time, elapsed
3396 @cindex elapsed time
3399 @item @emph{Description}:
3400 @code{DTIME(TARRAY, RESULT)} initially returns the number of seconds of runtime
3401 since the start of the process's execution in @var{RESULT}. @var{TARRAY}
3402 returns the user and system components of this time in @code{TARRAY(1)} and
3403 @code{TARRAY(2)} respectively. @var{RESULT} is equal to @code{TARRAY(1) +
3406 Subsequent invocations of @code{DTIME} return values accumulated since the
3407 previous invocation.
3409 On some systems, the underlying timings are represented using types with
3410 sufficiently small limits that overflows (wrap around) are possible, such as
3411 32-bit types. Therefore, the values returned by this intrinsic might be, or
3412 become, negative, or numerically less than previous values, during a single
3413 run of the compiled program.
3415 Please note, that this implementation is thread safe if used within OpenMP
3416 directives, i.e., its state will be consistent while called from multiple
3417 threads. However, if @code{DTIME} is called from multiple threads, the result
3418 is still the time since the last invocation. This may not give the intended
3419 results. If possible, use @code{CPU_TIME} instead.
3421 This intrinsic is provided in both subroutine and function forms; however,
3422 only one form can be used in any given program unit.
3424 @var{TARRAY} and @var{RESULT} are @code{INTENT(OUT)} and provide the following:
3426 @multitable @columnfractions .15 .30 .40
3427 @item @tab @code{TARRAY(1)}: @tab User time in seconds.
3428 @item @tab @code{TARRAY(2)}: @tab System time in seconds.
3429 @item @tab @code{RESULT}: @tab Run time since start in seconds.
3432 @item @emph{Standard}:
3436 Subroutine, function
3438 @item @emph{Syntax}:
3439 @multitable @columnfractions .80
3440 @item @code{CALL DTIME(TARRAY, RESULT)}.
3441 @item @code{RESULT = DTIME(TARRAY)}, (not recommended).
3444 @item @emph{Arguments}:
3445 @multitable @columnfractions .15 .70
3446 @item @var{TARRAY}@tab The type shall be @code{REAL, DIMENSION(2)}.
3447 @item @var{RESULT}@tab The type shall be @code{REAL}.
3450 @item @emph{Return value}:
3451 Elapsed time in seconds since the last invocation or since the start of program
3452 execution if not called before.
3454 @item @emph{Example}:
3458 real, dimension(2) :: tarray
3460 call dtime(tarray, result)
3464 do i=1,100000000 ! Just a delay
3467 call dtime(tarray, result)
3471 end program test_dtime
3474 @item @emph{See also}:
3482 @section @code{EOSHIFT} --- End-off shift elements of an array
3484 @cindex array, shift
3487 @item @emph{Description}:
3488 @code{EOSHIFT(ARRAY, SHIFT[, BOUNDARY, DIM])} performs an end-off shift on
3489 elements of @var{ARRAY} along the dimension of @var{DIM}. If @var{DIM} is
3490 omitted it is taken to be @code{1}. @var{DIM} is a scalar of type
3491 @code{INTEGER} in the range of @math{1 /leq DIM /leq n)} where @math{n} is the
3492 rank of @var{ARRAY}. If the rank of @var{ARRAY} is one, then all elements of
3493 @var{ARRAY} are shifted by @var{SHIFT} places. If rank is greater than one,
3494 then all complete rank one sections of @var{ARRAY} along the given dimension are
3495 shifted. Elements shifted out one end of each rank one section are dropped. If
3496 @var{BOUNDARY} is present then the corresponding value of from @var{BOUNDARY}
3497 is copied back in the other end. If @var{BOUNDARY} is not present then the
3498 following are copied in depending on the type of @var{ARRAY}.
3500 @multitable @columnfractions .15 .80
3501 @item @emph{Array Type} @tab @emph{Boundary Value}
3502 @item Numeric @tab 0 of the type and kind of @var{ARRAY}.
3503 @item Logical @tab @code{.FALSE.}.
3504 @item Character(@var{len}) @tab @var{len} blanks.
3507 @item @emph{Standard}:
3508 Fortran 95 and later
3511 Transformational function
3513 @item @emph{Syntax}:
3514 @code{RESULT = EOSHIFT(ARRAY, SHIFT [, BOUNDARY, DIM])}
3516 @item @emph{Arguments}:
3517 @multitable @columnfractions .15 .70
3518 @item @var{ARRAY} @tab May be any type, not scalar.
3519 @item @var{SHIFT} @tab The type shall be @code{INTEGER}.
3520 @item @var{BOUNDARY} @tab Same type as @var{ARRAY}.
3521 @item @var{DIM} @tab The type shall be @code{INTEGER}.
3524 @item @emph{Return value}:
3525 Returns an array of same type and rank as the @var{ARRAY} argument.
3527 @item @emph{Example}:
3529 program test_eoshift
3530 integer, dimension(3,3) :: a
3531 a = reshape( (/ 1, 2, 3, 4, 5, 6, 7, 8, 9 /), (/ 3, 3 /))
3532 print '(3i3)', a(1,:)
3533 print '(3i3)', a(2,:)
3534 print '(3i3)', a(3,:)
3535 a = EOSHIFT(a, SHIFT=(/1, 2, 1/), BOUNDARY=-5, DIM=2)
3537 print '(3i3)', a(1,:)
3538 print '(3i3)', a(2,:)
3539 print '(3i3)', a(3,:)
3540 end program test_eoshift
3547 @section @code{EPSILON} --- Epsilon function
3549 @cindex model representation, epsilon
3552 @item @emph{Description}:
3553 @code{EPSILON(X)} returns the smallest number @var{E} of the same kind
3554 as @var{X} such that @math{1 + E > 1}.
3556 @item @emph{Standard}:
3557 Fortran 95 and later
3562 @item @emph{Syntax}:
3563 @code{RESULT = EPSILON(X)}
3565 @item @emph{Arguments}:
3566 @multitable @columnfractions .15 .70
3567 @item @var{X} @tab The type shall be @code{REAL}.
3570 @item @emph{Return value}:
3571 The return value is of same type as the argument.
3573 @item @emph{Example}:
3575 program test_epsilon
3580 end program test_epsilon
3587 @section @code{ERF} --- Error function
3589 @cindex error function
3592 @item @emph{Description}:
3593 @code{ERF(X)} computes the error function of @var{X}.
3595 @item @emph{Standard}:
3596 Fortran 2008 and later
3601 @item @emph{Syntax}:
3602 @code{RESULT = ERF(X)}
3604 @item @emph{Arguments}:
3605 @multitable @columnfractions .15 .70
3606 @item @var{X} @tab The type shall be @code{REAL}.
3609 @item @emph{Return value}:
3610 The return value is of type @code{REAL}, of the same kind as
3611 @var{X} and lies in the range @math{-1 \leq erf (x) \leq 1 }.
3613 @item @emph{Example}:
3616 real(8) :: x = 0.17_8
3618 end program test_erf
3621 @item @emph{Specific names}:
3622 @multitable @columnfractions .20 .20 .20 .25
3623 @item Name @tab Argument @tab Return type @tab Standard
3624 @item @code{DERF(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
3631 @section @code{ERFC} --- Error function
3633 @cindex error function, complementary
3636 @item @emph{Description}:
3637 @code{ERFC(X)} computes the complementary error function of @var{X}.
3639 @item @emph{Standard}:
3640 Fortran 2008 and later
3645 @item @emph{Syntax}:
3646 @code{RESULT = ERFC(X)}
3648 @item @emph{Arguments}:
3649 @multitable @columnfractions .15 .70
3650 @item @var{X} @tab The type shall be @code{REAL}.
3653 @item @emph{Return value}:
3654 The return value is of type @code{REAL} and of the same kind as @var{X}.
3655 It lies in the range @math{ 0 \leq erfc (x) \leq 2 }.
3657 @item @emph{Example}:
3660 real(8) :: x = 0.17_8
3662 end program test_erfc
3665 @item @emph{Specific names}:
3666 @multitable @columnfractions .20 .20 .20 .25
3667 @item Name @tab Argument @tab Return type @tab Standard
3668 @item @code{DERFC(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU extension
3675 @section @code{ERFC_SCALED} --- Error function
3676 @fnindex ERFC_SCALED
3677 @cindex error function, complementary, exponentially-scaled
3680 @item @emph{Description}:
3681 @code{ERFC_SCALED(X)} computes the exponentially-scaled complementary
3682 error function of @var{X}.
3684 @item @emph{Standard}:
3685 Fortran 2008 and later
3690 @item @emph{Syntax}:
3691 @code{RESULT = ERFC_SCALED(X)}
3693 @item @emph{Arguments}:
3694 @multitable @columnfractions .15 .70
3695 @item @var{X} @tab The type shall be @code{REAL}.
3698 @item @emph{Return value}:
3699 The return value is of type @code{REAL} and of the same kind as @var{X}.
3701 @item @emph{Example}:
3703 program test_erfc_scaled
3704 real(8) :: x = 0.17_8
3706 end program test_erfc_scaled
3713 @section @code{ETIME} --- Execution time subroutine (or function)
3715 @cindex time, elapsed
3718 @item @emph{Description}:
3719 @code{ETIME(TARRAY, RESULT)} returns the number of seconds of runtime
3720 since the start of the process's execution in @var{RESULT}. @var{TARRAY}
3721 returns the user and system components of this time in @code{TARRAY(1)} and
3722 @code{TARRAY(2)} respectively. @var{RESULT} is equal to @code{TARRAY(1) + TARRAY(2)}.
3724 On some systems, the underlying timings are represented using types with
3725 sufficiently small limits that overflows (wrap around) are possible, such as
3726 32-bit types. Therefore, the values returned by this intrinsic might be, or
3727 become, negative, or numerically less than previous values, during a single
3728 run of the compiled program.
3730 This intrinsic is provided in both subroutine and function forms; however,
3731 only one form can be used in any given program unit.
3733 @var{TARRAY} and @var{RESULT} are @code{INTENT(OUT)} and provide the following:
3735 @multitable @columnfractions .15 .30 .60
3736 @item @tab @code{TARRAY(1)}: @tab User time in seconds.
3737 @item @tab @code{TARRAY(2)}: @tab System time in seconds.
3738 @item @tab @code{RESULT}: @tab Run time since start in seconds.
3741 @item @emph{Standard}:
3745 Subroutine, function
3747 @item @emph{Syntax}:
3748 @multitable @columnfractions .80
3749 @item @code{CALL ETIME(TARRAY, RESULT)}.
3750 @item @code{RESULT = ETIME(TARRAY)}, (not recommended).
3753 @item @emph{Arguments}:
3754 @multitable @columnfractions .15 .70
3755 @item @var{TARRAY}@tab The type shall be @code{REAL, DIMENSION(2)}.
3756 @item @var{RESULT}@tab The type shall be @code{REAL}.
3759 @item @emph{Return value}:
3760 Elapsed time in seconds since the start of program execution.
3762 @item @emph{Example}:
3766 real, dimension(2) :: tarray
3768 call ETIME(tarray, result)
3772 do i=1,100000000 ! Just a delay
3775 call ETIME(tarray, result)
3779 end program test_etime
3782 @item @emph{See also}:
3790 @section @code{EXIT} --- Exit the program with status.
3792 @cindex program termination
3793 @cindex terminate program
3796 @item @emph{Description}:
3797 @code{EXIT} causes immediate termination of the program with status. If status
3798 is omitted it returns the canonical @emph{success} for the system. All Fortran
3799 I/O units are closed.
3801 @item @emph{Standard}:
3807 @item @emph{Syntax}:
3808 @code{CALL EXIT([STATUS])}
3810 @item @emph{Arguments}:
3811 @multitable @columnfractions .15 .70
3812 @item @var{STATUS} @tab Shall be an @code{INTEGER} of the default kind.
3815 @item @emph{Return value}:
3816 @code{STATUS} is passed to the parent process on exit.
3818 @item @emph{Example}:
3821 integer :: STATUS = 0
3822 print *, 'This program is going to exit.'
3824 end program test_exit
3827 @item @emph{See also}:
3828 @ref{ABORT}, @ref{KILL}
3834 @section @code{EXP} --- Exponential function
3840 @cindex exponential function
3841 @cindex logarithmic function, inverse
3844 @item @emph{Description}:
3845 @code{EXP(X)} computes the base @math{e} exponential of @var{X}.
3847 @item @emph{Standard}:
3848 Fortran 77 and later, has overloads that are GNU extensions
3853 @item @emph{Syntax}:
3854 @code{RESULT = EXP(X)}
3856 @item @emph{Arguments}:
3857 @multitable @columnfractions .15 .70
3858 @item @var{X} @tab The type shall be @code{REAL} or
3862 @item @emph{Return value}:
3863 The return value has same type and kind as @var{X}.
3865 @item @emph{Example}:
3870 end program test_exp
3873 @item @emph{Specific names}:
3874 @multitable @columnfractions .20 .20 .20 .25
3875 @item Name @tab Argument @tab Return type @tab Standard
3876 @item @code{DEXP(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
3877 @item @code{CEXP(X)} @tab @code{COMPLEX(4) X} @tab @code{COMPLEX(4)} @tab Fortran 77 and later
3878 @item @code{ZEXP(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab GNU extension
3879 @item @code{CDEXP(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab GNU extension
3886 @section @code{EXPONENT} --- Exponent function
3888 @cindex real number, exponent
3889 @cindex floating point, exponent
3892 @item @emph{Description}:
3893 @code{EXPONENT(X)} returns the value of the exponent part of @var{X}. If @var{X}
3894 is zero the value returned is zero.
3896 @item @emph{Standard}:
3897 Fortran 95 and later
3902 @item @emph{Syntax}:
3903 @code{RESULT = EXPONENT(X)}
3905 @item @emph{Arguments}:
3906 @multitable @columnfractions .15 .70
3907 @item @var{X} @tab The type shall be @code{REAL}.
3910 @item @emph{Return value}:
3911 The return value is of type default @code{INTEGER}.
3913 @item @emph{Example}:
3915 program test_exponent
3920 print *, exponent(0.0)
3921 end program test_exponent
3928 @section @code{FDATE} --- Get the current time as a string
3930 @cindex time, current
3931 @cindex current time
3932 @cindex date, current
3933 @cindex current date
3936 @item @emph{Description}:
3937 @code{FDATE(DATE)} returns the current date (using the same format as
3938 @code{CTIME}) in @var{DATE}. It is equivalent to @code{CALL CTIME(DATE,
3941 This intrinsic is provided in both subroutine and function forms; however,
3942 only one form can be used in any given program unit.
3944 @var{DATE} is an @code{INTENT(OUT)} @code{CHARACTER} variable of the
3947 @item @emph{Standard}:
3951 Subroutine, function
3953 @item @emph{Syntax}:
3954 @multitable @columnfractions .80
3955 @item @code{CALL FDATE(DATE)}.
3956 @item @code{DATE = FDATE()}, (not recommended).
3959 @item @emph{Arguments}:
3960 @multitable @columnfractions .15 .70
3961 @item @var{DATE}@tab The type shall be of type @code{CHARACTER} of the
3965 @item @emph{Return value}:
3966 The current date as a string.
3968 @item @emph{Example}:
3972 character(len=30) :: date
3974 print *, 'Program started on ', date
3975 do i = 1, 100000000 ! Just a delay
3979 print *, 'Program ended on ', date
3980 end program test_fdate
3987 @section @code{FLOAT} --- Convert integer to default real
3989 @cindex conversion, to real
3992 @item @emph{Description}:
3993 @code{FLOAT(A)} converts the integer @var{A} to a default real value.
3995 @item @emph{Standard}:
3996 Fortran 77 and later
4001 @item @emph{Syntax}:
4002 @code{RESULT = FLOAT(A)}
4004 @item @emph{Arguments}:
4005 @multitable @columnfractions .15 .70
4006 @item @var{A} @tab The type shall be @code{INTEGER}.
4009 @item @emph{Return value}:
4010 The return value is of type default @code{REAL}.
4012 @item @emph{Example}:
4016 if (float(i) /= 1.) call abort
4017 end program test_float
4020 @item @emph{See also}:
4021 @ref{DBLE}, @ref{DFLOAT}, @ref{REAL}
4027 @section @code{FGET} --- Read a single character in stream mode from stdin
4029 @cindex read character, stream mode
4030 @cindex stream mode, read character
4031 @cindex file operation, read character
4034 @item @emph{Description}:
4035 Read a single character in stream mode from stdin by bypassing normal
4036 formatted output. Stream I/O should not be mixed with normal record-oriented
4037 (formatted or unformatted) I/O on the same unit; the results are unpredictable.
4039 This intrinsic is provided in both subroutine and function forms; however,
4040 only one form can be used in any given program unit.
4042 Note that the @code{FGET} intrinsic is provided for backwards compatibility with
4043 @command{g77}. GNU Fortran provides the Fortran 2003 Stream facility.
4044 Programmers should consider the use of new stream IO feature in new code
4045 for future portability. See also @ref{Fortran 2003 status}.
4047 @item @emph{Standard}:
4051 Subroutine, function
4053 @item @emph{Syntax}:
4054 @code{CALL FGET(C [, STATUS])}
4056 @item @emph{Arguments}:
4057 @multitable @columnfractions .15 .70
4058 @item @var{C} @tab The type shall be @code{CHARACTER} and of default
4060 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER}.
4061 Returns 0 on success, -1 on end-of-file, and a system specific positive
4062 error code otherwise.
4065 @item @emph{Example}:
4068 INTEGER, PARAMETER :: strlen = 100
4069 INTEGER :: status, i = 1
4070 CHARACTER(len=strlen) :: str = ""
4072 WRITE (*,*) 'Enter text:'
4074 CALL fget(str(i:i), status)
4075 if (status /= 0 .OR. i > strlen) exit
4078 WRITE (*,*) TRIM(str)
4082 @item @emph{See also}:
4083 @ref{FGETC}, @ref{FPUT}, @ref{FPUTC}
4089 @section @code{FGETC} --- Read a single character in stream mode
4091 @cindex read character, stream mode
4092 @cindex stream mode, read character
4093 @cindex file operation, read character
4096 @item @emph{Description}:
4097 Read a single character in stream mode by bypassing normal formatted output.
4098 Stream I/O should not be mixed with normal record-oriented (formatted or
4099 unformatted) I/O on the same unit; the results are unpredictable.
4101 This intrinsic is provided in both subroutine and function forms; however,
4102 only one form can be used in any given program unit.
4104 Note that the @code{FGET} intrinsic is provided for backwards compatibility
4105 with @command{g77}. GNU Fortran provides the Fortran 2003 Stream facility.
4106 Programmers should consider the use of new stream IO feature in new code
4107 for future portability. See also @ref{Fortran 2003 status}.
4109 @item @emph{Standard}:
4113 Subroutine, function
4115 @item @emph{Syntax}:
4116 @code{CALL FGETC(UNIT, C [, STATUS])}
4118 @item @emph{Arguments}:
4119 @multitable @columnfractions .15 .70
4120 @item @var{UNIT} @tab The type shall be @code{INTEGER}.
4121 @item @var{C} @tab The type shall be @code{CHARACTER} and of default
4123 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER}.
4124 Returns 0 on success, -1 on end-of-file and a system specific positive
4125 error code otherwise.
4128 @item @emph{Example}:
4131 INTEGER :: fd = 42, status
4134 OPEN(UNIT=fd, FILE="/etc/passwd", ACTION="READ", STATUS = "OLD")
4136 CALL fgetc(fd, c, status)
4137 IF (status /= 0) EXIT
4144 @item @emph{See also}:
4145 @ref{FGET}, @ref{FPUT}, @ref{FPUTC}
4151 @section @code{FLOOR} --- Integer floor function
4154 @cindex rounding, floor
4157 @item @emph{Description}:
4158 @code{FLOOR(A)} returns the greatest integer less than or equal to @var{X}.
4160 @item @emph{Standard}:
4161 Fortran 95 and later
4166 @item @emph{Syntax}:
4167 @code{RESULT = FLOOR(A [, KIND])}
4169 @item @emph{Arguments}:
4170 @multitable @columnfractions .15 .70
4171 @item @var{A} @tab The type shall be @code{REAL}.
4172 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
4173 expression indicating the kind parameter of the result.
4176 @item @emph{Return value}:
4177 The return value is of type @code{INTEGER(KIND)} if @var{KIND} is present
4178 and of default-kind @code{INTEGER} otherwise.
4180 @item @emph{Example}:
4185 print *, floor(x) ! returns 63
4186 print *, floor(y) ! returns -64
4187 end program test_floor
4190 @item @emph{See also}:
4191 @ref{CEILING}, @ref{NINT}
4198 @section @code{FLUSH} --- Flush I/O unit(s)
4200 @cindex file operation, flush
4203 @item @emph{Description}:
4204 Flushes Fortran unit(s) currently open for output. Without the optional
4205 argument, all units are flushed, otherwise just the unit specified.
4207 @item @emph{Standard}:
4213 @item @emph{Syntax}:
4214 @code{CALL FLUSH(UNIT)}
4216 @item @emph{Arguments}:
4217 @multitable @columnfractions .15 .70
4218 @item @var{UNIT} @tab (Optional) The type shall be @code{INTEGER}.
4222 Beginning with the Fortran 2003 standard, there is a @code{FLUSH}
4223 statement that should be preferred over the @code{FLUSH} intrinsic.
4230 @section @code{FNUM} --- File number function
4232 @cindex file operation, file number
4235 @item @emph{Description}:
4236 @code{FNUM(UNIT)} returns the POSIX file descriptor number corresponding to the
4237 open Fortran I/O unit @code{UNIT}.
4239 @item @emph{Standard}:
4245 @item @emph{Syntax}:
4246 @code{RESULT = FNUM(UNIT)}
4248 @item @emph{Arguments}:
4249 @multitable @columnfractions .15 .70
4250 @item @var{UNIT} @tab The type shall be @code{INTEGER}.
4253 @item @emph{Return value}:
4254 The return value is of type @code{INTEGER}
4256 @item @emph{Example}:
4260 open (unit=10, status = "scratch")
4264 end program test_fnum
4271 @section @code{FPUT} --- Write a single character in stream mode to stdout
4273 @cindex write character, stream mode
4274 @cindex stream mode, write character
4275 @cindex file operation, write character
4278 @item @emph{Description}:
4279 Write a single character in stream mode to stdout by bypassing normal
4280 formatted output. Stream I/O should not be mixed with normal record-oriented
4281 (formatted or unformatted) I/O on the same unit; the results are unpredictable.
4283 This intrinsic is provided in both subroutine and function forms; however,
4284 only one form can be used in any given program unit.
4286 Note that the @code{FGET} intrinsic is provided for backwards compatibility with
4287 @command{g77}. GNU Fortran provides the Fortran 2003 Stream facility.
4288 Programmers should consider the use of new stream IO feature in new code
4289 for future portability. See also @ref{Fortran 2003 status}.
4291 @item @emph{Standard}:
4295 Subroutine, function
4297 @item @emph{Syntax}:
4298 @code{CALL FPUT(C [, STATUS])}
4300 @item @emph{Arguments}:
4301 @multitable @columnfractions .15 .70
4302 @item @var{C} @tab The type shall be @code{CHARACTER} and of default
4304 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER}.
4305 Returns 0 on success, -1 on end-of-file and a system specific positive
4306 error code otherwise.
4309 @item @emph{Example}:
4312 CHARACTER(len=10) :: str = "gfortran"
4314 DO i = 1, len_trim(str)
4320 @item @emph{See also}:
4321 @ref{FPUTC}, @ref{FGET}, @ref{FGETC}
4327 @section @code{FPUTC} --- Write a single character in stream mode
4329 @cindex write character, stream mode
4330 @cindex stream mode, write character
4331 @cindex file operation, write character
4334 @item @emph{Description}:
4335 Write a single character in stream mode by bypassing normal formatted
4336 output. Stream I/O should not be mixed with normal record-oriented
4337 (formatted or unformatted) I/O on the same unit; the results are unpredictable.
4339 This intrinsic is provided in both subroutine and function forms; however,
4340 only one form can be used in any given program unit.
4342 Note that the @code{FGET} intrinsic is provided for backwards compatibility with
4343 @command{g77}. GNU Fortran provides the Fortran 2003 Stream facility.
4344 Programmers should consider the use of new stream IO feature in new code
4345 for future portability. See also @ref{Fortran 2003 status}.
4347 @item @emph{Standard}:
4351 Subroutine, function
4353 @item @emph{Syntax}:
4354 @code{CALL FPUTC(UNIT, C [, STATUS])}
4356 @item @emph{Arguments}:
4357 @multitable @columnfractions .15 .70
4358 @item @var{UNIT} @tab The type shall be @code{INTEGER}.
4359 @item @var{C} @tab The type shall be @code{CHARACTER} and of default
4361 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER}.
4362 Returns 0 on success, -1 on end-of-file and a system specific positive
4363 error code otherwise.
4366 @item @emph{Example}:
4369 CHARACTER(len=10) :: str = "gfortran"
4370 INTEGER :: fd = 42, i
4372 OPEN(UNIT = fd, FILE = "out", ACTION = "WRITE", STATUS="NEW")
4373 DO i = 1, len_trim(str)
4374 CALL fputc(fd, str(i:i))
4380 @item @emph{See also}:
4381 @ref{FPUT}, @ref{FGET}, @ref{FGETC}
4387 @section @code{FRACTION} --- Fractional part of the model representation
4389 @cindex real number, fraction
4390 @cindex floating point, fraction
4393 @item @emph{Description}:
4394 @code{FRACTION(X)} returns the fractional part of the model
4395 representation of @code{X}.
4397 @item @emph{Standard}:
4398 Fortran 95 and later
4403 @item @emph{Syntax}:
4404 @code{Y = FRACTION(X)}
4406 @item @emph{Arguments}:
4407 @multitable @columnfractions .15 .70
4408 @item @var{X} @tab The type of the argument shall be a @code{REAL}.
4411 @item @emph{Return value}:
4412 The return value is of the same type and kind as the argument.
4413 The fractional part of the model representation of @code{X} is returned;
4414 it is @code{X * RADIX(X)**(-EXPONENT(X))}.
4416 @item @emph{Example}:
4418 program test_fraction
4421 print *, fraction(x), x * radix(x)**(-exponent(x))
4422 end program test_fraction
4430 @section @code{FREE} --- Frees memory
4432 @cindex pointer, cray
4435 @item @emph{Description}:
4436 Frees memory previously allocated by @code{MALLOC()}. The @code{FREE}
4437 intrinsic is an extension intended to be used with Cray pointers, and is
4438 provided in GNU Fortran to allow user to compile legacy code. For
4439 new code using Fortran 95 pointers, the memory de-allocation intrinsic is
4442 @item @emph{Standard}:
4448 @item @emph{Syntax}:
4449 @code{CALL FREE(PTR)}
4451 @item @emph{Arguments}:
4452 @multitable @columnfractions .15 .70
4453 @item @var{PTR} @tab The type shall be @code{INTEGER}. It represents the
4454 location of the memory that should be de-allocated.
4457 @item @emph{Return value}:
4460 @item @emph{Example}:
4461 See @code{MALLOC} for an example.
4463 @item @emph{See also}:
4470 @section @code{FSEEK} --- Low level file positioning subroutine
4472 @cindex file operation, seek
4473 @cindex file operation, position
4476 @item @emph{Description}:
4477 Moves @var{UNIT} to the specified @var{OFFSET}. If @var{WHENCE}
4478 is set to 0, the @var{OFFSET} is taken as an absolute value @code{SEEK_SET},
4479 if set to 1, @var{OFFSET} is taken to be relative to the current position
4480 @code{SEEK_CUR}, and if set to 2 relative to the end of the file @code{SEEK_END}.
4481 On error, @var{STATUS} is set to a nonzero value. If @var{STATUS} the seek
4484 This intrinsic routine is not fully backwards compatible with @command{g77}.
4485 In @command{g77}, the @code{FSEEK} takes a statement label instead of a
4486 @var{STATUS} variable. If FSEEK is used in old code, change
4488 CALL FSEEK(UNIT, OFFSET, WHENCE, *label)
4493 CALL FSEEK(UNIT, OFFSET, WHENCE, status)
4494 IF (status /= 0) GOTO label
4497 Please note that GNU Fortran provides the Fortran 2003 Stream facility.
4498 Programmers should consider the use of new stream IO feature in new code
4499 for future portability. See also @ref{Fortran 2003 status}.
4501 @item @emph{Standard}:
4507 @item @emph{Syntax}:
4508 @code{CALL FSEEK(UNIT, OFFSET, WHENCE[, STATUS])}
4510 @item @emph{Arguments}:
4511 @multitable @columnfractions .15 .70
4512 @item @var{UNIT} @tab Shall be a scalar of type @code{INTEGER}.
4513 @item @var{OFFSET} @tab Shall be a scalar of type @code{INTEGER}.
4514 @item @var{WHENCE} @tab Shall be a scalar of type @code{INTEGER}.
4515 Its value shall be either 0, 1 or 2.
4516 @item @var{STATUS} @tab (Optional) shall be a scalar of type
4520 @item @emph{Example}:
4523 INTEGER, PARAMETER :: SEEK_SET = 0, SEEK_CUR = 1, SEEK_END = 2
4524 INTEGER :: fd, offset, ierr
4530 OPEN(UNIT=fd, FILE="fseek.test")
4531 CALL FSEEK(fd, offset, SEEK_SET, ierr) ! move to OFFSET
4532 print *, FTELL(fd), ierr
4534 CALL FSEEK(fd, 0, SEEK_END, ierr) ! move to end
4535 print *, FTELL(fd), ierr
4537 CALL FSEEK(fd, 0, SEEK_SET, ierr) ! move to beginning
4538 print *, FTELL(fd), ierr
4544 @item @emph{See also}:
4551 @section @code{FSTAT} --- Get file status
4553 @cindex file system, file status
4556 @item @emph{Description}:
4557 @code{FSTAT} is identical to @ref{STAT}, except that information about an
4558 already opened file is obtained.
4560 The elements in @code{BUFF} are the same as described by @ref{STAT}.
4562 This intrinsic is provided in both subroutine and function forms; however,
4563 only one form can be used in any given program unit.
4565 @item @emph{Standard}:
4569 Subroutine, function
4571 @item @emph{Syntax}:
4572 @code{CALL FSTAT(UNIT, BUFF [, STATUS])}
4574 @item @emph{Arguments}:
4575 @multitable @columnfractions .15 .70
4576 @item @var{UNIT} @tab An open I/O unit number of type @code{INTEGER}.
4577 @item @var{BUFF} @tab The type shall be @code{INTEGER(4), DIMENSION(13)}.
4578 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER(4)}. Returns 0
4579 on success and a system specific error code otherwise.
4582 @item @emph{Example}:
4583 See @ref{STAT} for an example.
4585 @item @emph{See also}:
4586 To stat a link: @ref{LSTAT}, to stat a file: @ref{STAT}
4592 @section @code{FTELL} --- Current stream position
4594 @cindex file operation, position
4597 @item @emph{Description}:
4598 Retrieves the current position within an open file.
4600 This intrinsic is provided in both subroutine and function forms; however,
4601 only one form can be used in any given program unit.
4603 @item @emph{Standard}:
4607 Subroutine, function
4609 @item @emph{Syntax}:
4610 @multitable @columnfractions .80
4611 @item @code{CALL FTELL(UNIT, OFFSET)}
4612 @item @code{OFFSET = FTELL(UNIT)}
4615 @item @emph{Arguments}:
4616 @multitable @columnfractions .15 .70
4617 @item @var{OFFSET} @tab Shall of type @code{INTEGER}.
4618 @item @var{UNIT} @tab Shall of type @code{INTEGER}.
4621 @item @emph{Return value}:
4622 In either syntax, @var{OFFSET} is set to the current offset of unit
4623 number @var{UNIT}, or to @math{-1} if the unit is not currently open.
4625 @item @emph{Example}:
4629 OPEN(10, FILE="temp.dat")
4635 @item @emph{See also}:
4642 @section @code{GAMMA} --- Gamma function
4645 @cindex Gamma function
4646 @cindex Factorial function
4649 @item @emph{Description}:
4650 @code{GAMMA(X)} computes Gamma (@math{\Gamma}) of @var{X}. For positive,
4651 integer values of @var{X} the Gamma function simplifies to the factorial
4652 function @math{\Gamma(x)=(x-1)!}.
4656 \Gamma(x) = \int_0^\infty t^{x-1}{\rm e}^{-t}\,{\rm d}t
4660 @item @emph{Standard}:
4661 Fortran 2008 and later
4666 @item @emph{Syntax}:
4669 @item @emph{Arguments}:
4670 @multitable @columnfractions .15 .70
4671 @item @var{X} @tab Shall be of type @code{REAL} and neither zero
4672 nor a negative integer.
4675 @item @emph{Return value}:
4676 The return value is of type @code{REAL} of the same kind as @var{X}.
4678 @item @emph{Example}:
4682 x = gamma(x) ! returns 1.0
4683 end program test_gamma
4686 @item @emph{Specific names}:
4687 @multitable @columnfractions .20 .20 .20 .25
4688 @item Name @tab Argument @tab Return type @tab Standard
4689 @item @code{GAMMA(X)} @tab @code{REAL(4) X} @tab @code{REAL(4)} @tab GNU Extension
4690 @item @code{DGAMMA(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU Extension
4693 @item @emph{See also}:
4694 Logarithm of the Gamma function: @ref{LOG_GAMMA}
4701 @section @code{GERROR} --- Get last system error message
4703 @cindex system, error handling
4706 @item @emph{Description}:
4707 Returns the system error message corresponding to the last system error.
4708 This resembles the functionality of @code{strerror(3)} in C.
4710 @item @emph{Standard}:
4716 @item @emph{Syntax}:
4717 @code{CALL GERROR(RESULT)}
4719 @item @emph{Arguments}:
4720 @multitable @columnfractions .15 .70
4721 @item @var{RESULT} @tab Shall of type @code{CHARACTER} and of default
4724 @item @emph{Example}:
4727 CHARACTER(len=100) :: msg
4733 @item @emph{See also}:
4734 @ref{IERRNO}, @ref{PERROR}
4740 @section @code{GETARG} --- Get command line arguments
4742 @cindex command-line arguments
4743 @cindex arguments, to program
4746 @item @emph{Description}:
4747 Retrieve the @var{POS}-th argument that was passed on the
4748 command line when the containing program was invoked.
4750 This intrinsic routine is provided for backwards compatibility with
4751 GNU Fortran 77. In new code, programmers should consider the use of
4752 the @ref{GET_COMMAND_ARGUMENT} intrinsic defined by the Fortran 2003
4755 @item @emph{Standard}:
4761 @item @emph{Syntax}:
4762 @code{CALL GETARG(POS, VALUE)}
4764 @item @emph{Arguments}:
4765 @multitable @columnfractions .15 .70
4766 @item @var{POS} @tab Shall be of type @code{INTEGER} and not wider than
4767 the default integer kind; @math{@var{POS} \geq 0}
4768 @item @var{VALUE} @tab Shall be of type @code{CHARACTER} and of default
4770 @item @var{VALUE} @tab Shall be of type @code{CHARACTER}.
4773 @item @emph{Return value}:
4774 After @code{GETARG} returns, the @var{VALUE} argument holds the
4775 @var{POS}th command line argument. If @var{VALUE} can not hold the
4776 argument, it is truncated to fit the length of @var{VALUE}. If there are
4777 less than @var{POS} arguments specified at the command line, @var{VALUE}
4778 will be filled with blanks. If @math{@var{POS} = 0}, @var{VALUE} is set
4779 to the name of the program (on systems that support this feature).
4781 @item @emph{Example}:
4785 CHARACTER(len=32) :: arg
4794 @item @emph{See also}:
4795 GNU Fortran 77 compatibility function: @ref{IARGC}
4797 Fortran 2003 functions and subroutines: @ref{GET_COMMAND},
4798 @ref{GET_COMMAND_ARGUMENT}, @ref{COMMAND_ARGUMENT_COUNT}
4804 @section @code{GET_COMMAND} --- Get the entire command line
4805 @fnindex GET_COMMAND
4806 @cindex command-line arguments
4807 @cindex arguments, to program
4810 @item @emph{Description}:
4811 Retrieve the entire command line that was used to invoke the program.
4813 @item @emph{Standard}:
4814 Fortran 2003 and later
4819 @item @emph{Syntax}:
4820 @code{CALL GET_COMMAND(COMMAND)}
4822 @item @emph{Arguments}:
4823 @multitable @columnfractions .15 .70
4824 @item @var{COMMAND} @tab Shall be of type @code{CHARACTER} and of default
4828 @item @emph{Return value}:
4829 Stores the entire command line that was used to invoke the program in
4830 @var{COMMAND}. If @var{COMMAND} is not large enough, the command will be
4833 @item @emph{Example}:
4835 PROGRAM test_get_command
4836 CHARACTER(len=255) :: cmd
4837 CALL get_command(cmd)
4838 WRITE (*,*) TRIM(cmd)
4842 @item @emph{See also}:
4843 @ref{GET_COMMAND_ARGUMENT}, @ref{COMMAND_ARGUMENT_COUNT}
4848 @node GET_COMMAND_ARGUMENT
4849 @section @code{GET_COMMAND_ARGUMENT} --- Get command line arguments
4850 @fnindex GET_COMMAND_ARGUMENT
4851 @cindex command-line arguments
4852 @cindex arguments, to program
4855 @item @emph{Description}:
4856 Retrieve the @var{NUMBER}-th argument that was passed on the
4857 command line when the containing program was invoked.
4859 @item @emph{Standard}:
4860 Fortran 2003 and later
4865 @item @emph{Syntax}:
4866 @code{CALL GET_COMMAND_ARGUMENT(NUMBER [, VALUE, LENGTH, STATUS])}
4868 @item @emph{Arguments}:
4869 @multitable @columnfractions .15 .70
4870 @item @var{NUMBER} @tab Shall be a scalar of type @code{INTEGER(4)},
4871 @math{@var{NUMBER} \geq 0}
4872 @item @var{VALUE} @tab Shall be a scalar of type @code{CHARACTER}
4873 and of default kind.
4874 @item @var{LENGTH} @tab (Option) Shall be a scalar of type @code{INTEGER(4)}.
4875 @item @var{STATUS} @tab (Option) Shall be a scalar of type @code{INTEGER(4)}.
4878 @item @emph{Return value}:
4879 After @code{GET_COMMAND_ARGUMENT} returns, the @var{VALUE} argument holds the
4880 @var{NUMBER}-th command line argument. If @var{VALUE} can not hold the argument, it is
4881 truncated to fit the length of @var{VALUE}. If there are less than @var{NUMBER}
4882 arguments specified at the command line, @var{VALUE} will be filled with blanks.
4883 If @math{@var{NUMBER} = 0}, @var{VALUE} is set to the name of the program (on
4884 systems that support this feature). The @var{LENGTH} argument contains the
4885 length of the @var{NUMBER}-th command line argument. If the argument retrieval
4886 fails, @var{STATUS} is a positive number; if @var{VALUE} contains a truncated
4887 command line argument, @var{STATUS} is -1; and otherwise the @var{STATUS} is
4890 @item @emph{Example}:
4892 PROGRAM test_get_command_argument
4894 CHARACTER(len=32) :: arg
4898 CALL get_command_argument(i, arg)
4899 IF (LEN_TRIM(arg) == 0) EXIT
4901 WRITE (*,*) TRIM(arg)
4907 @item @emph{See also}:
4908 @ref{GET_COMMAND}, @ref{COMMAND_ARGUMENT_COUNT}
4914 @section @code{GETCWD} --- Get current working directory
4916 @cindex system, working directory
4919 @item @emph{Description}:
4920 Get current working directory.
4922 This intrinsic is provided in both subroutine and function forms; however,
4923 only one form can be used in any given program unit.
4925 @item @emph{Standard}:
4929 Subroutine, function
4931 @item @emph{Syntax}:
4932 @code{CALL GETCWD(C [, STATUS])}
4934 @item @emph{Arguments}:
4935 @multitable @columnfractions .15 .70
4936 @item @var{C} @tab The type shall be @code{CHARACTER} and of default kind.
4937 @item @var{STATUS} @tab (Optional) status flag. Returns 0 on success,
4938 a system specific and nonzero error code otherwise.
4941 @item @emph{Example}:
4944 CHARACTER(len=255) :: cwd
4946 WRITE(*,*) TRIM(cwd)
4950 @item @emph{See also}:
4957 @section @code{GETENV} --- Get an environmental variable
4959 @cindex environment variable
4962 @item @emph{Description}:
4963 Get the @var{VALUE} of the environmental variable @var{NAME}.
4965 This intrinsic routine is provided for backwards compatibility with
4966 GNU Fortran 77. In new code, programmers should consider the use of
4967 the @ref{GET_ENVIRONMENT_VARIABLE} intrinsic defined by the Fortran
4970 @item @emph{Standard}:
4976 @item @emph{Syntax}:
4977 @code{CALL GETENV(NAME, VALUE)}
4979 @item @emph{Arguments}:
4980 @multitable @columnfractions .15 .70
4981 @item @var{NAME} @tab Shall be of type @code{CHARACTER} and of default kind.
4982 @item @var{VALUE} @tab Shall be of type @code{CHARACTER} and of default kind.
4985 @item @emph{Return value}:
4986 Stores the value of @var{NAME} in @var{VALUE}. If @var{VALUE} is
4987 not large enough to hold the data, it is truncated. If @var{NAME}
4988 is not set, @var{VALUE} will be filled with blanks.
4990 @item @emph{Example}:
4993 CHARACTER(len=255) :: homedir
4994 CALL getenv("HOME", homedir)
4995 WRITE (*,*) TRIM(homedir)
4999 @item @emph{See also}:
5000 @ref{GET_ENVIRONMENT_VARIABLE}
5005 @node GET_ENVIRONMENT_VARIABLE
5006 @section @code{GET_ENVIRONMENT_VARIABLE} --- Get an environmental variable
5007 @fnindex GET_ENVIRONMENT_VARIABLE
5008 @cindex environment variable
5011 @item @emph{Description}:
5012 Get the @var{VALUE} of the environmental variable @var{NAME}.
5014 @item @emph{Standard}:
5015 Fortran 2003 and later
5020 @item @emph{Syntax}:
5021 @code{CALL GET_ENVIRONMENT_VARIABLE(NAME[, VALUE, LENGTH, STATUS, TRIM_NAME)}
5023 @item @emph{Arguments}:
5024 @multitable @columnfractions .15 .70
5025 @item @var{NAME} @tab Shall be a scalar of type @code{CHARACTER(1)}.
5026 @item @var{VALUE} @tab Shall be a scalar of type @code{CHARACTER(1)}.
5027 @item @var{LENGTH} @tab Shall be a scalar of type @code{INTEGER(4)}.
5028 @item @var{STATUS} @tab Shall be a scalar of type @code{INTEGER(4)}.
5029 @item @var{TRIM_NAME} @tab Shall be a scalar of type @code{LOGICAL(4)}.
5032 @item @emph{Return value}:
5033 Stores the value of @var{NAME} in @var{VALUE}. If @var{VALUE} is
5034 not large enough to hold the data, it is truncated. If @var{NAME}
5035 is not set, @var{VALUE} will be filled with blanks. Argument @var{LENGTH}
5036 contains the length needed for storing the environment variable @var{NAME}
5037 or zero if it is not present. @var{STATUS} is -1 if @var{VALUE} is present
5038 but too short for the environment variable; it is 1 if the environment
5039 variable does not exist and 2 if the processor does not support environment
5040 variables; in all other cases @var{STATUS} is zero. If @var{TRIM_NAME} is
5041 present with the value @code{.FALSE.}, the trailing blanks in @var{NAME}
5042 are significant; otherwise they are not part of the environment variable
5045 @item @emph{Example}:
5048 CHARACTER(len=255) :: homedir
5049 CALL get_environment_variable("HOME", homedir)
5050 WRITE (*,*) TRIM(homedir)
5058 @section @code{GETGID} --- Group ID function
5060 @cindex system, group id
5063 @item @emph{Description}:
5064 Returns the numerical group ID of the current process.
5066 @item @emph{Standard}:
5072 @item @emph{Syntax}:
5073 @code{RESULT = GETGID()}
5075 @item @emph{Return value}:
5076 The return value of @code{GETGID} is an @code{INTEGER} of the default
5080 @item @emph{Example}:
5081 See @code{GETPID} for an example.
5083 @item @emph{See also}:
5084 @ref{GETPID}, @ref{GETUID}
5090 @section @code{GETLOG} --- Get login name
5092 @cindex system, login name
5096 @item @emph{Description}:
5097 Gets the username under which the program is running.
5099 @item @emph{Standard}:
5105 @item @emph{Syntax}:
5106 @code{CALL GETLOG(C)}
5108 @item @emph{Arguments}:
5109 @multitable @columnfractions .15 .70
5110 @item @var{C} @tab Shall be of type @code{CHARACTER} and of default kind.
5113 @item @emph{Return value}:
5114 Stores the current user name in @var{LOGIN}. (On systems where POSIX
5115 functions @code{geteuid} and @code{getpwuid} are not available, and
5116 the @code{getlogin} function is not implemented either, this will
5117 return a blank string.)
5119 @item @emph{Example}:
5122 CHARACTER(32) :: login
5128 @item @emph{See also}:
5135 @section @code{GETPID} --- Process ID function
5137 @cindex system, process id
5141 @item @emph{Description}:
5142 Returns the numerical process identifier of the current process.
5144 @item @emph{Standard}:
5150 @item @emph{Syntax}:
5151 @code{RESULT = GETPID()}
5153 @item @emph{Return value}:
5154 The return value of @code{GETPID} is an @code{INTEGER} of the default
5158 @item @emph{Example}:
5161 print *, "The current process ID is ", getpid()
5162 print *, "Your numerical user ID is ", getuid()
5163 print *, "Your numerical group ID is ", getgid()
5167 @item @emph{See also}:
5168 @ref{GETGID}, @ref{GETUID}
5174 @section @code{GETUID} --- User ID function
5176 @cindex system, user id
5180 @item @emph{Description}:
5181 Returns the numerical user ID of the current process.
5183 @item @emph{Standard}:
5189 @item @emph{Syntax}:
5190 @code{RESULT = GETUID()}
5192 @item @emph{Return value}:
5193 The return value of @code{GETUID} is an @code{INTEGER} of the default
5197 @item @emph{Example}:
5198 See @code{GETPID} for an example.
5200 @item @emph{See also}:
5201 @ref{GETPID}, @ref{GETLOG}
5207 @section @code{GMTIME} --- Convert time to GMT info
5209 @cindex time, conversion to GMT info
5212 @item @emph{Description}:
5213 Given a system time value @var{TIME} (as provided by the @code{TIME8()}
5214 intrinsic), fills @var{VALUES} with values extracted from it appropriate
5215 to the UTC time zone (Universal Coordinated Time, also known in some
5216 countries as GMT, Greenwich Mean Time), using @code{gmtime(3)}.
5218 @item @emph{Standard}:
5224 @item @emph{Syntax}:
5225 @code{CALL GMTIME(TIME, VALUES)}
5227 @item @emph{Arguments}:
5228 @multitable @columnfractions .15 .70
5229 @item @var{TIME} @tab An @code{INTEGER} scalar expression
5230 corresponding to a system time, with @code{INTENT(IN)}.
5231 @item @var{VALUES} @tab A default @code{INTEGER} array with 9 elements,
5232 with @code{INTENT(OUT)}.
5235 @item @emph{Return value}:
5236 The elements of @var{VALUES} are assigned as follows:
5238 @item Seconds after the minute, range 0--59 or 0--61 to allow for leap
5240 @item Minutes after the hour, range 0--59
5241 @item Hours past midnight, range 0--23
5242 @item Day of month, range 0--31
5243 @item Number of months since January, range 0--12
5244 @item Years since 1900
5245 @item Number of days since Sunday, range 0--6
5246 @item Days since January 1
5247 @item Daylight savings indicator: positive if daylight savings is in
5248 effect, zero if not, and negative if the information is not available.
5251 @item @emph{See also}:
5252 @ref{CTIME}, @ref{LTIME}, @ref{TIME}, @ref{TIME8}
5259 @section @code{HOSTNM} --- Get system host name
5261 @cindex system, host name
5264 @item @emph{Description}:
5265 Retrieves the host name of the system on which the program is running.
5267 This intrinsic is provided in both subroutine and function forms; however,
5268 only one form can be used in any given program unit.
5270 @item @emph{Standard}:
5274 Subroutine, function
5276 @item @emph{Syntax}:
5277 @multitable @columnfractions .80
5278 @item @code{CALL HOSTNM(C [, STATUS])}
5279 @item @code{STATUS = HOSTNM(NAME)}
5282 @item @emph{Arguments}:
5283 @multitable @columnfractions .15 .70
5284 @item @var{C} @tab Shall of type @code{CHARACTER} and of default kind.
5285 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER}.
5286 Returns 0 on success, or a system specific error code otherwise.
5289 @item @emph{Return value}:
5290 In either syntax, @var{NAME} is set to the current hostname if it can
5291 be obtained, or to a blank string otherwise.
5298 @section @code{HUGE} --- Largest number of a kind
5300 @cindex limits, largest number
5301 @cindex model representation, largest number
5304 @item @emph{Description}:
5305 @code{HUGE(X)} returns the largest number that is not an infinity in
5306 the model of the type of @code{X}.
5308 @item @emph{Standard}:
5309 Fortran 95 and later
5314 @item @emph{Syntax}:
5315 @code{RESULT = HUGE(X)}
5317 @item @emph{Arguments}:
5318 @multitable @columnfractions .15 .70
5319 @item @var{X} @tab Shall be of type @code{REAL} or @code{INTEGER}.
5322 @item @emph{Return value}:
5323 The return value is of the same type and kind as @var{X}
5325 @item @emph{Example}:
5327 program test_huge_tiny
5328 print *, huge(0), huge(0.0), huge(0.0d0)
5329 print *, tiny(0.0), tiny(0.0d0)
5330 end program test_huge_tiny
5337 @section @code{HYPOT} --- Euclidean distance function
5339 @cindex Euclidean distance
5342 @item @emph{Description}:
5343 @code{HYPOT(X,Y)} is the Euclidean distance function. It is equal to
5344 @math{\sqrt{X^2 + Y^2}}, without undue underflow or overflow.
5346 @item @emph{Standard}:
5347 Fortran 2008 and later
5352 @item @emph{Syntax}:
5353 @code{RESULT = HYPOT(X, Y)}
5355 @item @emph{Arguments}:
5356 @multitable @columnfractions .15 .70
5357 @item @var{X} @tab The type shall be @code{REAL}.
5358 @item @var{Y} @tab The type and kind type parameter shall be the same as
5362 @item @emph{Return value}:
5363 The return value has the same type and kind type parameter as @var{X}.
5365 @item @emph{Example}:
5368 real(4) :: x = 1.e0_4, y = 0.5e0_4
5370 end program test_hypot
5377 @section @code{IACHAR} --- Code in @acronym{ASCII} collating sequence
5379 @cindex @acronym{ASCII} collating sequence
5380 @cindex collating sequence, @acronym{ASCII}
5381 @cindex conversion, to integer
5384 @item @emph{Description}:
5385 @code{IACHAR(C)} returns the code for the @acronym{ASCII} character
5386 in the first character position of @code{C}.
5388 @item @emph{Standard}:
5389 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
5394 @item @emph{Syntax}:
5395 @code{RESULT = IACHAR(C [, KIND])}
5397 @item @emph{Arguments}:
5398 @multitable @columnfractions .15 .70
5399 @item @var{C} @tab Shall be a scalar @code{CHARACTER}, with @code{INTENT(IN)}
5400 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
5401 expression indicating the kind parameter of the result.
5404 @item @emph{Return value}:
5405 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
5406 @var{KIND} is absent, the return value is of default integer kind.
5408 @item @emph{Example}:
5413 end program test_iachar
5417 See @ref{ICHAR} for a discussion of converting between numerical values
5418 and formatted string representations.
5420 @item @emph{See also}:
5421 @ref{ACHAR}, @ref{CHAR}, @ref{ICHAR}
5428 @section @code{IAND} --- Bitwise logical and
5430 @cindex bitwise logical and
5431 @cindex logical and, bitwise
5434 @item @emph{Description}:
5435 Bitwise logical @code{AND}.
5437 @item @emph{Standard}:
5438 Fortran 95 and later
5443 @item @emph{Syntax}:
5444 @code{RESULT = IAND(I, J)}
5446 @item @emph{Arguments}:
5447 @multitable @columnfractions .15 .70
5448 @item @var{I} @tab The type shall be @code{INTEGER}.
5449 @item @var{J} @tab The type shall be @code{INTEGER}, of the same
5450 kind as @var{I}. (As a GNU extension, different kinds are also
5454 @item @emph{Return value}:
5455 The return type is @code{INTEGER}, of the same kind as the
5456 arguments. (If the argument kinds differ, it is of the same kind as
5457 the larger argument.)
5459 @item @emph{Example}:
5463 DATA a / Z'F' /, b / Z'3' /
5464 WRITE (*,*) IAND(a, b)
5468 @item @emph{See also}:
5469 @ref{IOR}, @ref{IEOR}, @ref{IBITS}, @ref{IBSET}, @ref{IBCLR}, @ref{NOT}
5476 @section @code{IARGC} --- Get the number of command line arguments
5478 @cindex command-line arguments
5479 @cindex command-line arguments, number of
5480 @cindex arguments, to program
5483 @item @emph{Description}:
5484 @code{IARGC()} returns the number of arguments passed on the
5485 command line when the containing program was invoked.
5487 This intrinsic routine is provided for backwards compatibility with
5488 GNU Fortran 77. In new code, programmers should consider the use of
5489 the @ref{COMMAND_ARGUMENT_COUNT} intrinsic defined by the Fortran 2003
5492 @item @emph{Standard}:
5498 @item @emph{Syntax}:
5499 @code{RESULT = IARGC()}
5501 @item @emph{Arguments}:
5504 @item @emph{Return value}:
5505 The number of command line arguments, type @code{INTEGER(4)}.
5507 @item @emph{Example}:
5510 @item @emph{See also}:
5511 GNU Fortran 77 compatibility subroutine: @ref{GETARG}
5513 Fortran 2003 functions and subroutines: @ref{GET_COMMAND},
5514 @ref{GET_COMMAND_ARGUMENT}, @ref{COMMAND_ARGUMENT_COUNT}
5520 @section @code{IBCLR} --- Clear bit
5526 @item @emph{Description}:
5527 @code{IBCLR} returns the value of @var{I} with the bit at position
5528 @var{POS} set to zero.
5530 @item @emph{Standard}:
5531 Fortran 95 and later
5536 @item @emph{Syntax}:
5537 @code{RESULT = IBCLR(I, POS)}
5539 @item @emph{Arguments}:
5540 @multitable @columnfractions .15 .70
5541 @item @var{I} @tab The type shall be @code{INTEGER}.
5542 @item @var{POS} @tab The type shall be @code{INTEGER}.
5545 @item @emph{Return value}:
5546 The return value is of type @code{INTEGER} and of the same kind as
5549 @item @emph{See also}:
5550 @ref{IBITS}, @ref{IBSET}, @ref{IAND}, @ref{IOR}, @ref{IEOR}, @ref{MVBITS}
5557 @section @code{IBITS} --- Bit extraction
5560 @cindex bits, extract
5563 @item @emph{Description}:
5564 @code{IBITS} extracts a field of length @var{LEN} from @var{I},
5565 starting from bit position @var{POS} and extending left for @var{LEN}
5566 bits. The result is right-justified and the remaining bits are
5567 zeroed. The value of @code{POS+LEN} must be less than or equal to the
5568 value @code{BIT_SIZE(I)}.
5570 @item @emph{Standard}:
5571 Fortran 95 and later
5576 @item @emph{Syntax}:
5577 @code{RESULT = IBITS(I, POS, LEN)}
5579 @item @emph{Arguments}:
5580 @multitable @columnfractions .15 .70
5581 @item @var{I} @tab The type shall be @code{INTEGER}.
5582 @item @var{POS} @tab The type shall be @code{INTEGER}.
5583 @item @var{LEN} @tab The type shall be @code{INTEGER}.
5586 @item @emph{Return value}:
5587 The return value is of type @code{INTEGER} and of the same kind as
5590 @item @emph{See also}:
5591 @ref{BIT_SIZE}, @ref{IBCLR}, @ref{IBSET}, @ref{IAND}, @ref{IOR}, @ref{IEOR}
5597 @section @code{IBSET} --- Set bit
5602 @item @emph{Description}:
5603 @code{IBSET} returns the value of @var{I} with the bit at position
5604 @var{POS} set to one.
5606 @item @emph{Standard}:
5607 Fortran 95 and later
5612 @item @emph{Syntax}:
5613 @code{RESULT = IBSET(I, POS)}
5615 @item @emph{Arguments}:
5616 @multitable @columnfractions .15 .70
5617 @item @var{I} @tab The type shall be @code{INTEGER}.
5618 @item @var{POS} @tab The type shall be @code{INTEGER}.
5621 @item @emph{Return value}:
5622 The return value is of type @code{INTEGER} and of the same kind as
5625 @item @emph{See also}:
5626 @ref{IBCLR}, @ref{IBITS}, @ref{IAND}, @ref{IOR}, @ref{IEOR}, @ref{MVBITS}
5633 @section @code{ICHAR} --- Character-to-integer conversion function
5635 @cindex conversion, to integer
5638 @item @emph{Description}:
5639 @code{ICHAR(C)} returns the code for the character in the first character
5640 position of @code{C} in the system's native character set.
5641 The correspondence between characters and their codes is not necessarily
5642 the same across different GNU Fortran implementations.
5644 @item @emph{Standard}:
5645 Fortan 95 and later, with @var{KIND} argument Fortran 2003 and later
5650 @item @emph{Syntax}:
5651 @code{RESULT = ICHAR(C [, KIND])}
5653 @item @emph{Arguments}:
5654 @multitable @columnfractions .15 .70
5655 @item @var{C} @tab Shall be a scalar @code{CHARACTER}, with @code{INTENT(IN)}
5656 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
5657 expression indicating the kind parameter of the result.
5660 @item @emph{Return value}:
5661 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
5662 @var{KIND} is absent, the return value is of default integer kind.
5664 @item @emph{Example}:
5669 end program test_ichar
5673 No intrinsic exists to convert between a numeric value and a formatted
5674 character string representation -- for instance, given the
5675 @code{CHARACTER} value @code{'154'}, obtaining an @code{INTEGER} or
5676 @code{REAL} value with the value 154, or vice versa. Instead, this
5677 functionality is provided by internal-file I/O, as in the following
5682 character(len=10) string, string2
5685 ! Convert a string to a numeric value
5686 read (string,'(I10)') value
5689 ! Convert a value to a formatted string
5690 write (string2,'(I10)') value
5692 end program read_val
5695 @item @emph{See also}:
5696 @ref{ACHAR}, @ref{CHAR}, @ref{IACHAR}
5703 @section @code{IDATE} --- Get current local time subroutine (day/month/year)
5705 @cindex date, current
5706 @cindex current date
5709 @item @emph{Description}:
5710 @code{IDATE(TARRAY)} Fills @var{TARRAY} with the numerical values at the
5711 current local time. The day (in the range 1-31), month (in the range 1-12),
5712 and year appear in elements 1, 2, and 3 of @var{TARRAY}, respectively.
5713 The year has four significant digits.
5715 @item @emph{Standard}:
5721 @item @emph{Syntax}:
5722 @code{CALL IDATE(VALUES)}
5724 @item @emph{Arguments}:
5725 @multitable @columnfractions .15 .70
5726 @item @var{VALUES} @tab The type shall be @code{INTEGER, DIMENSION(3)} and
5727 the kind shall be the default integer kind.
5730 @item @emph{Return value}:
5731 Does not return anything.
5733 @item @emph{Example}:
5736 integer, dimension(3) :: tarray
5741 end program test_idate
5748 @section @code{IEOR} --- Bitwise logical exclusive or
5750 @cindex bitwise logical exclusive or
5751 @cindex logical exclusive or, bitwise
5754 @item @emph{Description}:
5755 @code{IEOR} returns the bitwise boolean exclusive-OR of @var{I} and
5758 @item @emph{Standard}:
5759 Fortran 95 and later
5764 @item @emph{Syntax}:
5765 @code{RESULT = IEOR(I, J)}
5767 @item @emph{Arguments}:
5768 @multitable @columnfractions .15 .70
5769 @item @var{I} @tab The type shall be @code{INTEGER}.
5770 @item @var{J} @tab The type shall be @code{INTEGER}, of the same
5771 kind as @var{I}. (As a GNU extension, different kinds are also
5775 @item @emph{Return value}:
5776 The return type is @code{INTEGER}, of the same kind as the
5777 arguments. (If the argument kinds differ, it is of the same kind as
5778 the larger argument.)
5780 @item @emph{See also}:
5781 @ref{IOR}, @ref{IAND}, @ref{IBITS}, @ref{IBSET}, @ref{IBCLR}, @ref{NOT}
5787 @section @code{IERRNO} --- Get the last system error number
5789 @cindex system, error handling
5792 @item @emph{Description}:
5793 Returns the last system error number, as given by the C @code{errno()}
5796 @item @emph{Standard}:
5802 @item @emph{Syntax}:
5803 @code{RESULT = IERRNO()}
5805 @item @emph{Arguments}:
5808 @item @emph{Return value}:
5809 The return value is of type @code{INTEGER} and of the default integer
5812 @item @emph{See also}:
5818 @node INDEX intrinsic
5819 @section @code{INDEX} --- Position of a substring within a string
5821 @cindex substring position
5822 @cindex string, find substring
5825 @item @emph{Description}:
5826 Returns the position of the start of the first occurrence of string
5827 @var{SUBSTRING} as a substring in @var{STRING}, counting from one. If
5828 @var{SUBSTRING} is not present in @var{STRING}, zero is returned. If
5829 the @var{BACK} argument is present and true, the return value is the
5830 start of the last occurrence rather than the first.
5832 @item @emph{Standard}:
5833 Fortran 77 and later, with @var{KIND} argument Fortran 2003 and later
5838 @item @emph{Syntax}:
5839 @code{RESULT = INDEX(STRING, SUBSTRING [, BACK [, KIND]])}
5841 @item @emph{Arguments}:
5842 @multitable @columnfractions .15 .70
5843 @item @var{STRING} @tab Shall be a scalar @code{CHARACTER}, with
5845 @item @var{SUBSTRING} @tab Shall be a scalar @code{CHARACTER}, with
5847 @item @var{BACK} @tab (Optional) Shall be a scalar @code{LOGICAL}, with
5849 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
5850 expression indicating the kind parameter of the result.
5853 @item @emph{Return value}:
5854 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
5855 @var{KIND} is absent, the return value is of default integer kind.
5857 @item @emph{See also}:
5858 @ref{SCAN}, @ref{VERIFY}
5864 @section @code{INT} --- Convert to integer type
5868 @cindex conversion, to integer
5871 @item @emph{Description}:
5872 Convert to integer type
5874 @item @emph{Standard}:
5875 Fortran 77 and later
5880 @item @emph{Syntax}:
5881 @code{RESULT = INT(A [, KIND))}
5883 @item @emph{Arguments}:
5884 @multitable @columnfractions .15 .70
5885 @item @var{A} @tab Shall be of type @code{INTEGER},
5886 @code{REAL}, or @code{COMPLEX}.
5887 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
5888 expression indicating the kind parameter of the result.
5891 @item @emph{Return value}:
5892 These functions return a @code{INTEGER} variable or array under
5893 the following rules:
5897 If @var{A} is of type @code{INTEGER}, @code{INT(A) = A}
5899 If @var{A} is of type @code{REAL} and @math{|A| < 1}, @code{INT(A)} equals @code{0}.
5900 If @math{|A| \geq 1}, then @code{INT(A)} equals the largest integer that does not exceed
5901 the range of @var{A} and whose sign is the same as the sign of @var{A}.
5903 If @var{A} is of type @code{COMPLEX}, rule B is applied to the real part of @var{A}.
5906 @item @emph{Example}:
5910 complex :: z = (-3.7, 1.0)
5912 print *, int(z), int(z,8)
5916 @item @emph{Specific names}:
5917 @multitable @columnfractions .20 .20 .20 .25
5918 @item Name @tab Argument @tab Return type @tab Standard
5919 @item @code{IFIX(A)} @tab @code{REAL(4) A} @tab @code{INTEGER} @tab Fortran 77 and later
5920 @item @code{IDINT(A)} @tab @code{REAL(8) A} @tab @code{INTEGER} @tab Fortran 77 and later
5928 @section @code{INT2} --- Convert to 16-bit integer type
5931 @cindex conversion, to integer
5934 @item @emph{Description}:
5935 Convert to a @code{KIND=2} integer type. This is equivalent to the
5936 standard @code{INT} intrinsic with an optional argument of
5937 @code{KIND=2}, and is only included for backwards compatibility.
5939 The @code{SHORT} intrinsic is equivalent to @code{INT2}.
5941 @item @emph{Standard}:
5947 @item @emph{Syntax}:
5948 @code{RESULT = INT2(A)}
5950 @item @emph{Arguments}:
5951 @multitable @columnfractions .15 .70
5952 @item @var{A} @tab Shall be of type @code{INTEGER},
5953 @code{REAL}, or @code{COMPLEX}.
5956 @item @emph{Return value}:
5957 The return value is a @code{INTEGER(2)} variable.
5959 @item @emph{See also}:
5960 @ref{INT}, @ref{INT8}, @ref{LONG}
5966 @section @code{INT8} --- Convert to 64-bit integer type
5968 @cindex conversion, to integer
5971 @item @emph{Description}:
5972 Convert to a @code{KIND=8} integer type. This is equivalent to the
5973 standard @code{INT} intrinsic with an optional argument of
5974 @code{KIND=8}, and is only included for backwards compatibility.
5976 @item @emph{Standard}:
5982 @item @emph{Syntax}:
5983 @code{RESULT = INT8(A)}
5985 @item @emph{Arguments}:
5986 @multitable @columnfractions .15 .70
5987 @item @var{A} @tab Shall be of type @code{INTEGER},
5988 @code{REAL}, or @code{COMPLEX}.
5991 @item @emph{Return value}:
5992 The return value is a @code{INTEGER(8)} variable.
5994 @item @emph{See also}:
5995 @ref{INT}, @ref{INT2}, @ref{LONG}
6001 @section @code{IOR} --- Bitwise logical or
6003 @cindex bitwise logical or
6004 @cindex logical or, bitwise
6007 @item @emph{Description}:
6008 @code{IOR} returns the bitwise boolean inclusive-OR of @var{I} and
6011 @item @emph{Standard}:
6012 Fortran 95 and later
6017 @item @emph{Syntax}:
6018 @code{RESULT = IOR(I, J)}
6020 @item @emph{Arguments}:
6021 @multitable @columnfractions .15 .70
6022 @item @var{I} @tab The type shall be @code{INTEGER}.
6023 @item @var{J} @tab The type shall be @code{INTEGER}, of the same
6024 kind as @var{I}. (As a GNU extension, different kinds are also
6028 @item @emph{Return value}:
6029 The return type is @code{INTEGER}, of the same kind as the
6030 arguments. (If the argument kinds differ, it is of the same kind as
6031 the larger argument.)
6033 @item @emph{See also}:
6034 @ref{IEOR}, @ref{IAND}, @ref{IBITS}, @ref{IBSET}, @ref{IBCLR}, @ref{NOT}
6040 @section @code{IRAND} --- Integer pseudo-random number
6042 @cindex random number generation
6045 @item @emph{Description}:
6046 @code{IRAND(FLAG)} returns a pseudo-random number from a uniform
6047 distribution between 0 and a system-dependent limit (which is in most
6048 cases 2147483647). If @var{FLAG} is 0, the next number
6049 in the current sequence is returned; if @var{FLAG} is 1, the generator
6050 is restarted by @code{CALL SRAND(0)}; if @var{FLAG} has any other value,
6051 it is used as a new seed with @code{SRAND}.
6053 This intrinsic routine is provided for backwards compatibility with
6054 GNU Fortran 77. It implements a simple modulo generator as provided
6055 by @command{g77}. For new code, one should consider the use of
6056 @ref{RANDOM_NUMBER} as it implements a superior algorithm.
6058 @item @emph{Standard}:
6064 @item @emph{Syntax}:
6065 @code{RESULT = IRAND(I)}
6067 @item @emph{Arguments}:
6068 @multitable @columnfractions .15 .70
6069 @item @var{I} @tab Shall be a scalar @code{INTEGER} of kind 4.
6072 @item @emph{Return value}:
6073 The return value is of @code{INTEGER(kind=4)} type.
6075 @item @emph{Example}:
6078 integer,parameter :: seed = 86456
6081 print *, irand(), irand(), irand(), irand()
6082 print *, irand(seed), irand(), irand(), irand()
6083 end program test_irand
6091 @section @code{IS_IOSTAT_END} --- Test for end-of-file value
6092 @fnindex IS_IOSTAT_END
6093 @cindex IOSTAT, end of file
6096 @item @emph{Description}:
6097 @code{IS_IOSTAT_END} tests whether an variable has the value of the I/O
6098 status ``end of file''. The function is equivalent to comparing the variable
6099 with the @code{IOSTAT_END} parameter of the intrinsic module
6100 @code{ISO_FORTRAN_ENV}.
6102 @item @emph{Standard}:
6103 Fortran 2003 and later
6108 @item @emph{Syntax}:
6109 @code{RESULT = IS_IOSTAT_END(I)}
6111 @item @emph{Arguments}:
6112 @multitable @columnfractions .15 .70
6113 @item @var{I} @tab Shall be of the type @code{INTEGER}.
6116 @item @emph{Return value}:
6117 Returns a @code{LOGICAL} of the default kind, which @code{.TRUE.} if
6118 @var{I} has the value which indicates an end of file condition for
6119 IOSTAT= specifiers, and is @code{.FALSE.} otherwise.
6121 @item @emph{Example}:
6126 OPEN(88, FILE='test.dat')
6127 READ(88, *, IOSTAT=stat) i
6128 IF(IS_IOSTAT_END(stat)) STOP 'END OF FILE'
6136 @section @code{IS_IOSTAT_EOR} --- Test for end-of-record value
6137 @fnindex IS_IOSTAT_EOR
6138 @cindex IOSTAT, end of record
6141 @item @emph{Description}:
6142 @code{IS_IOSTAT_EOR} tests whether an variable has the value of the I/O
6143 status ``end of record''. The function is equivalent to comparing the
6144 variable with the @code{IOSTAT_EOR} parameter of the intrinsic module
6145 @code{ISO_FORTRAN_ENV}.
6147 @item @emph{Standard}:
6148 Fortran 2003 and later
6153 @item @emph{Syntax}:
6154 @code{RESULT = IS_IOSTAT_EOR(I)}
6156 @item @emph{Arguments}:
6157 @multitable @columnfractions .15 .70
6158 @item @var{I} @tab Shall be of the type @code{INTEGER}.
6161 @item @emph{Return value}:
6162 Returns a @code{LOGICAL} of the default kind, which @code{.TRUE.} if
6163 @var{I} has the value which indicates an end of file condition for
6164 IOSTAT= specifiers, and is @code{.FALSE.} otherwise.
6166 @item @emph{Example}:
6170 INTEGER :: stat, i(50)
6171 OPEN(88, FILE='test.dat', FORM='UNFORMATTED')
6172 READ(88, IOSTAT=stat) i
6173 IF(IS_IOSTAT_EOR(stat)) STOP 'END OF RECORD'
6181 @section @code{ISATTY} --- Whether a unit is a terminal device.
6183 @cindex system, terminal
6186 @item @emph{Description}:
6187 Determine whether a unit is connected to a terminal device.
6189 @item @emph{Standard}:
6195 @item @emph{Syntax}:
6196 @code{RESULT = ISATTY(UNIT)}
6198 @item @emph{Arguments}:
6199 @multitable @columnfractions .15 .70
6200 @item @var{UNIT} @tab Shall be a scalar @code{INTEGER}.
6203 @item @emph{Return value}:
6204 Returns @code{.TRUE.} if the @var{UNIT} is connected to a terminal
6205 device, @code{.FALSE.} otherwise.
6207 @item @emph{Example}:
6210 INTEGER(kind=1) :: unit
6212 write(*,*) isatty(unit=unit)
6216 @item @emph{See also}:
6223 @section @code{ISHFT} --- Shift bits
6228 @item @emph{Description}:
6229 @code{ISHFT} returns a value corresponding to @var{I} with all of the
6230 bits shifted @var{SHIFT} places. A value of @var{SHIFT} greater than
6231 zero corresponds to a left shift, a value of zero corresponds to no
6232 shift, and a value less than zero corresponds to a right shift. If the
6233 absolute value of @var{SHIFT} is greater than @code{BIT_SIZE(I)}, the
6234 value is undefined. Bits shifted out from the left end or right end are
6235 lost; zeros are shifted in from the opposite end.
6237 @item @emph{Standard}:
6238 Fortran 95 and later
6243 @item @emph{Syntax}:
6244 @code{RESULT = ISHFT(I, SHIFT)}
6246 @item @emph{Arguments}:
6247 @multitable @columnfractions .15 .70
6248 @item @var{I} @tab The type shall be @code{INTEGER}.
6249 @item @var{SHIFT} @tab The type shall be @code{INTEGER}.
6252 @item @emph{Return value}:
6253 The return value is of type @code{INTEGER} and of the same kind as
6256 @item @emph{See also}:
6263 @section @code{ISHFTC} --- Shift bits circularly
6265 @cindex bits, shift circular
6268 @item @emph{Description}:
6269 @code{ISHFTC} returns a value corresponding to @var{I} with the
6270 rightmost @var{SIZE} bits shifted circularly @var{SHIFT} places; that
6271 is, bits shifted out one end are shifted into the opposite end. A value
6272 of @var{SHIFT} greater than zero corresponds to a left shift, a value of
6273 zero corresponds to no shift, and a value less than zero corresponds to
6274 a right shift. The absolute value of @var{SHIFT} must be less than
6275 @var{SIZE}. If the @var{SIZE} argument is omitted, it is taken to be
6276 equivalent to @code{BIT_SIZE(I)}.
6278 @item @emph{Standard}:
6279 Fortran 95 and later
6284 @item @emph{Syntax}:
6285 @code{RESULT = ISHFTC(I, SHIFT [, SIZE])}
6287 @item @emph{Arguments}:
6288 @multitable @columnfractions .15 .70
6289 @item @var{I} @tab The type shall be @code{INTEGER}.
6290 @item @var{SHIFT} @tab The type shall be @code{INTEGER}.
6291 @item @var{SIZE} @tab (Optional) The type shall be @code{INTEGER};
6292 the value must be greater than zero and less than or equal to
6296 @item @emph{Return value}:
6297 The return value is of type @code{INTEGER} and of the same kind as
6300 @item @emph{See also}:
6307 @section @code{ISNAN} --- Test for a NaN
6312 @item @emph{Description}:
6313 @code{ISNAN} tests whether a floating-point value is an IEEE
6315 @item @emph{Standard}:
6321 @item @emph{Syntax}:
6324 @item @emph{Arguments}:
6325 @multitable @columnfractions .15 .70
6326 @item @var{X} @tab Variable of the type @code{REAL}.
6330 @item @emph{Return value}:
6331 Returns a default-kind @code{LOGICAL}. The returned value is @code{TRUE}
6332 if @var{X} is a NaN and @code{FALSE} otherwise.
6334 @item @emph{Example}:
6341 if (isnan(x)) stop '"x" is a NaN'
6342 end program test_nan
6349 @section @code{ITIME} --- Get current local time subroutine (hour/minutes/seconds)
6351 @cindex time, current
6352 @cindex current time
6355 @item @emph{Description}:
6356 @code{IDATE(VALUES)} Fills @var{VALUES} with the numerical values at the
6357 current local time. The hour (in the range 1-24), minute (in the range 1-60),
6358 and seconds (in the range 1-60) appear in elements 1, 2, and 3 of @var{VALUES},
6361 @item @emph{Standard}:
6367 @item @emph{Syntax}:
6368 @code{CALL ITIME(VALUES)}
6370 @item @emph{Arguments}:
6371 @multitable @columnfractions .15 .70
6372 @item @var{VALUES} @tab The type shall be @code{INTEGER, DIMENSION(3)}
6373 and the kind shall be the default integer kind.
6376 @item @emph{Return value}:
6377 Does not return anything.
6380 @item @emph{Example}:
6383 integer, dimension(3) :: tarray
6388 end program test_itime
6395 @section @code{KILL} --- Send a signal to a process
6399 @item @emph{Description}:
6400 @item @emph{Standard}:
6401 Sends the signal specified by @var{SIGNAL} to the process @var{PID}.
6404 This intrinsic is provided in both subroutine and function forms; however,
6405 only one form can be used in any given program unit.
6408 Subroutine, function
6410 @item @emph{Syntax}:
6411 @code{CALL KILL(C, VALUE [, STATUS])}
6413 @item @emph{Arguments}:
6414 @multitable @columnfractions .15 .70
6415 @item @var{C} @tab Shall be a scalar @code{INTEGER}, with
6417 @item @var{VALUE} @tab Shall be a scalar @code{INTEGER}, with
6419 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER(4)} or
6420 @code{INTEGER(8)}. Returns 0 on success, or a system-specific error code
6424 @item @emph{See also}:
6425 @ref{ABORT}, @ref{EXIT}
6431 @section @code{KIND} --- Kind of an entity
6436 @item @emph{Description}:
6437 @code{KIND(X)} returns the kind value of the entity @var{X}.
6439 @item @emph{Standard}:
6440 Fortran 95 and later
6445 @item @emph{Syntax}:
6448 @item @emph{Arguments}:
6449 @multitable @columnfractions .15 .70
6450 @item @var{X} @tab Shall be of type @code{LOGICAL}, @code{INTEGER},
6451 @code{REAL}, @code{COMPLEX} or @code{CHARACTER}.
6454 @item @emph{Return value}:
6455 The return value is a scalar of type @code{INTEGER} and of the default
6458 @item @emph{Example}:
6461 integer,parameter :: kc = kind(' ')
6462 integer,parameter :: kl = kind(.true.)
6464 print *, "The default character kind is ", kc
6465 print *, "The default logical kind is ", kl
6466 end program test_kind
6474 @section @code{LBOUND} --- Lower dimension bounds of an array
6476 @cindex array, lower bound
6479 @item @emph{Description}:
6480 Returns the lower bounds of an array, or a single lower bound
6481 along the @var{DIM} dimension.
6482 @item @emph{Standard}:
6483 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
6488 @item @emph{Syntax}:
6489 @code{RESULT = LBOUND(ARRAY [, DIM [, KIND]])}
6491 @item @emph{Arguments}:
6492 @multitable @columnfractions .15 .70
6493 @item @var{ARRAY} @tab Shall be an array, of any type.
6494 @item @var{DIM} @tab (Optional) Shall be a scalar @code{INTEGER}.
6495 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
6496 expression indicating the kind parameter of the result.
6499 @item @emph{Return value}:
6500 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
6501 @var{KIND} is absent, the return value is of default integer kind.
6502 If @var{DIM} is absent, the result is an array of the lower bounds of
6503 @var{ARRAY}. If @var{DIM} is present, the result is a scalar
6504 corresponding to the lower bound of the array along that dimension. If
6505 @var{ARRAY} is an expression rather than a whole array or array
6506 structure component, or if it has a zero extent along the relevant
6507 dimension, the lower bound is taken to be 1.
6509 @item @emph{See also}:
6516 @section @code{LEADZ} --- Number of leading zero bits of an integer
6521 @item @emph{Description}:
6522 @code{LEADZ} returns the number of leading zero bits of an integer.
6524 @item @emph{Standard}:
6525 Fortran 2008 and later
6530 @item @emph{Syntax}:
6531 @code{RESULT = LEADZ(I)}
6533 @item @emph{Arguments}:
6534 @multitable @columnfractions .15 .70
6535 @item @var{I} @tab Shall be of type @code{INTEGER}.
6538 @item @emph{Return value}:
6539 The type of the return value is the default @code{INTEGER}.
6540 If all the bits of @code{I} are zero, the result value is @code{BIT_SIZE(I)}.
6542 @item @emph{Example}:
6545 WRITE (*,*) LEADZ(1) ! prints 8 if BITSIZE(I) has the value 32
6549 @item @emph{See also}:
6550 @ref{BIT_SIZE}, @ref{TRAILZ}
6556 @section @code{LEN} --- Length of a character entity
6558 @cindex string, length
6561 @item @emph{Description}:
6562 Returns the length of a character string. If @var{STRING} is an array,
6563 the length of an element of @var{STRING} is returned. Note that
6564 @var{STRING} need not be defined when this intrinsic is invoked, since
6565 only the length, not the content, of @var{STRING} is needed.
6567 @item @emph{Standard}:
6568 Fortran 77 and later, with @var{KIND} argument Fortran 2003 and later
6573 @item @emph{Syntax}:
6574 @code{L = LEN(STRING [, KIND])}
6576 @item @emph{Arguments}:
6577 @multitable @columnfractions .15 .70
6578 @item @var{STRING} @tab Shall be a scalar or array of type
6579 @code{CHARACTER}, with @code{INTENT(IN)}
6580 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
6581 expression indicating the kind parameter of the result.
6584 @item @emph{Return value}:
6585 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
6586 @var{KIND} is absent, the return value is of default integer kind.
6588 @item @emph{See also}:
6589 @ref{LEN_TRIM}, @ref{ADJUSTL}, @ref{ADJUSTR}
6595 @section @code{LEN_TRIM} --- Length of a character entity without trailing blank characters
6597 @cindex string, length, without trailing whitespace
6600 @item @emph{Description}:
6601 Returns the length of a character string, ignoring any trailing blanks.
6603 @item @emph{Standard}:
6604 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
6609 @item @emph{Syntax}:
6610 @code{RESULT = LEN_TRIM(STRING [, KIND])}
6612 @item @emph{Arguments}:
6613 @multitable @columnfractions .15 .70
6614 @item @var{STRING} @tab Shall be a scalar of type @code{CHARACTER},
6615 with @code{INTENT(IN)}
6616 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
6617 expression indicating the kind parameter of the result.
6620 @item @emph{Return value}:
6621 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
6622 @var{KIND} is absent, the return value is of default integer kind.
6624 @item @emph{See also}:
6625 @ref{LEN}, @ref{ADJUSTL}, @ref{ADJUSTR}
6631 @section @code{LGE} --- Lexical greater than or equal
6633 @cindex lexical comparison of strings
6634 @cindex string, comparison
6637 @item @emph{Description}:
6638 Determines whether one string is lexically greater than or equal to
6639 another string, where the two strings are interpreted as containing
6640 ASCII character codes. If the String A and String B are not the same
6641 length, the shorter is compared as if spaces were appended to it to form
6642 a value that has the same length as the longer.
6644 In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
6645 @code{LLE}, and @code{LLT} differ from the corresponding intrinsic
6646 operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
6647 that the latter use the processor's character ordering (which is not
6648 ASCII on some targets), whereas the former always use the ASCII
6651 @item @emph{Standard}:
6652 Fortran 77 and later
6657 @item @emph{Syntax}:
6658 @code{RESULT = LGE(STRING_A, STRING_B)}
6660 @item @emph{Arguments}:
6661 @multitable @columnfractions .15 .70
6662 @item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
6663 @item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
6666 @item @emph{Return value}:
6667 Returns @code{.TRUE.} if @code{STRING_A >= STRING_B}, and @code{.FALSE.}
6668 otherwise, based on the ASCII ordering.
6670 @item @emph{See also}:
6671 @ref{LGT}, @ref{LLE}, @ref{LLT}
6677 @section @code{LGT} --- Lexical greater than
6679 @cindex lexical comparison of strings
6680 @cindex string, comparison
6683 @item @emph{Description}:
6684 Determines whether one string is lexically greater than another string,
6685 where the two strings are interpreted as containing ASCII character
6686 codes. If the String A and String B are not the same length, the
6687 shorter is compared as if spaces were appended to it to form a value
6688 that has the same length as the longer.
6690 In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
6691 @code{LLE}, and @code{LLT} differ from the corresponding intrinsic
6692 operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
6693 that the latter use the processor's character ordering (which is not
6694 ASCII on some targets), whereas the former always use the ASCII
6697 @item @emph{Standard}:
6698 Fortran 77 and later
6703 @item @emph{Syntax}:
6704 @code{RESULT = LGT(STRING_A, STRING_B)}
6706 @item @emph{Arguments}:
6707 @multitable @columnfractions .15 .70
6708 @item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
6709 @item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
6712 @item @emph{Return value}:
6713 Returns @code{.TRUE.} if @code{STRING_A > STRING_B}, and @code{.FALSE.}
6714 otherwise, based on the ASCII ordering.
6716 @item @emph{See also}:
6717 @ref{LGE}, @ref{LLE}, @ref{LLT}
6723 @section @code{LINK} --- Create a hard link
6725 @cindex file system, create link
6726 @cindex file system, hard link
6729 @item @emph{Description}:
6730 Makes a (hard) link from file @var{PATH1} to @var{PATH2}. A null
6731 character (@code{CHAR(0)}) can be used to mark the end of the names in
6732 @var{PATH1} and @var{PATH2}; otherwise, trailing blanks in the file
6733 names are ignored. If the @var{STATUS} argument is supplied, it
6734 contains 0 on success or a nonzero error code upon return; see
6737 This intrinsic is provided in both subroutine and function forms;
6738 however, only one form can be used in any given program unit.
6740 @item @emph{Standard}:
6744 Subroutine, function
6746 @item @emph{Syntax}:
6747 @multitable @columnfractions .80
6748 @item @code{CALL LINK(PATH1, PATH2 [, STATUS])}
6749 @item @code{STATUS = LINK(PATH1, PATH2)}
6752 @item @emph{Arguments}:
6753 @multitable @columnfractions .15 .70
6754 @item @var{PATH1} @tab Shall be of default @code{CHARACTER} type.
6755 @item @var{PATH2} @tab Shall be of default @code{CHARACTER} type.
6756 @item @var{STATUS} @tab (Optional) Shall be of default @code{INTEGER} type.
6759 @item @emph{See also}:
6760 @ref{SYMLNK}, @ref{UNLINK}
6766 @section @code{LLE} --- Lexical less than or equal
6768 @cindex lexical comparison of strings
6769 @cindex string, comparison
6772 @item @emph{Description}:
6773 Determines whether one string is lexically less than or equal to another
6774 string, where the two strings are interpreted as containing ASCII
6775 character codes. If the String A and String B are not the same length,
6776 the shorter is compared as if spaces were appended to it to form a value
6777 that has the same length as the longer.
6779 In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
6780 @code{LLE}, and @code{LLT} differ from the corresponding intrinsic
6781 operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
6782 that the latter use the processor's character ordering (which is not
6783 ASCII on some targets), whereas the former always use the ASCII
6786 @item @emph{Standard}:
6787 Fortran 77 and later
6792 @item @emph{Syntax}:
6793 @code{RESULT = LLE(STRING_A, STRING_B)}
6795 @item @emph{Arguments}:
6796 @multitable @columnfractions .15 .70
6797 @item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
6798 @item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
6801 @item @emph{Return value}:
6802 Returns @code{.TRUE.} if @code{STRING_A <= STRING_B}, and @code{.FALSE.}
6803 otherwise, based on the ASCII ordering.
6805 @item @emph{See also}:
6806 @ref{LGE}, @ref{LGT}, @ref{LLT}
6812 @section @code{LLT} --- Lexical less than
6814 @cindex lexical comparison of strings
6815 @cindex string, comparison
6818 @item @emph{Description}:
6819 Determines whether one string is lexically less than another string,
6820 where the two strings are interpreted as containing ASCII character
6821 codes. If the String A and String B are not the same length, the
6822 shorter is compared as if spaces were appended to it to form a value
6823 that has the same length as the longer.
6825 In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
6826 @code{LLE}, and @code{LLT} differ from the corresponding intrinsic
6827 operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
6828 that the latter use the processor's character ordering (which is not
6829 ASCII on some targets), whereas the former always use the ASCII
6832 @item @emph{Standard}:
6833 Fortran 77 and later
6838 @item @emph{Syntax}:
6839 @code{RESULT = LLT(STRING_A, STRING_B)}
6841 @item @emph{Arguments}:
6842 @multitable @columnfractions .15 .70
6843 @item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
6844 @item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
6847 @item @emph{Return value}:
6848 Returns @code{.TRUE.} if @code{STRING_A < STRING_B}, and @code{.FALSE.}
6849 otherwise, based on the ASCII ordering.
6851 @item @emph{See also}:
6852 @ref{LGE}, @ref{LGT}, @ref{LLE}
6858 @section @code{LNBLNK} --- Index of the last non-blank character in a string
6860 @cindex string, find non-blank character
6863 @item @emph{Description}:
6864 Returns the length of a character string, ignoring any trailing blanks.
6865 This is identical to the standard @code{LEN_TRIM} intrinsic, and is only
6866 included for backwards compatibility.
6868 @item @emph{Standard}:
6874 @item @emph{Syntax}:
6875 @code{RESULT = LNBLNK(STRING)}
6877 @item @emph{Arguments}:
6878 @multitable @columnfractions .15 .70
6879 @item @var{STRING} @tab Shall be a scalar of type @code{CHARACTER},
6880 with @code{INTENT(IN)}
6883 @item @emph{Return value}:
6884 The return value is of @code{INTEGER(kind=4)} type.
6886 @item @emph{See also}:
6887 @ref{INDEX intrinsic}, @ref{LEN_TRIM}
6893 @section @code{LOC} --- Returns the address of a variable
6895 @cindex location of a variable in memory
6898 @item @emph{Description}:
6899 @code{LOC(X)} returns the address of @var{X} as an integer.
6901 @item @emph{Standard}:
6907 @item @emph{Syntax}:
6908 @code{RESULT = LOC(X)}
6910 @item @emph{Arguments}:
6911 @multitable @columnfractions .15 .70
6912 @item @var{X} @tab Variable of any type.
6915 @item @emph{Return value}:
6916 The return value is of type @code{INTEGER}, with a @code{KIND}
6917 corresponding to the size (in bytes) of a memory address on the target
6920 @item @emph{Example}:
6927 end program test_loc
6934 @section @code{LOG} --- Logarithm function
6941 @cindex exponential function, inverse
6942 @cindex logarithmic function
6945 @item @emph{Description}:
6946 @code{LOG(X)} computes the logarithm of @var{X}.
6948 @item @emph{Standard}:
6949 Fortran 77 and later
6954 @item @emph{Syntax}:
6955 @code{RESULT = LOG(X)}
6957 @item @emph{Arguments}:
6958 @multitable @columnfractions .15 .70
6959 @item @var{X} @tab The type shall be @code{REAL} or
6963 @item @emph{Return value}:
6964 The return value is of type @code{REAL} or @code{COMPLEX}.
6965 The kind type parameter is the same as @var{X}.
6966 If @var{X} is @code{COMPLEX}, the imaginary part @math{\omega} is in the range
6967 @math{-\pi \leq \omega \leq \pi}.
6969 @item @emph{Example}:
6972 real(8) :: x = 1.0_8
6973 complex :: z = (1.0, 2.0)
6976 end program test_log
6979 @item @emph{Specific names}:
6980 @multitable @columnfractions .20 .20 .20 .25
6981 @item Name @tab Argument @tab Return type @tab Standard
6982 @item @code{ALOG(X)} @tab @code{REAL(4) X} @tab @code{REAL(4)} @tab f95, gnu
6983 @item @code{DLOG(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab f95, gnu
6984 @item @code{CLOG(X)} @tab @code{COMPLEX(4) X} @tab @code{COMPLEX(4)} @tab f95, gnu
6985 @item @code{ZLOG(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab f95, gnu
6986 @item @code{CDLOG(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab f95, gnu
6993 @section @code{LOG10} --- Base 10 logarithm function
6997 @cindex exponential function, inverse
6998 @cindex logarithmic function
7001 @item @emph{Description}:
7002 @code{LOG10(X)} computes the base 10 logarithm of @var{X}.
7004 @item @emph{Standard}:
7005 Fortran 77 and later
7010 @item @emph{Syntax}:
7011 @code{RESULT = LOG10(X)}
7013 @item @emph{Arguments}:
7014 @multitable @columnfractions .15 .70
7015 @item @var{X} @tab The type shall be @code{REAL}.
7018 @item @emph{Return value}:
7019 The return value is of type @code{REAL} or @code{COMPLEX}.
7020 The kind type parameter is the same as @var{X}.
7022 @item @emph{Example}:
7025 real(8) :: x = 10.0_8
7027 end program test_log10
7030 @item @emph{Specific names}:
7031 @multitable @columnfractions .20 .20 .20 .25
7032 @item Name @tab Argument @tab Return type @tab Standard
7033 @item @code{ALOG10(X)} @tab @code{REAL(4) X} @tab @code{REAL(4)} @tab Fortran 95 and later
7034 @item @code{DLOG10(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 95 and later
7041 @section @code{LOG_GAMMA} --- Logarithm of the Gamma function
7046 @cindex Gamma function, logarithm of
7049 @item @emph{Description}:
7050 @code{LOG_GAMMA(X)} computes the natural logarithm of the absolute value
7051 of the Gamma (@math{\Gamma}) function.
7053 @item @emph{Standard}:
7054 Fortran 2008 and later
7059 @item @emph{Syntax}:
7060 @code{X = LOG_GAMMA(X)}
7062 @item @emph{Arguments}:
7063 @multitable @columnfractions .15 .70
7064 @item @var{X} @tab Shall be of type @code{REAL} and neither zero
7065 nor a negative integer.
7068 @item @emph{Return value}:
7069 The return value is of type @code{REAL} of the same kind as @var{X}.
7071 @item @emph{Example}:
7073 program test_log_gamma
7075 x = lgamma(x) ! returns 0.0
7076 end program test_log_gamma
7079 @item @emph{Specific names}:
7080 @multitable @columnfractions .20 .20 .20 .25
7081 @item Name @tab Argument @tab Return type @tab Standard
7082 @item @code{LGAMMA(X)} @tab @code{REAL(4) X} @tab @code{REAL(4)} @tab GNU Extension
7083 @item @code{ALGAMA(X)} @tab @code{REAL(4) X} @tab @code{REAL(4)} @tab GNU Extension
7084 @item @code{DLGAMA(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab GNU Extension
7087 @item @emph{See also}:
7088 Gamma function: @ref{GAMMA}
7095 @section @code{LOGICAL} --- Convert to logical type
7097 @cindex conversion, to logical
7100 @item @emph{Description}:
7101 Converts one kind of @code{LOGICAL} variable to another.
7103 @item @emph{Standard}:
7104 Fortran 95 and later
7109 @item @emph{Syntax}:
7110 @code{RESULT = LOGICAL(L [, KIND])}
7112 @item @emph{Arguments}:
7113 @multitable @columnfractions .15 .70
7114 @item @var{L} @tab The type shall be @code{LOGICAL}.
7115 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
7116 expression indicating the kind parameter of the result.
7119 @item @emph{Return value}:
7120 The return value is a @code{LOGICAL} value equal to @var{L}, with a
7121 kind corresponding to @var{KIND}, or of the default logical kind if
7122 @var{KIND} is not given.
7124 @item @emph{See also}:
7125 @ref{INT}, @ref{REAL}, @ref{CMPLX}
7131 @section @code{LONG} --- Convert to integer type
7133 @cindex conversion, to integer
7136 @item @emph{Description}:
7137 Convert to a @code{KIND=4} integer type, which is the same size as a C
7138 @code{long} integer. This is equivalent to the standard @code{INT}
7139 intrinsic with an optional argument of @code{KIND=4}, and is only
7140 included for backwards compatibility.
7142 @item @emph{Standard}:
7148 @item @emph{Syntax}:
7149 @code{RESULT = LONG(A)}
7151 @item @emph{Arguments}:
7152 @multitable @columnfractions .15 .70
7153 @item @var{A} @tab Shall be of type @code{INTEGER},
7154 @code{REAL}, or @code{COMPLEX}.
7157 @item @emph{Return value}:
7158 The return value is a @code{INTEGER(4)} variable.
7160 @item @emph{See also}:
7161 @ref{INT}, @ref{INT2}, @ref{INT8}
7167 @section @code{LSHIFT} --- Left shift bits
7169 @cindex bits, shift left
7172 @item @emph{Description}:
7173 @code{LSHIFT} returns a value corresponding to @var{I} with all of the
7174 bits shifted left by @var{SHIFT} places. If the absolute value of
7175 @var{SHIFT} is greater than @code{BIT_SIZE(I)}, the value is undefined.
7176 Bits shifted out from the left end are lost; zeros are shifted in from
7179 This function has been superseded by the @code{ISHFT} intrinsic, which
7180 is standard in Fortran 95 and later.
7182 @item @emph{Standard}:
7188 @item @emph{Syntax}:
7189 @code{RESULT = LSHIFT(I, SHIFT)}
7191 @item @emph{Arguments}:
7192 @multitable @columnfractions .15 .70
7193 @item @var{I} @tab The type shall be @code{INTEGER}.
7194 @item @var{SHIFT} @tab The type shall be @code{INTEGER}.
7197 @item @emph{Return value}:
7198 The return value is of type @code{INTEGER} and of the same kind as
7201 @item @emph{See also}:
7202 @ref{ISHFT}, @ref{ISHFTC}, @ref{RSHIFT}
7209 @section @code{LSTAT} --- Get file status
7211 @cindex file system, file status
7214 @item @emph{Description}:
7215 @code{LSTAT} is identical to @ref{STAT}, except that if path is a symbolic link,
7216 then the link itself is statted, not the file that it refers to.
7218 The elements in @code{BUFF} are the same as described by @ref{STAT}.
7220 This intrinsic is provided in both subroutine and function forms; however,
7221 only one form can be used in any given program unit.
7223 @item @emph{Standard}:
7227 Subroutine, function
7229 @item @emph{Syntax}:
7230 @code{CALL LSTAT(FILE, BUFF [, STATUS])}
7232 @item @emph{Arguments}:
7233 @multitable @columnfractions .15 .70
7234 @item @var{FILE} @tab The type shall be @code{CHARACTER} of the default
7235 kind, a valid path within the file system.
7236 @item @var{BUFF} @tab The type shall be @code{INTEGER(4), DIMENSION(13)}.
7237 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER(4)}.
7238 Returns 0 on success and a system specific error code otherwise.
7241 @item @emph{Example}:
7242 See @ref{STAT} for an example.
7244 @item @emph{See also}:
7245 To stat an open file: @ref{FSTAT}, to stat a file: @ref{STAT}
7251 @section @code{LTIME} --- Convert time to local time info
7253 @cindex time, conversion to local time info
7256 @item @emph{Description}:
7257 Given a system time value @var{STIME} (as provided by the @code{TIME8()}
7258 intrinsic), fills @var{TARRAY} with values extracted from it appropriate
7259 to the local time zone using @code{localtime(3)}.
7261 @item @emph{Standard}:
7267 @item @emph{Syntax}:
7268 @code{CALL LTIME(STIME, TARRAY)}
7270 @item @emph{Arguments}:
7271 @multitable @columnfractions .15 .70
7272 @item @var{STIME} @tab An @code{INTEGER} scalar expression
7273 corresponding to a system time, with @code{INTENT(IN)}.
7274 @item @var{TARRAY} @tab A default @code{INTEGER} array with 9 elements,
7275 with @code{INTENT(OUT)}.
7278 @item @emph{Return value}:
7279 The elements of @var{TARRAY} are assigned as follows:
7281 @item Seconds after the minute, range 0--59 or 0--61 to allow for leap
7283 @item Minutes after the hour, range 0--59
7284 @item Hours past midnight, range 0--23
7285 @item Day of month, range 0--31
7286 @item Number of months since January, range 0--12
7287 @item Years since 1900
7288 @item Number of days since Sunday, range 0--6
7289 @item Days since January 1
7290 @item Daylight savings indicator: positive if daylight savings is in
7291 effect, zero if not, and negative if the information is not available.
7294 @item @emph{See also}:
7295 @ref{CTIME}, @ref{GMTIME}, @ref{TIME}, @ref{TIME8}
7302 @section @code{MALLOC} --- Allocate dynamic memory
7304 @cindex pointer, cray
7307 @item @emph{Description}:
7308 @code{MALLOC(SIZE)} allocates @var{SIZE} bytes of dynamic memory and
7309 returns the address of the allocated memory. The @code{MALLOC} intrinsic
7310 is an extension intended to be used with Cray pointers, and is provided
7311 in GNU Fortran to allow the user to compile legacy code. For new code
7312 using Fortran 95 pointers, the memory allocation intrinsic is
7315 @item @emph{Standard}:
7321 @item @emph{Syntax}:
7322 @code{PTR = MALLOC(SIZE)}
7324 @item @emph{Arguments}:
7325 @multitable @columnfractions .15 .70
7326 @item @var{SIZE} @tab The type shall be @code{INTEGER}.
7329 @item @emph{Return value}:
7330 The return value is of type @code{INTEGER(K)}, with @var{K} such that
7331 variables of type @code{INTEGER(K)} have the same size as
7332 C pointers (@code{sizeof(void *)}).
7334 @item @emph{Example}:
7335 The following example demonstrates the use of @code{MALLOC} and
7336 @code{FREE} with Cray pointers.
7345 ptr_x = malloc(20*8)
7347 x(i) = sqrt(1.0d0 / i)
7355 end program test_malloc
7358 @item @emph{See also}:
7365 @section @code{MATMUL} --- matrix multiplication
7367 @cindex matrix multiplication
7368 @cindex product, matrix
7371 @item @emph{Description}:
7372 Performs a matrix multiplication on numeric or logical arguments.
7374 @item @emph{Standard}:
7375 Fortran 95 and later
7378 Transformational function
7380 @item @emph{Syntax}:
7381 @code{RESULT = MATMUL(MATRIX_A, MATRIX_B)}
7383 @item @emph{Arguments}:
7384 @multitable @columnfractions .15 .70
7385 @item @var{MATRIX_A} @tab An array of @code{INTEGER},
7386 @code{REAL}, @code{COMPLEX}, or @code{LOGICAL} type, with a rank of
7388 @item @var{MATRIX_B} @tab An array of @code{INTEGER},
7389 @code{REAL}, or @code{COMPLEX} type if @var{MATRIX_A} is of a numeric
7390 type; otherwise, an array of @code{LOGICAL} type. The rank shall be one
7391 or two, and the first (or only) dimension of @var{MATRIX_B} shall be
7392 equal to the last (or only) dimension of @var{MATRIX_A}.
7395 @item @emph{Return value}:
7396 The matrix product of @var{MATRIX_A} and @var{MATRIX_B}. The type and
7397 kind of the result follow the usual type and kind promotion rules, as
7398 for the @code{*} or @code{.AND.} operators.
7400 @item @emph{See also}:
7406 @section @code{MAX} --- Maximum value of an argument list
7413 @cindex maximum value
7416 @item @emph{Description}:
7417 Returns the argument with the largest (most positive) value.
7419 @item @emph{Standard}:
7420 Fortran 77 and later
7425 @item @emph{Syntax}:
7426 @code{RESULT = MAX(A1, A2 [, A3 [, ...]])}
7428 @item @emph{Arguments}:
7429 @multitable @columnfractions .15 .70
7430 @item @var{A1} @tab The type shall be @code{INTEGER} or
7432 @item @var{A2}, @var{A3}, ... @tab An expression of the same type and kind
7433 as @var{A1}. (As a GNU extension, arguments of different kinds are
7437 @item @emph{Return value}:
7438 The return value corresponds to the maximum value among the arguments,
7439 and has the same type and kind as the first argument.
7441 @item @emph{Specific names}:
7442 @multitable @columnfractions .20 .20 .20 .25
7443 @item Name @tab Argument @tab Return type @tab Standard
7444 @item @code{MAX0(I)} @tab @code{INTEGER(4) I} @tab @code{INTEGER(4)} @tab Fortran 77 and later
7445 @item @code{AMAX0(I)} @tab @code{INTEGER(4) I} @tab @code{REAL(MAX(X))} @tab Fortran 77 and later
7446 @item @code{MAX1(X)} @tab @code{REAL X} @tab @code{INT(MAX(X))} @tab Fortran 77 and later
7447 @item @code{AMAX1(X)} @tab @code{REAL(4) X} @tab @code{REAL(4)} @tab Fortran 77 and later
7448 @item @code{DMAX1(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
7451 @item @emph{See also}:
7452 @ref{MAXLOC} @ref{MAXVAL}, @ref{MIN}
7459 @section @code{MAXEXPONENT} --- Maximum exponent of a real kind
7460 @fnindex MAXEXPONENT
7461 @cindex model representation, maximum exponent
7464 @item @emph{Description}:
7465 @code{MAXEXPONENT(X)} returns the maximum exponent in the model of the
7468 @item @emph{Standard}:
7469 Fortran 95 and later
7474 @item @emph{Syntax}:
7475 @code{RESULT = MAXEXPONENT(X)}
7477 @item @emph{Arguments}:
7478 @multitable @columnfractions .15 .70
7479 @item @var{X} @tab Shall be of type @code{REAL}.
7482 @item @emph{Return value}:
7483 The return value is of type @code{INTEGER} and of the default integer
7486 @item @emph{Example}:
7492 print *, minexponent(x), maxexponent(x)
7493 print *, minexponent(y), maxexponent(y)
7494 end program exponents
7501 @section @code{MAXLOC} --- Location of the maximum value within an array
7503 @cindex array, location of maximum element
7506 @item @emph{Description}:
7507 Determines the location of the element in the array with the maximum
7508 value, or, if the @var{DIM} argument is supplied, determines the
7509 locations of the maximum element along each row of the array in the
7510 @var{DIM} direction. If @var{MASK} is present, only the elements for
7511 which @var{MASK} is @code{.TRUE.} are considered. If more than one
7512 element in the array has the maximum value, the location returned is
7513 that of the first such element in array element order. If the array has
7514 zero size, or all of the elements of @var{MASK} are @code{.FALSE.}, then
7515 the result is an array of zeroes. Similarly, if @var{DIM} is supplied
7516 and all of the elements of @var{MASK} along a given row are zero, the
7517 result value for that row is zero.
7519 @item @emph{Standard}:
7520 Fortran 95 and later
7523 Transformational function
7525 @item @emph{Syntax}:
7526 @multitable @columnfractions .80
7527 @item @code{RESULT = MAXLOC(ARRAY, DIM [, MASK])}
7528 @item @code{RESULT = MAXLOC(ARRAY [, MASK])}
7531 @item @emph{Arguments}:
7532 @multitable @columnfractions .15 .70
7533 @item @var{ARRAY} @tab Shall be an array of type @code{INTEGER},
7534 @code{REAL}, or @code{CHARACTER}.
7535 @item @var{DIM} @tab (Optional) Shall be a scalar of type
7536 @code{INTEGER}, with a value between one and the rank of @var{ARRAY},
7537 inclusive. It may not be an optional dummy argument.
7538 @item @var{MASK} @tab Shall be an array of type @code{LOGICAL},
7539 and conformable with @var{ARRAY}.
7542 @item @emph{Return value}:
7543 If @var{DIM} is absent, the result is a rank-one array with a length
7544 equal to the rank of @var{ARRAY}. If @var{DIM} is present, the result
7545 is an array with a rank one less than the rank of @var{ARRAY}, and a
7546 size corresponding to the size of @var{ARRAY} with the @var{DIM}
7547 dimension removed. If @var{DIM} is present and @var{ARRAY} has a rank
7548 of one, the result is a scalar. In all cases, the result is of default
7549 @code{INTEGER} type.
7551 @item @emph{See also}:
7552 @ref{MAX}, @ref{MAXVAL}
7559 @section @code{MAXVAL} --- Maximum value of an array
7561 @cindex array, maximum value
7562 @cindex maximum value
7565 @item @emph{Description}:
7566 Determines the maximum value of the elements in an array value, or, if
7567 the @var{DIM} argument is supplied, determines the maximum value along
7568 each row of the array in the @var{DIM} direction. If @var{MASK} is
7569 present, only the elements for which @var{MASK} is @code{.TRUE.} are
7570 considered. If the array has zero size, or all of the elements of
7571 @var{MASK} are @code{.FALSE.}, then the result is @code{-HUGE(ARRAY)}
7572 if @var{ARRAY} is numeric, or a string of nulls if @var{ARRAY} is of character
7575 @item @emph{Standard}:
7576 Fortran 95 and later
7579 Transformational function
7581 @item @emph{Syntax}:
7582 @multitable @columnfractions .80
7583 @item @code{RESULT = MAXVAL(ARRAY, DIM [, MASK])}
7584 @item @code{RESULT = MAXVAL(ARRAY [, MASK])}
7587 @item @emph{Arguments}:
7588 @multitable @columnfractions .15 .70
7589 @item @var{ARRAY} @tab Shall be an array of type @code{INTEGER},
7590 @code{REAL}, or @code{CHARACTER}.
7591 @item @var{DIM} @tab (Optional) Shall be a scalar of type
7592 @code{INTEGER}, with a value between one and the rank of @var{ARRAY},
7593 inclusive. It may not be an optional dummy argument.
7594 @item @var{MASK} @tab Shall be an array of type @code{LOGICAL},
7595 and conformable with @var{ARRAY}.
7598 @item @emph{Return value}:
7599 If @var{DIM} is absent, or if @var{ARRAY} has a rank of one, the result
7600 is a scalar. If @var{DIM} is present, the result is an array with a
7601 rank one less than the rank of @var{ARRAY}, and a size corresponding to
7602 the size of @var{ARRAY} with the @var{DIM} dimension removed. In all
7603 cases, the result is of the same type and kind as @var{ARRAY}.
7605 @item @emph{See also}:
7606 @ref{MAX}, @ref{MAXLOC}
7612 @section @code{MCLOCK} --- Time function
7614 @cindex time, clock ticks
7618 @item @emph{Description}:
7619 Returns the number of clock ticks since the start of the process, based
7620 on the UNIX function @code{clock(3)}.
7622 This intrinsic is not fully portable, such as to systems with 32-bit
7623 @code{INTEGER} types but supporting times wider than 32 bits. Therefore,
7624 the values returned by this intrinsic might be, or become, negative, or
7625 numerically less than previous values, during a single run of the
7628 @item @emph{Standard}:
7634 @item @emph{Syntax}:
7635 @code{RESULT = MCLOCK()}
7637 @item @emph{Return value}:
7638 The return value is a scalar of type @code{INTEGER(4)}, equal to the
7639 number of clock ticks since the start of the process, or @code{-1} if
7640 the system does not support @code{clock(3)}.
7642 @item @emph{See also}:
7643 @ref{CTIME}, @ref{GMTIME}, @ref{LTIME}, @ref{MCLOCK}, @ref{TIME}
7650 @section @code{MCLOCK8} --- Time function (64-bit)
7652 @cindex time, clock ticks
7656 @item @emph{Description}:
7657 Returns the number of clock ticks since the start of the process, based
7658 on the UNIX function @code{clock(3)}.
7660 @emph{Warning:} this intrinsic does not increase the range of the timing
7661 values over that returned by @code{clock(3)}. On a system with a 32-bit
7662 @code{clock(3)}, @code{MCLOCK8()} will return a 32-bit value, even though
7663 it is converted to a 64-bit @code{INTEGER(8)} value. That means
7664 overflows of the 32-bit value can still occur. Therefore, the values
7665 returned by this intrinsic might be or become negative or numerically
7666 less than previous values during a single run of the compiled program.
7668 @item @emph{Standard}:
7674 @item @emph{Syntax}:
7675 @code{RESULT = MCLOCK8()}
7677 @item @emph{Return value}:
7678 The return value is a scalar of type @code{INTEGER(8)}, equal to the
7679 number of clock ticks since the start of the process, or @code{-1} if
7680 the system does not support @code{clock(3)}.
7682 @item @emph{See also}:
7683 @ref{CTIME}, @ref{GMTIME}, @ref{LTIME}, @ref{MCLOCK}, @ref{TIME8}
7690 @section @code{MERGE} --- Merge variables
7692 @cindex array, merge arrays
7693 @cindex array, combine arrays
7696 @item @emph{Description}:
7697 Select values from two arrays according to a logical mask. The result
7698 is equal to @var{TSOURCE} if @var{MASK} is @code{.TRUE.}, or equal to
7699 @var{FSOURCE} if it is @code{.FALSE.}.
7701 @item @emph{Standard}:
7702 Fortran 95 and later
7707 @item @emph{Syntax}:
7708 @code{RESULT = MERGE(TSOURCE, FSOURCE, MASK)}
7710 @item @emph{Arguments}:
7711 @multitable @columnfractions .15 .70
7712 @item @var{TSOURCE} @tab May be of any type.
7713 @item @var{FSOURCE} @tab Shall be of the same type and type parameters
7715 @item @var{MASK} @tab Shall be of type @code{LOGICAL}.
7718 @item @emph{Return value}:
7719 The result is of the same type and type parameters as @var{TSOURCE}.
7726 @section @code{MIN} --- Minimum value of an argument list
7733 @cindex minimum value
7736 @item @emph{Description}:
7737 Returns the argument with the smallest (most negative) value.
7739 @item @emph{Standard}:
7740 Fortran 77 and later
7745 @item @emph{Syntax}:
7746 @code{RESULT = MIN(A1, A2 [, A3, ...])}
7748 @item @emph{Arguments}:
7749 @multitable @columnfractions .15 .70
7750 @item @var{A1} @tab The type shall be @code{INTEGER} or
7752 @item @var{A2}, @var{A3}, ... @tab An expression of the same type and kind
7753 as @var{A1}. (As a GNU extension, arguments of different kinds are
7757 @item @emph{Return value}:
7758 The return value corresponds to the maximum value among the arguments,
7759 and has the same type and kind as the first argument.
7761 @item @emph{Specific names}:
7762 @multitable @columnfractions .20 .20 .20 .25
7763 @item Name @tab Argument @tab Return type @tab Standard
7764 @item @code{MIN0(I)} @tab @code{INTEGER(4) I} @tab @code{INTEGER(4)} @tab Fortran 77 and later
7765 @item @code{AMIN0(I)} @tab @code{INTEGER(4) I} @tab @code{REAL(MIN(X))} @tab Fortran 77 and later
7766 @item @code{MIN1(X)} @tab @code{REAL X} @tab @code{INT(MIN(X))} @tab Fortran 77 and later
7767 @item @code{AMIN1(X)} @tab @code{REAL(4) X} @tab @code{REAL(4)} @tab Fortran 77 and later
7768 @item @code{DMIN1(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 77 and later
7771 @item @emph{See also}:
7772 @ref{MAX}, @ref{MINLOC}, @ref{MINVAL}
7778 @section @code{MINEXPONENT} --- Minimum exponent of a real kind
7779 @fnindex MINEXPONENT
7780 @cindex model representation, minimum exponent
7783 @item @emph{Description}:
7784 @code{MINEXPONENT(X)} returns the minimum exponent in the model of the
7787 @item @emph{Standard}:
7788 Fortran 95 and later
7793 @item @emph{Syntax}:
7794 @code{RESULT = MINEXPONENT(X)}
7796 @item @emph{Arguments}:
7797 @multitable @columnfractions .15 .70
7798 @item @var{X} @tab Shall be of type @code{REAL}.
7801 @item @emph{Return value}:
7802 The return value is of type @code{INTEGER} and of the default integer
7805 @item @emph{Example}:
7806 See @code{MAXEXPONENT} for an example.
7812 @section @code{MINLOC} --- Location of the minimum value within an array
7814 @cindex array, location of minimum element
7817 @item @emph{Description}:
7818 Determines the location of the element in the array with the minimum
7819 value, or, if the @var{DIM} argument is supplied, determines the
7820 locations of the minimum element along each row of the array in the
7821 @var{DIM} direction. If @var{MASK} is present, only the elements for
7822 which @var{MASK} is @code{.TRUE.} are considered. If more than one
7823 element in the array has the minimum value, the location returned is
7824 that of the first such element in array element order. If the array has
7825 zero size, or all of the elements of @var{MASK} are @code{.FALSE.}, then
7826 the result is an array of zeroes. Similarly, if @var{DIM} is supplied
7827 and all of the elements of @var{MASK} along a given row are zero, the
7828 result value for that row is zero.
7830 @item @emph{Standard}:
7831 Fortran 95 and later
7834 Transformational function
7836 @item @emph{Syntax}:
7837 @multitable @columnfractions .80
7838 @item @code{RESULT = MINLOC(ARRAY, DIM [, MASK])}
7839 @item @code{RESULT = MINLOC(ARRAY [, MASK])}
7842 @item @emph{Arguments}:
7843 @multitable @columnfractions .15 .70
7844 @item @var{ARRAY} @tab Shall be an array of type @code{INTEGER},
7845 @code{REAL}, or @code{CHARACTER}.
7846 @item @var{DIM} @tab (Optional) Shall be a scalar of type
7847 @code{INTEGER}, with a value between one and the rank of @var{ARRAY},
7848 inclusive. It may not be an optional dummy argument.
7849 @item @var{MASK} @tab Shall be an array of type @code{LOGICAL},
7850 and conformable with @var{ARRAY}.
7853 @item @emph{Return value}:
7854 If @var{DIM} is absent, the result is a rank-one array with a length
7855 equal to the rank of @var{ARRAY}. If @var{DIM} is present, the result
7856 is an array with a rank one less than the rank of @var{ARRAY}, and a
7857 size corresponding to the size of @var{ARRAY} with the @var{DIM}
7858 dimension removed. If @var{DIM} is present and @var{ARRAY} has a rank
7859 of one, the result is a scalar. In all cases, the result is of default
7860 @code{INTEGER} type.
7862 @item @emph{See also}:
7863 @ref{MIN}, @ref{MINVAL}
7870 @section @code{MINVAL} --- Minimum value of an array
7872 @cindex array, minimum value
7873 @cindex minimum value
7876 @item @emph{Description}:
7877 Determines the minimum value of the elements in an array value, or, if
7878 the @var{DIM} argument is supplied, determines the minimum value along
7879 each row of the array in the @var{DIM} direction. If @var{MASK} is
7880 present, only the elements for which @var{MASK} is @code{.TRUE.} are
7881 considered. If the array has zero size, or all of the elements of
7882 @var{MASK} are @code{.FALSE.}, then the result is @code{HUGE(ARRAY)} if
7883 @var{ARRAY} is numeric, or a string of @code{CHAR(255)} characters if
7884 @var{ARRAY} is of character type.
7886 @item @emph{Standard}:
7887 Fortran 95 and later
7890 Transformational function
7892 @item @emph{Syntax}:
7893 @multitable @columnfractions .80
7894 @item @code{RESULT = MINVAL(ARRAY, DIM [, MASK])}
7895 @item @code{RESULT = MINVAL(ARRAY [, MASK])}
7898 @item @emph{Arguments}:
7899 @multitable @columnfractions .15 .70
7900 @item @var{ARRAY} @tab Shall be an array of type @code{INTEGER},
7901 @code{REAL}, or @code{CHARACTER}.
7902 @item @var{DIM} @tab (Optional) Shall be a scalar of type
7903 @code{INTEGER}, with a value between one and the rank of @var{ARRAY},
7904 inclusive. It may not be an optional dummy argument.
7905 @item @var{MASK} @tab Shall be an array of type @code{LOGICAL},
7906 and conformable with @var{ARRAY}.
7909 @item @emph{Return value}:
7910 If @var{DIM} is absent, or if @var{ARRAY} has a rank of one, the result
7911 is a scalar. If @var{DIM} is present, the result is an array with a
7912 rank one less than the rank of @var{ARRAY}, and a size corresponding to
7913 the size of @var{ARRAY} with the @var{DIM} dimension removed. In all
7914 cases, the result is of the same type and kind as @var{ARRAY}.
7916 @item @emph{See also}:
7917 @ref{MIN}, @ref{MINLOC}
7924 @section @code{MOD} --- Remainder function
7929 @cindex division, remainder
7932 @item @emph{Description}:
7933 @code{MOD(A,P)} computes the remainder of the division of A by P@. It is
7934 calculated as @code{A - (INT(A/P) * P)}.
7936 @item @emph{Standard}:
7937 Fortran 77 and later
7942 @item @emph{Syntax}:
7943 @code{RESULT = MOD(A, P)}
7945 @item @emph{Arguments}:
7946 @multitable @columnfractions .15 .70
7947 @item @var{A} @tab Shall be a scalar of type @code{INTEGER} or @code{REAL}
7948 @item @var{P} @tab Shall be a scalar of the same type as @var{A} and not
7952 @item @emph{Return value}:
7953 The kind of the return value is the result of cross-promoting
7954 the kinds of the arguments.
7956 @item @emph{Example}:
7960 print *, mod(17.5,5.5)
7961 print *, mod(17.5d0,5.5)
7962 print *, mod(17.5,5.5d0)
7965 print *, mod(-17.5,5.5)
7966 print *, mod(-17.5d0,5.5)
7967 print *, mod(-17.5,5.5d0)
7970 print *, mod(17.5,-5.5)
7971 print *, mod(17.5d0,-5.5)
7972 print *, mod(17.5,-5.5d0)
7973 end program test_mod
7976 @item @emph{Specific names}:
7977 @multitable @columnfractions .20 .20 .20 .25
7978 @item Name @tab Arguments @tab Return type @tab Standard
7979 @item @code{AMOD(A,P)} @tab @code{REAL(4)} @tab @code{REAL(4)} @tab Fortran 95 and later
7980 @item @code{DMOD(A,P)} @tab @code{REAL(8)} @tab @code{REAL(8)} @tab Fortran 95 and later
7987 @section @code{MODULO} --- Modulo function
7990 @cindex division, modulo
7993 @item @emph{Description}:
7994 @code{MODULO(A,P)} computes the @var{A} modulo @var{P}.
7996 @item @emph{Standard}:
7997 Fortran 95 and later
8002 @item @emph{Syntax}:
8003 @code{RESULT = MODULO(A, P)}
8005 @item @emph{Arguments}:
8006 @multitable @columnfractions .15 .70
8007 @item @var{A} @tab Shall be a scalar of type @code{INTEGER} or @code{REAL}
8008 @item @var{P} @tab Shall be a scalar of the same type and kind as @var{A}
8011 @item @emph{Return value}:
8012 The type and kind of the result are those of the arguments.
8014 @item If @var{A} and @var{P} are of type @code{INTEGER}:
8015 @code{MODULO(A,P)} has the value @var{R} such that @code{A=Q*P+R}, where
8016 @var{Q} is an integer and @var{R} is between 0 (inclusive) and @var{P}
8018 @item If @var{A} and @var{P} are of type @code{REAL}:
8019 @code{MODULO(A,P)} has the value of @code{A - FLOOR (A / P) * P}.
8021 In all cases, if @var{P} is zero the result is processor-dependent.
8023 @item @emph{Example}:
8026 print *, modulo(17,3)
8027 print *, modulo(17.5,5.5)
8029 print *, modulo(-17,3)
8030 print *, modulo(-17.5,5.5)
8032 print *, modulo(17,-3)
8033 print *, modulo(17.5,-5.5)
8042 @section @code{MOVE_ALLOC} --- Move allocation from one object to another
8044 @cindex moving allocation
8045 @cindex allocation, moving
8048 @item @emph{Description}:
8049 @code{MOVE_ALLOC(SRC, DEST)} moves the allocation from @var{SRC} to
8050 @var{DEST}. @var{SRC} will become deallocated in the process.
8052 @item @emph{Standard}:
8053 Fortran 2003 and later
8058 @item @emph{Syntax}:
8059 @code{CALL MOVE_ALLOC(SRC, DEST)}
8061 @item @emph{Arguments}:
8062 @multitable @columnfractions .15 .70
8063 @item @var{SRC} @tab @code{ALLOCATABLE}, @code{INTENT(INOUT)}, may be
8064 of any type and kind.
8065 @item @var{DEST} @tab @code{ALLOCATABLE}, @code{INTENT(OUT)}, shall be
8066 of the same type, kind and rank as @var{SRC}.
8069 @item @emph{Return value}:
8072 @item @emph{Example}:
8074 program test_move_alloc
8075 integer, allocatable :: a(:), b(:)
8079 call move_alloc(a, b)
8080 print *, allocated(a), allocated(b)
8082 end program test_move_alloc
8089 @section @code{MVBITS} --- Move bits from one integer to another
8094 @item @emph{Description}:
8095 Moves @var{LEN} bits from positions @var{FROMPOS} through
8096 @code{FROMPOS+LEN-1} of @var{FROM} to positions @var{TOPOS} through
8097 @code{TOPOS+LEN-1} of @var{TO}. The portion of argument @var{TO} not
8098 affected by the movement of bits is unchanged. The values of
8099 @code{FROMPOS+LEN-1} and @code{TOPOS+LEN-1} must be less than
8100 @code{BIT_SIZE(FROM)}.
8102 @item @emph{Standard}:
8103 Fortran 95 and later
8106 Elemental subroutine
8108 @item @emph{Syntax}:
8109 @code{CALL MVBITS(FROM, FROMPOS, LEN, TO, TOPOS)}
8111 @item @emph{Arguments}:
8112 @multitable @columnfractions .15 .70
8113 @item @var{FROM} @tab The type shall be @code{INTEGER}.
8114 @item @var{FROMPOS} @tab The type shall be @code{INTEGER}.
8115 @item @var{LEN} @tab The type shall be @code{INTEGER}.
8116 @item @var{TO} @tab The type shall be @code{INTEGER}, of the
8117 same kind as @var{FROM}.
8118 @item @var{TOPOS} @tab The type shall be @code{INTEGER}.
8121 @item @emph{See also}:
8122 @ref{IBCLR}, @ref{IBSET}, @ref{IBITS}, @ref{IAND}, @ref{IOR}, @ref{IEOR}
8128 @section @code{NEAREST} --- Nearest representable number
8130 @cindex real number, nearest different
8131 @cindex floating point, nearest different
8134 @item @emph{Description}:
8135 @code{NEAREST(X, S)} returns the processor-representable number nearest
8136 to @code{X} in the direction indicated by the sign of @code{S}.
8138 @item @emph{Standard}:
8139 Fortran 95 and later
8144 @item @emph{Syntax}:
8145 @code{RESULT = NEAREST(X, S)}
8147 @item @emph{Arguments}:
8148 @multitable @columnfractions .15 .70
8149 @item @var{X} @tab Shall be of type @code{REAL}.
8150 @item @var{S} @tab (Optional) shall be of type @code{REAL} and
8154 @item @emph{Return value}:
8155 The return value is of the same type as @code{X}. If @code{S} is
8156 positive, @code{NEAREST} returns the processor-representable number
8157 greater than @code{X} and nearest to it. If @code{S} is negative,
8158 @code{NEAREST} returns the processor-representable number smaller than
8159 @code{X} and nearest to it.
8161 @item @emph{Example}:
8163 program test_nearest
8165 x = nearest(42.0, 1.0)
8166 y = nearest(42.0, -1.0)
8167 write (*,"(3(G20.15))") x, y, x - y
8168 end program test_nearest
8175 @section @code{NEW_LINE} --- New line character
8178 @cindex output, newline
8181 @item @emph{Description}:
8182 @code{NEW_LINE(C)} returns the new-line character.
8184 @item @emph{Standard}:
8185 Fortran 2003 and later
8190 @item @emph{Syntax}:
8191 @code{RESULT = NEW_LINE(C)}
8193 @item @emph{Arguments}:
8194 @multitable @columnfractions .15 .70
8195 @item @var{C} @tab The argument shall be a scalar or array of the
8196 type @code{CHARACTER}.
8199 @item @emph{Return value}:
8200 Returns a @var{CHARACTER} scalar of length one with the new-line character of
8201 the same kind as parameter @var{C}.
8203 @item @emph{Example}:
8207 write(*,'(A)') 'This is record 1.'//NEW_LINE('A')//'This is record 2.'
8215 @section @code{NINT} --- Nearest whole number
8218 @cindex rounding, nearest whole number
8221 @item @emph{Description}:
8222 @code{NINT(X)} rounds its argument to the nearest whole number.
8224 @item @emph{Standard}:
8225 Fortran 77 and later, with @var{KIND} argument Fortran 90 and later
8230 @item @emph{Syntax}:
8231 @code{RESULT = NINT(X [, KIND])}
8233 @item @emph{Arguments}:
8234 @multitable @columnfractions .15 .70
8235 @item @var{X} @tab The type of the argument shall be @code{REAL}.
8236 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
8237 expression indicating the kind parameter of the result.
8240 @item @emph{Return value}:
8241 Returns @var{A} with the fractional portion of its magnitude eliminated by
8242 rounding to the nearest whole number and with its sign preserved,
8243 converted to an @code{INTEGER} of the default kind.
8245 @item @emph{Example}:
8252 print *, nint(x4), idnint(x8)
8253 end program test_nint
8256 @item @emph{Specific names}:
8257 @multitable @columnfractions .25 .25 .25
8258 @item Name @tab Argument @tab Standard
8259 @item @code{IDNINT(X)} @tab @code{REAL(8)} @tab Fortran 95 and later
8262 @item @emph{See also}:
8263 @ref{CEILING}, @ref{FLOOR}
8270 @section @code{NOT} --- Logical negation
8272 @cindex bits, negate
8273 @cindex bitwise logical not
8274 @cindex logical not, bitwise
8277 @item @emph{Description}:
8278 @code{NOT} returns the bitwise boolean inverse of @var{I}.
8280 @item @emph{Standard}:
8281 Fortran 95 and later
8286 @item @emph{Syntax}:
8287 @code{RESULT = NOT(I)}
8289 @item @emph{Arguments}:
8290 @multitable @columnfractions .15 .70
8291 @item @var{I} @tab The type shall be @code{INTEGER}.
8294 @item @emph{Return value}:
8295 The return type is @code{INTEGER}, of the same kind as the
8298 @item @emph{See also}:
8299 @ref{IAND}, @ref{IEOR}, @ref{IOR}, @ref{IBITS}, @ref{IBSET}, @ref{IBCLR}
8306 @section @code{NULL} --- Function that returns an disassociated pointer
8308 @cindex pointer, status
8309 @cindex pointer, disassociated
8312 @item @emph{Description}:
8313 Returns a disassociated pointer.
8315 If @var{MOLD} is present, a dissassociated pointer of the same type is
8316 returned, otherwise the type is determined by context.
8318 In Fortran 95, @var{MOLD} is optional. Please note that Fortran 2003
8319 includes cases where it is required.
8321 @item @emph{Standard}:
8322 Fortran 95 and later
8325 Transformational function
8327 @item @emph{Syntax}:
8328 @code{PTR => NULL([MOLD])}
8330 @item @emph{Arguments}:
8331 @multitable @columnfractions .15 .70
8332 @item @var{MOLD} @tab (Optional) shall be a pointer of any association
8333 status and of any type.
8336 @item @emph{Return value}:
8337 A disassociated pointer.
8339 @item @emph{Example}:
8341 REAL, POINTER, DIMENSION(:) :: VEC => NULL ()
8344 @item @emph{See also}:
8351 @section @code{OR} --- Bitwise logical OR
8353 @cindex bitwise logical or
8354 @cindex logical or, bitwise
8357 @item @emph{Description}:
8358 Bitwise logical @code{OR}.
8360 This intrinsic routine is provided for backwards compatibility with
8361 GNU Fortran 77. For integer arguments, programmers should consider
8362 the use of the @ref{IOR} intrinsic defined by the Fortran standard.
8364 @item @emph{Standard}:
8370 @item @emph{Syntax}:
8371 @code{RESULT = OR(X, Y)}
8373 @item @emph{Arguments}:
8374 @multitable @columnfractions .15 .70
8375 @item @var{X} @tab The type shall be either a scalar @code{INTEGER}
8376 type or a scalar @code{LOGICAL} type.
8377 @item @var{Y} @tab The type shall be the same as the type of @var{X}.
8380 @item @emph{Return value}:
8381 The return type is either a scalar @code{INTEGER} or a scalar
8382 @code{LOGICAL}. If the kind type parameters differ, then the
8383 smaller kind type is implicitly converted to larger kind, and the
8384 return has the larger kind.
8386 @item @emph{Example}:
8389 LOGICAL :: T = .TRUE., F = .FALSE.
8391 DATA a / Z'F' /, b / Z'3' /
8393 WRITE (*,*) OR(T, T), OR(T, F), OR(F, T), OR(F, F)
8394 WRITE (*,*) OR(a, b)
8398 @item @emph{See also}:
8399 Fortran 95 elemental function: @ref{IOR}
8405 @section @code{PACK} --- Pack an array into an array of rank one
8407 @cindex array, packing
8408 @cindex array, reduce dimension
8409 @cindex array, gather elements
8412 @item @emph{Description}:
8413 Stores the elements of @var{ARRAY} in an array of rank one.
8415 The beginning of the resulting array is made up of elements whose @var{MASK}
8416 equals @code{TRUE}. Afterwards, positions are filled with elements taken from
8419 @item @emph{Standard}:
8420 Fortran 95 and later
8423 Transformational function
8425 @item @emph{Syntax}:
8426 @code{RESULT = PACK(ARRAY, MASK[,VECTOR]}
8428 @item @emph{Arguments}:
8429 @multitable @columnfractions .15 .70
8430 @item @var{ARRAY} @tab Shall be an array of any type.
8431 @item @var{MASK} @tab Shall be an array of type @code{LOGICAL} and
8432 of the same size as @var{ARRAY}. Alternatively, it may be a @code{LOGICAL}
8434 @item @var{VECTOR} @tab (Optional) shall be an array of the same type
8435 as @var{ARRAY} and of rank one. If present, the number of elements in
8436 @var{VECTOR} shall be equal to or greater than the number of true elements
8437 in @var{MASK}. If @var{MASK} is scalar, the number of elements in
8438 @var{VECTOR} shall be equal to or greater than the number of elements in
8442 @item @emph{Return value}:
8443 The result is an array of rank one and the same type as that of @var{ARRAY}.
8444 If @var{VECTOR} is present, the result size is that of @var{VECTOR}, the
8445 number of @code{TRUE} values in @var{MASK} otherwise.
8447 @item @emph{Example}:
8448 Gathering nonzero elements from an array:
8452 m = (/ 1, 0, 0, 0, 5, 0 /)
8453 WRITE(*, FMT="(6(I0, ' '))") pack(m, m /= 0) ! "1 5"
8457 Gathering nonzero elements from an array and appending elements from @var{VECTOR}:
8461 m = (/ 1, 0, 0, 2 /)
8462 WRITE(*, FMT="(4(I0, ' '))") pack(m, m /= 0, (/ 0, 0, 3, 4 /)) ! "1 2 3 4"
8466 @item @emph{See also}:
8473 @section @code{PERROR} --- Print system error message
8475 @cindex system, error handling
8478 @item @emph{Description}:
8479 Prints (on the C @code{stderr} stream) a newline-terminated error
8480 message corresponding to the last system error. This is prefixed by
8481 @var{STRING}, a colon and a space. See @code{perror(3)}.
8483 @item @emph{Standard}:
8489 @item @emph{Syntax}:
8490 @code{CALL PERROR(STRING)}
8492 @item @emph{Arguments}:
8493 @multitable @columnfractions .15 .70
8494 @item @var{STRING} @tab A scalar of type @code{CHARACTER} and of the
8498 @item @emph{See also}:
8505 @section @code{PRECISION} --- Decimal precision of a real kind
8507 @cindex model representation, precision
8510 @item @emph{Description}:
8511 @code{PRECISION(X)} returns the decimal precision in the model of the
8514 @item @emph{Standard}:
8515 Fortran 95 and later
8520 @item @emph{Syntax}:
8521 @code{RESULT = PRECISION(X)}
8523 @item @emph{Arguments}:
8524 @multitable @columnfractions .15 .70
8525 @item @var{X} @tab Shall be of type @code{REAL} or @code{COMPLEX}.
8528 @item @emph{Return value}:
8529 The return value is of type @code{INTEGER} and of the default integer
8532 @item @emph{Example}:
8534 program prec_and_range
8535 real(kind=4) :: x(2)
8536 complex(kind=8) :: y
8538 print *, precision(x), range(x)
8539 print *, precision(y), range(y)
8540 end program prec_and_range
8547 @section @code{PRESENT} --- Determine whether an optional dummy argument is specified
8551 @item @emph{Description}:
8552 Determines whether an optional dummy argument is present.
8554 @item @emph{Standard}:
8555 Fortran 95 and later
8560 @item @emph{Syntax}:
8561 @code{RESULT = PRESENT(A)}
8563 @item @emph{Arguments}:
8564 @multitable @columnfractions .15 .70
8565 @item @var{A} @tab May be of any type and may be a pointer, scalar or array
8566 value, or a dummy procedure. It shall be the name of an optional dummy argument
8567 accessible within the current subroutine or function.
8570 @item @emph{Return value}:
8571 Returns either @code{TRUE} if the optional argument @var{A} is present, or
8572 @code{FALSE} otherwise.
8574 @item @emph{Example}:
8576 PROGRAM test_present
8577 WRITE(*,*) f(), f(42) ! "F T"
8579 LOGICAL FUNCTION f(x)
8580 INTEGER, INTENT(IN), OPTIONAL :: x
8590 @section @code{PRODUCT} --- Product of array elements
8592 @cindex array, product
8593 @cindex array, multiply elements
8594 @cindex array, conditionally multiply elements
8595 @cindex multiply array elements
8598 @item @emph{Description}:
8599 Multiplies the elements of @var{ARRAY} along dimension @var{DIM} if
8600 the corresponding element in @var{MASK} is @code{TRUE}.
8602 @item @emph{Standard}:
8603 Fortran 95 and later
8606 Transformational function
8608 @item @emph{Syntax}:
8609 @code{RESULT = PRODUCT(ARRAY[, MASK])}
8610 @code{RESULT = PRODUCT(ARRAY, DIM[, MASK])}
8612 @item @emph{Arguments}:
8613 @multitable @columnfractions .15 .70
8614 @item @var{ARRAY} @tab Shall be an array of type @code{INTEGER},
8615 @code{REAL} or @code{COMPLEX}.
8616 @item @var{DIM} @tab (Optional) shall be a scalar of type
8617 @code{INTEGER} with a value in the range from 1 to n, where n
8618 equals the rank of @var{ARRAY}.
8619 @item @var{MASK} @tab (Optional) shall be of type @code{LOGICAL}
8620 and either be a scalar or an array of the same shape as @var{ARRAY}.
8623 @item @emph{Return value}:
8624 The result is of the same type as @var{ARRAY}.
8626 If @var{DIM} is absent, a scalar with the product of all elements in
8627 @var{ARRAY} is returned. Otherwise, an array of rank n-1, where n equals
8628 the rank of @var{ARRAY}, and a shape similar to that of @var{ARRAY} with
8629 dimension @var{DIM} dropped is returned.
8632 @item @emph{Example}:
8634 PROGRAM test_product
8635 INTEGER :: x(5) = (/ 1, 2, 3, 4 ,5 /)
8636 print *, PRODUCT(x) ! all elements, product = 120
8637 print *, PRODUCT(x, MASK=MOD(x, 2)==1) ! odd elements, product = 15
8641 @item @emph{See also}:
8648 @section @code{RADIX} --- Base of a model number
8650 @cindex model representation, base
8651 @cindex model representation, radix
8654 @item @emph{Description}:
8655 @code{RADIX(X)} returns the base of the model representing the entity @var{X}.
8657 @item @emph{Standard}:
8658 Fortran 95 and later
8663 @item @emph{Syntax}:
8664 @code{RESULT = RADIX(X)}
8666 @item @emph{Arguments}:
8667 @multitable @columnfractions .15 .70
8668 @item @var{X} @tab Shall be of type @code{INTEGER} or @code{REAL}
8671 @item @emph{Return value}:
8672 The return value is a scalar of type @code{INTEGER} and of the default
8675 @item @emph{Example}:
8678 print *, "The radix for the default integer kind is", radix(0)
8679 print *, "The radix for the default real kind is", radix(0.0)
8680 end program test_radix
8688 @section @code{RAN} --- Real pseudo-random number
8690 @cindex random number generation
8693 @item @emph{Description}:
8694 For compatibility with HP FORTRAN 77/iX, the @code{RAN} intrinsic is
8695 provided as an alias for @code{RAND}. See @ref{RAND} for complete
8698 @item @emph{Standard}:
8704 @item @emph{See also}:
8705 @ref{RAND}, @ref{RANDOM_NUMBER}
8711 @section @code{RAND} --- Real pseudo-random number
8713 @cindex random number generation
8716 @item @emph{Description}:
8717 @code{RAND(FLAG)} returns a pseudo-random number from a uniform
8718 distribution between 0 and 1. If @var{FLAG} is 0, the next number
8719 in the current sequence is returned; if @var{FLAG} is 1, the generator
8720 is restarted by @code{CALL SRAND(0)}; if @var{FLAG} has any other value,
8721 it is used as a new seed with @code{SRAND}.
8723 This intrinsic routine is provided for backwards compatibility with
8724 GNU Fortran 77. It implements a simple modulo generator as provided
8725 by @command{g77}. For new code, one should consider the use of
8726 @ref{RANDOM_NUMBER} as it implements a superior algorithm.
8728 @item @emph{Standard}:
8734 @item @emph{Syntax}:
8735 @code{RESULT = RAND(FLAG)}
8737 @item @emph{Arguments}:
8738 @multitable @columnfractions .15 .70
8739 @item @var{FLAG} @tab Shall be a scalar @code{INTEGER} of kind 4.
8742 @item @emph{Return value}:
8743 The return value is of @code{REAL} type and the default kind.
8745 @item @emph{Example}:
8748 integer,parameter :: seed = 86456
8751 print *, rand(), rand(), rand(), rand()
8752 print *, rand(seed), rand(), rand(), rand()
8753 end program test_rand
8756 @item @emph{See also}:
8757 @ref{SRAND}, @ref{RANDOM_NUMBER}
8764 @section @code{RANDOM_NUMBER} --- Pseudo-random number
8765 @fnindex RANDOM_NUMBER
8766 @cindex random number generation
8769 @item @emph{Description}:
8770 Returns a single pseudorandom number or an array of pseudorandom numbers
8771 from the uniform distribution over the range @math{ 0 \leq x < 1}.
8773 The runtime-library implements George Marsaglia's KISS (Keep It Simple
8774 Stupid) random number generator (RNG). This RNG combines:
8776 @item The congruential generator @math{x(n) = 69069 \cdot x(n-1) + 1327217885}
8777 with a period of @math{2^{32}},
8778 @item A 3-shift shift-register generator with a period of @math{2^{32} - 1},
8779 @item Two 16-bit multiply-with-carry generators with a period of
8780 @math{597273182964842497 > 2^{59}}.
8782 The overall period exceeds @math{2^{123}}.
8784 Please note, this RNG is thread safe if used within OpenMP directives,
8785 i.e., its state will be consistent while called from multiple threads.
8786 However, the KISS generator does not create random numbers in parallel
8787 from multiple sources, but in sequence from a single source. If an
8788 OpenMP-enabled application heavily relies on random numbers, one should
8789 consider employing a dedicated parallel random number generator instead.
8791 @item @emph{Standard}:
8792 Fortran 95 and later
8797 @item @emph{Syntax}:
8798 @code{RANDOM_NUMBER(HARVEST)}
8800 @item @emph{Arguments}:
8801 @multitable @columnfractions .15 .70
8802 @item @var{HARVEST} @tab Shall be a scalar or an array of type @code{REAL}.
8805 @item @emph{Example}:
8807 program test_random_number
8809 CALL init_random_seed() ! see example of RANDOM_SEED
8810 CALL RANDOM_NUMBER(r)
8814 @item @emph{See also}:
8821 @section @code{RANDOM_SEED} --- Initialize a pseudo-random number sequence
8822 @fnindex RANDOM_SEED
8823 @cindex random number generation, seeding
8824 @cindex seeding a random number generator
8827 @item @emph{Description}:
8828 Restarts or queries the state of the pseudorandom number generator used by
8829 @code{RANDOM_NUMBER}.
8831 If @code{RANDOM_SEED} is called without arguments, it is initialized to
8832 a default state. The example below shows how to initialize the random
8833 seed based on the system's time.
8835 @item @emph{Standard}:
8836 Fortran 95 and later
8841 @item @emph{Syntax}:
8842 @code{CALL RANDOM_SEED(SIZE, PUT, GET)}
8844 @item @emph{Arguments}:
8845 @multitable @columnfractions .15 .70
8846 @item @var{SIZE} @tab (Optional) Shall be a scalar and of type default
8847 @code{INTEGER}, with @code{INTENT(OUT)}. It specifies the minimum size
8848 of the arrays used with the @var{PUT} and @var{GET} arguments.
8849 @item @var{PUT} @tab (Optional) Shall be an array of type default
8850 @code{INTEGER} and rank one. It is @code{INTENT(IN)} and the size of
8851 the array must be larger than or equal to the number returned by the
8852 @var{SIZE} argument.
8853 @item @var{GET} @tab (Optional) Shall be an array of type default
8854 @code{INTEGER} and rank one. It is @code{INTENT(OUT)} and the size
8855 of the array must be larger than or equal to the number returned by
8856 the @var{SIZE} argument.
8859 @item @emph{Example}:
8861 SUBROUTINE init_random_seed()
8862 INTEGER :: i, n, clock
8863 INTEGER, DIMENSION(:), ALLOCATABLE :: seed
8865 CALL RANDOM_SEED(size = n)
8868 CALL SYSTEM_CLOCK(COUNT=clock)
8870 seed = clock + 37 * (/ (i - 1, i = 1, n) /)
8871 CALL RANDOM_SEED(PUT = seed)
8877 @item @emph{See also}:
8884 @section @code{RANGE} --- Decimal exponent range
8886 @cindex model representation, range
8889 @item @emph{Description}:
8890 @code{RANGE(X)} returns the decimal exponent range in the model of the
8893 @item @emph{Standard}:
8894 Fortran 95 and later
8899 @item @emph{Syntax}:
8900 @code{RESULT = RANGE(X)}
8902 @item @emph{Arguments}:
8903 @multitable @columnfractions .15 .70
8904 @item @var{X} @tab Shall be of type @code{INTEGER}, @code{REAL}
8908 @item @emph{Return value}:
8909 The return value is of type @code{INTEGER} and of the default integer
8912 @item @emph{Example}:
8913 See @code{PRECISION} for an example.
8919 @section @code{REAL} --- Convert to real type
8922 @cindex conversion, to real
8923 @cindex complex numbers, real part
8926 @item @emph{Description}:
8927 @code{REAL(X [, KIND])} converts its argument @var{X} to a real type. The
8928 @code{REALPART(X)} function is provided for compatibility with @command{g77},
8929 and its use is strongly discouraged.
8931 @item @emph{Standard}:
8932 Fortran 77 and later
8937 @item @emph{Syntax}:
8938 @multitable @columnfractions .80
8939 @item @code{RESULT = REAL(X [, KIND])}
8940 @item @code{RESULT = REALPART(Z)}
8943 @item @emph{Arguments}:
8944 @multitable @columnfractions .15 .70
8945 @item @var{X} @tab Shall be @code{INTEGER}, @code{REAL}, or
8947 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
8948 expression indicating the kind parameter of the result.
8951 @item @emph{Return value}:
8952 These functions return a @code{REAL} variable or array under
8953 the following rules:
8957 @code{REAL(X)} is converted to a default real type if @var{X} is an
8958 integer or real variable.
8960 @code{REAL(X)} is converted to a real type with the kind type parameter
8961 of @var{X} if @var{X} is a complex variable.
8963 @code{REAL(X, KIND)} is converted to a real type with kind type
8964 parameter @var{KIND} if @var{X} is a complex, integer, or real
8968 @item @emph{Example}:
8971 complex :: x = (1.0, 2.0)
8972 print *, real(x), real(x,8), realpart(x)
8973 end program test_real
8976 @item @emph{See also}:
8977 @ref{DBLE}, @ref{DFLOAT}, @ref{FLOAT}
8984 @section @code{RENAME} --- Rename a file
8986 @cindex file system, rename file
8989 @item @emph{Description}:
8990 Renames a file from file @var{PATH1} to @var{PATH2}. A null
8991 character (@code{CHAR(0)}) can be used to mark the end of the names in
8992 @var{PATH1} and @var{PATH2}; otherwise, trailing blanks in the file
8993 names are ignored. If the @var{STATUS} argument is supplied, it
8994 contains 0 on success or a nonzero error code upon return; see
8997 This intrinsic is provided in both subroutine and function forms;
8998 however, only one form can be used in any given program unit.
9000 @item @emph{Standard}:
9004 Subroutine, function
9006 @item @emph{Syntax}:
9007 @multitable @columnfractions .80
9008 @item @code{CALL RENAME(PATH1, PATH2 [, STATUS])}
9009 @item @code{STATUS = RENAME(PATH1, PATH2)}
9012 @item @emph{Arguments}:
9013 @multitable @columnfractions .15 .70
9014 @item @var{PATH1} @tab Shall be of default @code{CHARACTER} type.
9015 @item @var{PATH2} @tab Shall be of default @code{CHARACTER} type.
9016 @item @var{STATUS} @tab (Optional) Shall be of default @code{INTEGER} type.
9019 @item @emph{See also}:
9027 @section @code{REPEAT} --- Repeated string concatenation
9029 @cindex string, repeat
9030 @cindex string, concatenate
9033 @item @emph{Description}:
9034 Concatenates @var{NCOPIES} copies of a string.
9036 @item @emph{Standard}:
9037 Fortran 95 and later
9040 Transformational function
9042 @item @emph{Syntax}:
9043 @code{RESULT = REPEAT(STRING, NCOPIES)}
9045 @item @emph{Arguments}:
9046 @multitable @columnfractions .15 .70
9047 @item @var{STRING} @tab Shall be scalar and of type @code{CHARACTER}.
9048 @item @var{NCOPIES} @tab Shall be scalar and of type @code{INTEGER}.
9051 @item @emph{Return value}:
9052 A new scalar of type @code{CHARACTER} built up from @var{NCOPIES} copies
9055 @item @emph{Example}:
9058 write(*,*) repeat("x", 5) ! "xxxxx"
9066 @section @code{RESHAPE} --- Function to reshape an array
9068 @cindex array, change dimensions
9069 @cindex array, transmogrify
9072 @item @emph{Description}:
9073 Reshapes @var{SOURCE} to correspond to @var{SHAPE}. If necessary,
9074 the new array may be padded with elements from @var{PAD} or permuted
9075 as defined by @var{ORDER}.
9077 @item @emph{Standard}:
9078 Fortran 95 and later
9081 Transformational function
9083 @item @emph{Syntax}:
9084 @code{RESULT = RESHAPE(SOURCE, SHAPE[, PAD, ORDER])}
9086 @item @emph{Arguments}:
9087 @multitable @columnfractions .15 .70
9088 @item @var{SOURCE} @tab Shall be an array of any type.
9089 @item @var{SHAPE} @tab Shall be of type @code{INTEGER} and an
9090 array of rank one. Its values must be positive or zero.
9091 @item @var{PAD} @tab (Optional) shall be an array of the same
9092 type as @var{SOURCE}.
9093 @item @var{ORDER} @tab (Optional) shall be of type @code{INTEGER}
9094 and an array of the same shape as @var{SHAPE}. Its values shall
9095 be a permutation of the numbers from 1 to n, where n is the size of
9096 @var{SHAPE}. If @var{ORDER} is absent, the natural ordering shall
9100 @item @emph{Return value}:
9101 The result is an array of shape @var{SHAPE} with the same type as
9104 @item @emph{Example}:
9106 PROGRAM test_reshape
9107 INTEGER, DIMENSION(4) :: x
9108 WRITE(*,*) SHAPE(x) ! prints "4"
9109 WRITE(*,*) SHAPE(RESHAPE(x, (/2, 2/))) ! prints "2 2"
9113 @item @emph{See also}:
9120 @section @code{RRSPACING} --- Reciprocal of the relative spacing
9122 @cindex real number, relative spacing
9123 @cindex floating point, relative spacing
9127 @item @emph{Description}:
9128 @code{RRSPACING(X)} returns the reciprocal of the relative spacing of
9129 model numbers near @var{X}.
9131 @item @emph{Standard}:
9132 Fortran 95 and later
9137 @item @emph{Syntax}:
9138 @code{RESULT = RRSPACING(X)}
9140 @item @emph{Arguments}:
9141 @multitable @columnfractions .15 .70
9142 @item @var{X} @tab Shall be of type @code{REAL}.
9145 @item @emph{Return value}:
9146 The return value is of the same type and kind as @var{X}.
9147 The value returned is equal to
9148 @code{ABS(FRACTION(X)) * FLOAT(RADIX(X))**DIGITS(X)}.
9150 @item @emph{See also}:
9157 @section @code{RSHIFT} --- Right shift bits
9159 @cindex bits, shift right
9162 @item @emph{Description}:
9163 @code{RSHIFT} returns a value corresponding to @var{I} with all of the
9164 bits shifted right by @var{SHIFT} places. If the absolute value of
9165 @var{SHIFT} is greater than @code{BIT_SIZE(I)}, the value is undefined.
9166 Bits shifted out from the left end are lost; zeros are shifted in from
9169 This function has been superseded by the @code{ISHFT} intrinsic, which
9170 is standard in Fortran 95 and later.
9172 @item @emph{Standard}:
9178 @item @emph{Syntax}:
9179 @code{RESULT = RSHIFT(I, SHIFT)}
9181 @item @emph{Arguments}:
9182 @multitable @columnfractions .15 .70
9183 @item @var{I} @tab The type shall be @code{INTEGER}.
9184 @item @var{SHIFT} @tab The type shall be @code{INTEGER}.
9187 @item @emph{Return value}:
9188 The return value is of type @code{INTEGER} and of the same kind as
9191 @item @emph{See also}:
9192 @ref{ISHFT}, @ref{ISHFTC}, @ref{LSHIFT}
9199 @section @code{SCALE} --- Scale a real value
9201 @cindex real number, scale
9202 @cindex floating point, scale
9205 @item @emph{Description}:
9206 @code{SCALE(X,I)} returns @code{X * RADIX(X)**I}.
9208 @item @emph{Standard}:
9209 Fortran 95 and later
9214 @item @emph{Syntax}:
9215 @code{RESULT = SCALE(X, I)}
9217 @item @emph{Arguments}:
9218 @multitable @columnfractions .15 .70
9219 @item @var{X} @tab The type of the argument shall be a @code{REAL}.
9220 @item @var{I} @tab The type of the argument shall be a @code{INTEGER}.
9223 @item @emph{Return value}:
9224 The return value is of the same type and kind as @var{X}.
9225 Its value is @code{X * RADIX(X)**I}.
9227 @item @emph{Example}:
9230 real :: x = 178.1387e-4
9232 print *, scale(x,i), x*radix(x)**i
9233 end program test_scale
9241 @section @code{SCAN} --- Scan a string for the presence of a set of characters
9243 @cindex string, find subset
9246 @item @emph{Description}:
9247 Scans a @var{STRING} for any of the characters in a @var{SET}
9250 If @var{BACK} is either absent or equals @code{FALSE}, this function
9251 returns the position of the leftmost character of @var{STRING} that is
9252 in @var{SET}. If @var{BACK} equals @code{TRUE}, the rightmost position
9253 is returned. If no character of @var{SET} is found in @var{STRING}, the
9256 @item @emph{Standard}:
9257 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
9262 @item @emph{Syntax}:
9263 @code{RESULT = SCAN(STRING, SET[, BACK [, KIND]])}
9265 @item @emph{Arguments}:
9266 @multitable @columnfractions .15 .70
9267 @item @var{STRING} @tab Shall be of type @code{CHARACTER}.
9268 @item @var{SET} @tab Shall be of type @code{CHARACTER}.
9269 @item @var{BACK} @tab (Optional) shall be of type @code{LOGICAL}.
9270 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
9271 expression indicating the kind parameter of the result.
9274 @item @emph{Return value}:
9275 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
9276 @var{KIND} is absent, the return value is of default integer kind.
9278 @item @emph{Example}:
9281 WRITE(*,*) SCAN("FORTRAN", "AO") ! 2, found 'O'
9282 WRITE(*,*) SCAN("FORTRAN", "AO", .TRUE.) ! 6, found 'A'
9283 WRITE(*,*) SCAN("FORTRAN", "C++") ! 0, found none
9287 @item @emph{See also}:
9288 @ref{INDEX intrinsic}, @ref{VERIFY}
9294 @section @code{SECNDS} --- Time function
9296 @cindex time, elapsed
9297 @cindex elapsed time
9300 @item @emph{Description}:
9301 @code{SECNDS(X)} gets the time in seconds from the real-time system clock.
9302 @var{X} is a reference time, also in seconds. If this is zero, the time in
9303 seconds from midnight is returned. This function is non-standard and its
9306 @item @emph{Standard}:
9312 @item @emph{Syntax}:
9313 @code{RESULT = SECNDS (X)}
9315 @item @emph{Arguments}:
9316 @multitable @columnfractions .15 .70
9317 @item @var{T} @tab Shall be of type @code{REAL(4)}.
9318 @item @var{X} @tab Shall be of type @code{REAL(4)}.
9321 @item @emph{Return value}:
9324 @item @emph{Example}:
9329 print *, secnds (0.0) ! seconds since midnight
9330 t1 = secnds (0.0) ! reference time
9331 do i = 1, 10000000 ! do something
9333 t2 = secnds (t1) ! elapsed time
9334 print *, "Something took ", t2, " seconds."
9335 end program test_secnds
9342 @section @code{SECOND} --- CPU time function
9344 @cindex time, elapsed
9345 @cindex elapsed time
9348 @item @emph{Description}:
9349 Returns a @code{REAL(4)} value representing the elapsed CPU time in
9350 seconds. This provides the same functionality as the standard
9351 @code{CPU_TIME} intrinsic, and is only included for backwards
9354 This intrinsic is provided in both subroutine and function forms;
9355 however, only one form can be used in any given program unit.
9357 @item @emph{Standard}:
9361 Subroutine, function
9363 @item @emph{Syntax}:
9364 @multitable @columnfractions .80
9365 @item @code{CALL SECOND(TIME)}
9366 @item @code{TIME = SECOND()}
9369 @item @emph{Arguments}:
9370 @multitable @columnfractions .15 .70
9371 @item @var{TIME} @tab Shall be of type @code{REAL(4)}.
9374 @item @emph{Return value}:
9375 In either syntax, @var{TIME} is set to the process's current runtime in
9378 @item @emph{See also}:
9385 @node SELECTED_CHAR_KIND
9386 @section @code{SELECTED_CHAR_KIND} --- Choose character kind
9387 @fnindex SELECTED_CHAR_KIND
9388 @cindex character kind
9389 @cindex kind, character
9392 @item @emph{Description}:
9394 @code{SELECTED_CHAR_KIND(NAME)} returns the kind value for the character
9395 set named @var{NAME}, if a character set with such a name is supported,
9396 or @math{-1} otherwise. Currently, supported character sets include
9397 ``ASCII'' and ``DEFAULT'', which are equivalent.
9399 @item @emph{Standard}:
9400 Fortran 2003 and later
9403 Transformational function
9405 @item @emph{Syntax}:
9406 @code{RESULT = SELECTED_CHAR_KIND(NAME)}
9408 @item @emph{Arguments}:
9409 @multitable @columnfractions .15 .70
9410 @item @var{NAME} @tab Shall be a scalar and of the default character type.
9413 @item @emph{Example}:
9416 integer,parameter :: ascii = selected_char_kind("ascii")
9417 character(kind=ascii, len=26) :: s
9419 s = ascii_"abcdefghijklmnopqrstuvwxyz"
9421 end program ascii_kind
9427 @node SELECTED_INT_KIND
9428 @section @code{SELECTED_INT_KIND} --- Choose integer kind
9429 @fnindex SELECTED_INT_KIND
9430 @cindex integer kind
9431 @cindex kind, integer
9434 @item @emph{Description}:
9435 @code{SELECTED_INT_KIND(I)} return the kind value of the smallest integer
9436 type that can represent all values ranging from @math{-10^I} (exclusive)
9437 to @math{10^I} (exclusive). If there is no integer kind that accommodates
9438 this range, @code{SELECTED_INT_KIND} returns @math{-1}.
9440 @item @emph{Standard}:
9441 Fortran 95 and later
9444 Transformational function
9446 @item @emph{Syntax}:
9447 @code{RESULT = SELECTED_INT_KIND(I)}
9449 @item @emph{Arguments}:
9450 @multitable @columnfractions .15 .70
9451 @item @var{I} @tab Shall be a scalar and of type @code{INTEGER}.
9454 @item @emph{Example}:
9456 program large_integers
9457 integer,parameter :: k5 = selected_int_kind(5)
9458 integer,parameter :: k15 = selected_int_kind(15)
9459 integer(kind=k5) :: i5
9460 integer(kind=k15) :: i15
9462 print *, huge(i5), huge(i15)
9464 ! The following inequalities are always true
9465 print *, huge(i5) >= 10_k5**5-1
9466 print *, huge(i15) >= 10_k15**15-1
9467 end program large_integers
9473 @node SELECTED_REAL_KIND
9474 @section @code{SELECTED_REAL_KIND} --- Choose real kind
9475 @fnindex SELECTED_REAL_KIND
9480 @item @emph{Description}:
9481 @code{SELECTED_REAL_KIND(P,R)} returns the kind value of a real data type
9482 with decimal precision of at least @code{P} digits and exponent
9483 range greater at least @code{R}.
9485 @item @emph{Standard}:
9486 Fortran 95 and later
9489 Transformational function
9491 @item @emph{Syntax}:
9492 @code{RESULT = SELECTED_REAL_KIND(P, R)}
9494 @item @emph{Arguments}:
9495 @multitable @columnfractions .15 .70
9496 @item @var{P} @tab (Optional) shall be a scalar and of type @code{INTEGER}.
9497 @item @var{R} @tab (Optional) shall be a scalar and of type @code{INTEGER}.
9499 At least one argument shall be present.
9501 @item @emph{Return value}:
9503 @code{SELECTED_REAL_KIND} returns the value of the kind type parameter of
9504 a real data type with decimal precision of at least @code{P} digits and a
9505 decimal exponent range of at least @code{R}. If more than one real data
9506 type meet the criteria, the kind of the data type with the smallest
9507 decimal precision is returned. If no real data type matches the criteria,
9510 @item -1 if the processor does not support a real data type with a
9511 precision greater than or equal to @code{P}
9512 @item -2 if the processor does not support a real type with an exponent
9513 range greater than or equal to @code{R}
9514 @item -3 if neither is supported.
9517 @item @emph{Example}:
9520 integer,parameter :: p6 = selected_real_kind(6)
9521 integer,parameter :: p10r100 = selected_real_kind(10,100)
9522 integer,parameter :: r400 = selected_real_kind(r=400)
9524 real(kind=p10r100) :: y
9525 real(kind=r400) :: z
9527 print *, precision(x), range(x)
9528 print *, precision(y), range(y)
9529 print *, precision(z), range(z)
9530 end program real_kinds
9537 @section @code{SET_EXPONENT} --- Set the exponent of the model
9538 @fnindex SET_EXPONENT
9539 @cindex real number, set exponent
9540 @cindex floating point, set exponent
9543 @item @emph{Description}:
9544 @code{SET_EXPONENT(X, I)} returns the real number whose fractional part
9545 is that that of @var{X} and whose exponent part is @var{I}.
9547 @item @emph{Standard}:
9548 Fortran 95 and later
9553 @item @emph{Syntax}:
9554 @code{RESULT = SET_EXPONENT(X, I)}
9556 @item @emph{Arguments}:
9557 @multitable @columnfractions .15 .70
9558 @item @var{X} @tab Shall be of type @code{REAL}.
9559 @item @var{I} @tab Shall be of type @code{INTEGER}.
9562 @item @emph{Return value}:
9563 The return value is of the same type and kind as @var{X}.
9564 The real number whose fractional part
9565 is that that of @var{X} and whose exponent part if @var{I} is returned;
9566 it is @code{FRACTION(X) * RADIX(X)**I}.
9568 @item @emph{Example}:
9571 REAL :: x = 178.1387e-4
9573 PRINT *, SET_EXPONENT(x, i), FRACTION(x) * RADIX(x)**i
9582 @section @code{SHAPE} --- Determine the shape of an array
9584 @cindex array, shape
9587 @item @emph{Description}:
9588 Determines the shape of an array.
9590 @item @emph{Standard}:
9591 Fortran 95 and later
9596 @item @emph{Syntax}:
9597 @code{RESULT = SHAPE(SOURCE)}
9599 @item @emph{Arguments}:
9600 @multitable @columnfractions .15 .70
9601 @item @var{SOURCE} @tab Shall be an array or scalar of any type.
9602 If @var{SOURCE} is a pointer it must be associated and allocatable
9603 arrays must be allocated.
9606 @item @emph{Return value}:
9607 An @code{INTEGER} array of rank one with as many elements as @var{SOURCE}
9608 has dimensions. The elements of the resulting array correspond to the extend
9609 of @var{SOURCE} along the respective dimensions. If @var{SOURCE} is a scalar,
9610 the result is the rank one array of size zero.
9612 @item @emph{Example}:
9615 INTEGER, DIMENSION(-1:1, -1:2) :: A
9616 WRITE(*,*) SHAPE(A) ! (/ 3, 4 /)
9617 WRITE(*,*) SIZE(SHAPE(42)) ! (/ /)
9621 @item @emph{See also}:
9622 @ref{RESHAPE}, @ref{SIZE}
9628 @section @code{SIGN} --- Sign copying function
9632 @cindex sign copying
9635 @item @emph{Description}:
9636 @code{SIGN(A,B)} returns the value of @var{A} with the sign of @var{B}.
9638 @item @emph{Standard}:
9639 Fortran 77 and later
9644 @item @emph{Syntax}:
9645 @code{RESULT = SIGN(A, B)}
9647 @item @emph{Arguments}:
9648 @multitable @columnfractions .15 .70
9649 @item @var{A} @tab Shall be of type @code{INTEGER} or @code{REAL}
9650 @item @var{B} @tab Shall be of the same type and kind as @var{A}
9653 @item @emph{Return value}:
9654 The kind of the return value is that of @var{A} and @var{B}.
9655 If @math{B\ge 0} then the result is @code{ABS(A)}, else
9656 it is @code{-ABS(A)}.
9658 @item @emph{Example}:
9661 print *, sign(-12,1)
9662 print *, sign(-12,0)
9663 print *, sign(-12,-1)
9665 print *, sign(-12.,1.)
9666 print *, sign(-12.,0.)
9667 print *, sign(-12.,-1.)
9668 end program test_sign
9671 @item @emph{Specific names}:
9672 @multitable @columnfractions .20 .20 .20 .25
9673 @item Name @tab Arguments @tab Return type @tab Standard
9674 @item @code{ISIGN(A,P)} @tab @code{INTEGER(4)} @tab @code{INTEGER(4)} @tab f95, gnu
9675 @item @code{DSIGN(A,P)} @tab @code{REAL(8)} @tab @code{REAL(8)} @tab f95, gnu
9682 @section @code{SIGNAL} --- Signal handling subroutine (or function)
9684 @cindex system, signal handling
9687 @item @emph{Description}:
9688 @code{SIGNAL(NUMBER, HANDLER [, STATUS])} causes external subroutine
9689 @var{HANDLER} to be executed with a single integer argument when signal
9690 @var{NUMBER} occurs. If @var{HANDLER} is an integer, it can be used to
9691 turn off handling of signal @var{NUMBER} or revert to its default
9692 action. See @code{signal(2)}.
9694 If @code{SIGNAL} is called as a subroutine and the @var{STATUS} argument
9695 is supplied, it is set to the value returned by @code{signal(2)}.
9697 @item @emph{Standard}:
9701 Subroutine, function
9703 @item @emph{Syntax}:
9704 @multitable @columnfractions .80
9705 @item @code{CALL SIGNAL(NUMBER, HANDLER [, STATUS])}
9706 @item @code{STATUS = SIGNAL(NUMBER, HANDLER)}
9709 @item @emph{Arguments}:
9710 @multitable @columnfractions .15 .70
9711 @item @var{NUMBER} @tab Shall be a scalar integer, with @code{INTENT(IN)}
9712 @item @var{HANDLER}@tab Signal handler (@code{INTEGER FUNCTION} or
9713 @code{SUBROUTINE}) or dummy/global @code{INTEGER} scalar.
9714 @code{INTEGER}. It is @code{INTENT(IN)}.
9715 @item @var{STATUS} @tab (Optional) @var{STATUS} shall be a scalar
9716 integer. It has @code{INTENT(OUT)}.
9718 @c TODO: What should the interface of the handler be? Does it take arguments?
9720 @item @emph{Return value}:
9721 The @code{SIGNAL} function returns the value returned by @code{signal(2)}.
9723 @item @emph{Example}:
9727 external handler_print
9729 call signal (12, handler_print)
9733 end program test_signal
9740 @section @code{SIN} --- Sine function
9746 @cindex trigonometric function, sine
9750 @item @emph{Description}:
9751 @code{SIN(X)} computes the sine of @var{X}.
9753 @item @emph{Standard}:
9754 Fortran 77 and later
9759 @item @emph{Syntax}:
9760 @code{RESULT = SIN(X)}
9762 @item @emph{Arguments}:
9763 @multitable @columnfractions .15 .70
9764 @item @var{X} @tab The type shall be @code{REAL} or
9768 @item @emph{Return value}:
9769 The return value has same type and kind as @var{X}.
9771 @item @emph{Example}:
9776 end program test_sin
9779 @item @emph{Specific names}:
9780 @multitable @columnfractions .20 .20 .20 .25
9781 @item Name @tab Argument @tab Return type @tab Standard
9782 @item @code{DSIN(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab f95, gnu
9783 @item @code{CSIN(X)} @tab @code{COMPLEX(4) X} @tab @code{COMPLEX(4)} @tab f95, gnu
9784 @item @code{ZSIN(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab f95, gnu
9785 @item @code{CDSIN(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab f95, gnu
9788 @item @emph{See also}:
9795 @section @code{SINH} --- Hyperbolic sine function
9798 @cindex hyperbolic sine
9799 @cindex hyperbolic function, sine
9800 @cindex sine, hyperbolic
9803 @item @emph{Description}:
9804 @code{SINH(X)} computes the hyperbolic sine of @var{X}.
9806 @item @emph{Standard}:
9807 Fortran 95 and later
9812 @item @emph{Syntax}:
9813 @code{RESULT = SINH(X)}
9815 @item @emph{Arguments}:
9816 @multitable @columnfractions .15 .70
9817 @item @var{X} @tab The type shall be @code{REAL}.
9820 @item @emph{Return value}:
9821 The return value is of type @code{REAL}.
9823 @item @emph{Example}:
9826 real(8) :: x = - 1.0_8
9828 end program test_sinh
9831 @item @emph{Specific names}:
9832 @multitable @columnfractions .20 .20 .20 .25
9833 @item Name @tab Argument @tab Return type @tab Standard
9834 @item @code{DSINH(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 95 and later
9837 @item @emph{See also}:
9844 @section @code{SIZE} --- Determine the size of an array
9847 @cindex array, number of elements
9848 @cindex array, count elements
9851 @item @emph{Description}:
9852 Determine the extent of @var{ARRAY} along a specified dimension @var{DIM},
9853 or the total number of elements in @var{ARRAY} if @var{DIM} is absent.
9855 @item @emph{Standard}:
9856 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
9861 @item @emph{Syntax}:
9862 @code{RESULT = SIZE(ARRAY[, DIM [, KIND]])}
9864 @item @emph{Arguments}:
9865 @multitable @columnfractions .15 .70
9866 @item @var{ARRAY} @tab Shall be an array of any type. If @var{ARRAY} is
9867 a pointer it must be associated and allocatable arrays must be allocated.
9868 @item @var{DIM} @tab (Optional) shall be a scalar of type @code{INTEGER}
9869 and its value shall be in the range from 1 to n, where n equals the rank
9871 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
9872 expression indicating the kind parameter of the result.
9875 @item @emph{Return value}:
9876 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
9877 @var{KIND} is absent, the return value is of default integer kind.
9879 @item @emph{Example}:
9882 WRITE(*,*) SIZE((/ 1, 2 /)) ! 2
9886 @item @emph{See also}:
9887 @ref{SHAPE}, @ref{RESHAPE}
9892 @section @code{SIZEOF} --- Size in bytes of an expression
9894 @cindex expression size
9895 @cindex size of an expression
9898 @item @emph{Description}:
9899 @code{SIZEOF(X)} calculates the number of bytes of storage the
9900 expression @code{X} occupies.
9902 @item @emph{Standard}:
9908 @item @emph{Syntax}:
9909 @code{N = SIZEOF(X)}
9911 @item @emph{Arguments}:
9912 @multitable @columnfractions .15 .70
9913 @item @var{X} @tab The argument shall be of any type, rank or shape.
9916 @item @emph{Return value}:
9917 The return value is of type integer and of the system-dependent kind
9918 @var{C_SIZE_T} (from the @var{ISO_C_BINDING} module). Its value is the
9919 number of bytes occupied by the argument. If the argument has the
9920 @code{POINTER} attribute, the number of bytes of the storage area pointed
9921 to is returned. If the argument is of a derived type with @code{POINTER}
9922 or @code{ALLOCATABLE} components, the return value doesn't account for
9923 the sizes of the data pointed to by these components.
9925 @item @emph{Example}:
9929 print *, (sizeof(s)/sizeof(r) == 5)
9932 The example will print @code{.TRUE.} unless you are using a platform
9933 where default @code{REAL} variables are unusually padded.
9935 @item @emph{See also}:
9941 @section @code{SLEEP} --- Sleep for the specified number of seconds
9943 @cindex delayed execution
9946 @item @emph{Description}:
9947 Calling this subroutine causes the process to pause for @var{SECONDS} seconds.
9949 @item @emph{Standard}:
9955 @item @emph{Syntax}:
9956 @code{CALL SLEEP(SECONDS)}
9958 @item @emph{Arguments}:
9959 @multitable @columnfractions .15 .70
9960 @item @var{SECONDS} @tab The type shall be of default @code{INTEGER}.
9963 @item @emph{Example}:
9974 @section @code{SNGL} --- Convert double precision real to default real
9976 @cindex conversion, to real
9979 @item @emph{Description}:
9980 @code{SNGL(A)} converts the double precision real @var{A}
9981 to a default real value. This is an archaic form of @code{REAL}
9982 that is specific to one type for @var{A}.
9984 @item @emph{Standard}:
9985 Fortran 77 and later
9990 @item @emph{Syntax}:
9991 @code{RESULT = SNGL(A)}
9993 @item @emph{Arguments}:
9994 @multitable @columnfractions .15 .70
9995 @item @var{A} @tab The type shall be a double precision @code{REAL}.
9998 @item @emph{Return value}:
9999 The return value is of type default @code{REAL}.
10001 @item @emph{See also}:
10008 @section @code{SPACING} --- Smallest distance between two numbers of a given type
10010 @cindex real number, relative spacing
10011 @cindex floating point, relative spacing
10014 @item @emph{Description}:
10015 Determines the distance between the argument @var{X} and the nearest
10016 adjacent number of the same type.
10018 @item @emph{Standard}:
10019 Fortran 95 and later
10021 @item @emph{Class}:
10024 @item @emph{Syntax}:
10025 @code{RESULT = SPACING(X)}
10027 @item @emph{Arguments}:
10028 @multitable @columnfractions .15 .70
10029 @item @var{X} @tab Shall be of type @code{REAL}.
10032 @item @emph{Return value}:
10033 The result is of the same type as the input argument @var{X}.
10035 @item @emph{Example}:
10037 PROGRAM test_spacing
10038 INTEGER, PARAMETER :: SGL = SELECTED_REAL_KIND(p=6, r=37)
10039 INTEGER, PARAMETER :: DBL = SELECTED_REAL_KIND(p=13, r=200)
10041 WRITE(*,*) spacing(1.0_SGL) ! "1.1920929E-07" on i686
10042 WRITE(*,*) spacing(1.0_DBL) ! "2.220446049250313E-016" on i686
10046 @item @emph{See also}:
10053 @section @code{SPREAD} --- Add a dimension to an array
10055 @cindex array, increase dimension
10056 @cindex array, duplicate elements
10057 @cindex array, duplicate dimensions
10060 @item @emph{Description}:
10061 Replicates a @var{SOURCE} array @var{NCOPIES} times along a specified
10062 dimension @var{DIM}.
10064 @item @emph{Standard}:
10065 Fortran 95 and later
10067 @item @emph{Class}:
10068 Transformational function
10070 @item @emph{Syntax}:
10071 @code{RESULT = SPREAD(SOURCE, DIM, NCOPIES)}
10073 @item @emph{Arguments}:
10074 @multitable @columnfractions .15 .70
10075 @item @var{SOURCE} @tab Shall be a scalar or an array of any type and
10076 a rank less than seven.
10077 @item @var{DIM} @tab Shall be a scalar of type @code{INTEGER} with a
10078 value in the range from 1 to n+1, where n equals the rank of @var{SOURCE}.
10079 @item @var{NCOPIES} @tab Shall be a scalar of type @code{INTEGER}.
10082 @item @emph{Return value}:
10083 The result is an array of the same type as @var{SOURCE} and has rank n+1
10084 where n equals the rank of @var{SOURCE}.
10086 @item @emph{Example}:
10088 PROGRAM test_spread
10089 INTEGER :: a = 1, b(2) = (/ 1, 2 /)
10090 WRITE(*,*) SPREAD(A, 1, 2) ! "1 1"
10091 WRITE(*,*) SPREAD(B, 1, 2) ! "1 1 2 2"
10095 @item @emph{See also}:
10102 @section @code{SQRT} --- Square-root function
10109 @cindex square-root
10112 @item @emph{Description}:
10113 @code{SQRT(X)} computes the square root of @var{X}.
10115 @item @emph{Standard}:
10116 Fortran 77 and later
10118 @item @emph{Class}:
10121 @item @emph{Syntax}:
10122 @code{RESULT = SQRT(X)}
10124 @item @emph{Arguments}:
10125 @multitable @columnfractions .15 .70
10126 @item @var{X} @tab The type shall be @code{REAL} or
10130 @item @emph{Return value}:
10131 The return value is of type @code{REAL} or @code{COMPLEX}.
10132 The kind type parameter is the same as @var{X}.
10134 @item @emph{Example}:
10137 real(8) :: x = 2.0_8
10138 complex :: z = (1.0, 2.0)
10141 end program test_sqrt
10144 @item @emph{Specific names}:
10145 @multitable @columnfractions .20 .20 .20 .25
10146 @item Name @tab Argument @tab Return type @tab Standard
10147 @item @code{DSQRT(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 95 and later
10148 @item @code{CSQRT(X)} @tab @code{COMPLEX(4) X} @tab @code{COMPLEX(4)} @tab Fortran 95 and later
10149 @item @code{ZSQRT(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab GNU extension
10150 @item @code{CDSQRT(X)} @tab @code{COMPLEX(8) X} @tab @code{COMPLEX(8)} @tab GNU extension
10157 @section @code{SRAND} --- Reinitialize the random number generator
10159 @cindex random number generation, seeding
10160 @cindex seeding a random number generator
10163 @item @emph{Description}:
10164 @code{SRAND} reinitializes the pseudo-random number generator
10165 called by @code{RAND} and @code{IRAND}. The new seed used by the
10166 generator is specified by the required argument @var{SEED}.
10168 @item @emph{Standard}:
10171 @item @emph{Class}:
10174 @item @emph{Syntax}:
10175 @code{CALL SRAND(SEED)}
10177 @item @emph{Arguments}:
10178 @multitable @columnfractions .15 .70
10179 @item @var{SEED} @tab Shall be a scalar @code{INTEGER(kind=4)}.
10182 @item @emph{Return value}:
10183 Does not return anything.
10185 @item @emph{Example}:
10186 See @code{RAND} and @code{IRAND} for examples.
10188 @item @emph{Notes}:
10189 The Fortran 2003 standard specifies the intrinsic @code{RANDOM_SEED} to
10190 initialize the pseudo-random numbers generator and @code{RANDOM_NUMBER}
10191 to generate pseudo-random numbers. Please note that in
10192 GNU Fortran, these two sets of intrinsics (@code{RAND},
10193 @code{IRAND} and @code{SRAND} on the one hand, @code{RANDOM_NUMBER} and
10194 @code{RANDOM_SEED} on the other hand) access two independent
10195 pseudo-random number generators.
10197 @item @emph{See also}:
10198 @ref{RAND}, @ref{RANDOM_SEED}, @ref{RANDOM_NUMBER}
10205 @section @code{STAT} --- Get file status
10207 @cindex file system, file status
10210 @item @emph{Description}:
10211 This function returns information about a file. No permissions are required on
10212 the file itself, but execute (search) permission is required on all of the
10213 directories in path that lead to the file.
10215 The elements that are obtained and stored in the array @code{BUFF}:
10216 @multitable @columnfractions .15 .70
10217 @item @code{buff(1)} @tab Device ID
10218 @item @code{buff(2)} @tab Inode number
10219 @item @code{buff(3)} @tab File mode
10220 @item @code{buff(4)} @tab Number of links
10221 @item @code{buff(5)} @tab Owner's uid
10222 @item @code{buff(6)} @tab Owner's gid
10223 @item @code{buff(7)} @tab ID of device containing directory entry for file (0 if not available)
10224 @item @code{buff(8)} @tab File size (bytes)
10225 @item @code{buff(9)} @tab Last access time
10226 @item @code{buff(10)} @tab Last modification time
10227 @item @code{buff(11)} @tab Last file status change time
10228 @item @code{buff(12)} @tab Preferred I/O block size (-1 if not available)
10229 @item @code{buff(13)} @tab Number of blocks allocated (-1 if not available)
10232 Not all these elements are relevant on all systems.
10233 If an element is not relevant, it is returned as 0.
10235 This intrinsic is provided in both subroutine and function forms; however,
10236 only one form can be used in any given program unit.
10238 @item @emph{Standard}:
10241 @item @emph{Class}:
10242 Subroutine, function
10244 @item @emph{Syntax}:
10245 @code{CALL STAT(FILE,BUFF[,STATUS])}
10247 @item @emph{Arguments}:
10248 @multitable @columnfractions .15 .70
10249 @item @var{FILE} @tab The type shall be @code{CHARACTER}, of the
10250 default kind and a valid path within the file system.
10251 @item @var{BUFF} @tab The type shall be @code{INTEGER(4), DIMENSION(13)}.
10252 @item @var{STATUS} @tab (Optional) status flag of type @code{INTEGER(4)}. Returns 0
10253 on success and a system specific error code otherwise.
10256 @item @emph{Example}:
10259 INTEGER, DIMENSION(13) :: buff
10262 CALL STAT("/etc/passwd", buff, status)
10264 IF (status == 0) THEN
10265 WRITE (*, FMT="('Device ID:', T30, I19)") buff(1)
10266 WRITE (*, FMT="('Inode number:', T30, I19)") buff(2)
10267 WRITE (*, FMT="('File mode (octal):', T30, O19)") buff(3)
10268 WRITE (*, FMT="('Number of links:', T30, I19)") buff(4)
10269 WRITE (*, FMT="('Owner''s uid:', T30, I19)") buff(5)
10270 WRITE (*, FMT="('Owner''s gid:', T30, I19)") buff(6)
10271 WRITE (*, FMT="('Device where located:', T30, I19)") buff(7)
10272 WRITE (*, FMT="('File size:', T30, I19)") buff(8)
10273 WRITE (*, FMT="('Last access time:', T30, A19)") CTIME(buff(9))
10274 WRITE (*, FMT="('Last modification time', T30, A19)") CTIME(buff(10))
10275 WRITE (*, FMT="('Last status change time:', T30, A19)") CTIME(buff(11))
10276 WRITE (*, FMT="('Preferred block size:', T30, I19)") buff(12)
10277 WRITE (*, FMT="('No. of blocks allocated:', T30, I19)") buff(13)
10282 @item @emph{See also}:
10283 To stat an open file: @ref{FSTAT}, to stat a link: @ref{LSTAT}
10289 @section @code{SUM} --- Sum of array elements
10292 @cindex array, add elements
10293 @cindex array, conditionally add elements
10294 @cindex sum array elements
10297 @item @emph{Description}:
10298 Adds the elements of @var{ARRAY} along dimension @var{DIM} if
10299 the corresponding element in @var{MASK} is @code{TRUE}.
10301 @item @emph{Standard}:
10302 Fortran 95 and later
10304 @item @emph{Class}:
10305 Transformational function
10307 @item @emph{Syntax}:
10308 @code{RESULT = SUM(ARRAY[, MASK])}
10309 @code{RESULT = SUM(ARRAY, DIM[, MASK])}
10311 @item @emph{Arguments}:
10312 @multitable @columnfractions .15 .70
10313 @item @var{ARRAY} @tab Shall be an array of type @code{INTEGER},
10314 @code{REAL} or @code{COMPLEX}.
10315 @item @var{DIM} @tab (Optional) shall be a scalar of type
10316 @code{INTEGER} with a value in the range from 1 to n, where n
10317 equals the rank of @var{ARRAY}.
10318 @item @var{MASK} @tab (Optional) shall be of type @code{LOGICAL}
10319 and either be a scalar or an array of the same shape as @var{ARRAY}.
10322 @item @emph{Return value}:
10323 The result is of the same type as @var{ARRAY}.
10325 If @var{DIM} is absent, a scalar with the sum of all elements in @var{ARRAY}
10326 is returned. Otherwise, an array of rank n-1, where n equals the rank of
10327 @var{ARRAY},and a shape similar to that of @var{ARRAY} with dimension @var{DIM}
10328 dropped is returned.
10330 @item @emph{Example}:
10333 INTEGER :: x(5) = (/ 1, 2, 3, 4 ,5 /)
10334 print *, SUM(x) ! all elements, sum = 15
10335 print *, SUM(x, MASK=MOD(x, 2)==1) ! odd elements, sum = 9
10339 @item @emph{See also}:
10346 @section @code{SYMLNK} --- Create a symbolic link
10348 @cindex file system, create link
10349 @cindex file system, soft link
10352 @item @emph{Description}:
10353 Makes a symbolic link from file @var{PATH1} to @var{PATH2}. A null
10354 character (@code{CHAR(0)}) can be used to mark the end of the names in
10355 @var{PATH1} and @var{PATH2}; otherwise, trailing blanks in the file
10356 names are ignored. If the @var{STATUS} argument is supplied, it
10357 contains 0 on success or a nonzero error code upon return; see
10358 @code{symlink(2)}. If the system does not supply @code{symlink(2)},
10359 @code{ENOSYS} is returned.
10361 This intrinsic is provided in both subroutine and function forms;
10362 however, only one form can be used in any given program unit.
10364 @item @emph{Standard}:
10367 @item @emph{Class}:
10368 Subroutine, function
10370 @item @emph{Syntax}:
10371 @multitable @columnfractions .80
10372 @item @code{CALL SYMLNK(PATH1, PATH2 [, STATUS])}
10373 @item @code{STATUS = SYMLNK(PATH1, PATH2)}
10376 @item @emph{Arguments}:
10377 @multitable @columnfractions .15 .70
10378 @item @var{PATH1} @tab Shall be of default @code{CHARACTER} type.
10379 @item @var{PATH2} @tab Shall be of default @code{CHARACTER} type.
10380 @item @var{STATUS} @tab (Optional) Shall be of default @code{INTEGER} type.
10383 @item @emph{See also}:
10384 @ref{LINK}, @ref{UNLINK}
10391 @section @code{SYSTEM} --- Execute a shell command
10393 @cindex system, system call
10396 @item @emph{Description}:
10397 Passes the command @var{COMMAND} to a shell (see @code{system(3)}). If
10398 argument @var{STATUS} is present, it contains the value returned by
10399 @code{system(3)}, which is presumably 0 if the shell command succeeded.
10400 Note that which shell is used to invoke the command is system-dependent
10401 and environment-dependent.
10403 This intrinsic is provided in both subroutine and function forms;
10404 however, only one form can be used in any given program unit.
10406 @item @emph{Standard}:
10409 @item @emph{Class}:
10410 Subroutine, function
10412 @item @emph{Syntax}:
10413 @multitable @columnfractions .80
10414 @item @code{CALL SYSTEM(COMMAND [, STATUS])}
10415 @item @code{STATUS = SYSTEM(COMMAND)}
10418 @item @emph{Arguments}:
10419 @multitable @columnfractions .15 .70
10420 @item @var{COMMAND} @tab Shall be of default @code{CHARACTER} type.
10421 @item @var{STATUS} @tab (Optional) Shall be of default @code{INTEGER} type.
10424 @item @emph{See also}:
10430 @section @code{SYSTEM_CLOCK} --- Time function
10431 @fnindex SYSTEM_CLOCK
10432 @cindex time, clock ticks
10433 @cindex clock ticks
10436 @item @emph{Description}:
10437 Determines the @var{COUNT} of milliseconds of wall clock time since
10438 the Epoch (00:00:00 UTC, January 1, 1970) modulo @var{COUNT_MAX},
10439 @var{COUNT_RATE} determines the number of clock ticks per second.
10440 @var{COUNT_RATE} and @var{COUNT_MAX} are constant and specific to
10441 @command{gfortran}.
10443 If there is no clock, @var{COUNT} is set to @code{-HUGE(COUNT)}, and
10444 @var{COUNT_RATE} and @var{COUNT_MAX} are set to zero
10446 @item @emph{Standard}:
10447 Fortran 95 and later
10449 @item @emph{Class}:
10452 @item @emph{Syntax}:
10453 @code{CALL SYSTEM_CLOCK([COUNT, COUNT_RATE, COUNT_MAX])}
10455 @item @emph{Arguments}:
10456 @item @emph{Arguments}:
10457 @multitable @columnfractions .15 .70
10458 @item @var{COUNT} @tab (Optional) shall be a scalar of type default
10459 @code{INTEGER} with @code{INTENT(OUT)}.
10460 @item @var{COUNT_RATE} @tab (Optional) shall be a scalar of type default
10461 @code{INTEGER} with @code{INTENT(OUT)}.
10462 @item @var{COUNT_MAX} @tab (Optional) shall be a scalar of type default
10463 @code{INTEGER} with @code{INTENT(OUT)}.
10466 @item @emph{Example}:
10468 PROGRAM test_system_clock
10469 INTEGER :: count, count_rate, count_max
10470 CALL SYSTEM_CLOCK(count, count_rate, count_max)
10471 WRITE(*,*) count, count_rate, count_max
10475 @item @emph{See also}:
10476 @ref{DATE_AND_TIME}, @ref{CPU_TIME}
10482 @section @code{TAN} --- Tangent function
10485 @cindex trigonometric function, tangent
10489 @item @emph{Description}:
10490 @code{TAN(X)} computes the tangent of @var{X}.
10492 @item @emph{Standard}:
10493 Fortran 77 and later
10495 @item @emph{Class}:
10498 @item @emph{Syntax}:
10499 @code{RESULT = TAN(X)}
10501 @item @emph{Arguments}:
10502 @multitable @columnfractions .15 .70
10503 @item @var{X} @tab The type shall be @code{REAL}.
10506 @item @emph{Return value}:
10507 The return value is of type @code{REAL}. The kind type parameter is
10508 the same as @var{X}.
10510 @item @emph{Example}:
10513 real(8) :: x = 0.165_8
10515 end program test_tan
10518 @item @emph{Specific names}:
10519 @multitable @columnfractions .20 .20 .20 .25
10520 @item Name @tab Argument @tab Return type @tab Standard
10521 @item @code{DTAN(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 95 and later
10524 @item @emph{See also}:
10531 @section @code{TANH} --- Hyperbolic tangent function
10534 @cindex hyperbolic tangent
10535 @cindex hyperbolic function, tangent
10536 @cindex tangent, hyperbolic
10539 @item @emph{Description}:
10540 @code{TANH(X)} computes the hyperbolic tangent of @var{X}.
10542 @item @emph{Standard}:
10543 Fortran 77 and later
10545 @item @emph{Class}:
10548 @item @emph{Syntax}:
10551 @item @emph{Arguments}:
10552 @multitable @columnfractions .15 .70
10553 @item @var{X} @tab The type shall be @code{REAL}.
10556 @item @emph{Return value}:
10557 The return value is of type @code{REAL} and lies in the range
10558 @math{ - 1 \leq tanh(x) \leq 1 }.
10560 @item @emph{Example}:
10563 real(8) :: x = 2.1_8
10565 end program test_tanh
10568 @item @emph{Specific names}:
10569 @multitable @columnfractions .20 .20 .20 .25
10570 @item Name @tab Argument @tab Return type @tab Standard
10571 @item @code{DTANH(X)} @tab @code{REAL(8) X} @tab @code{REAL(8)} @tab Fortran 95 and later
10574 @item @emph{See also}:
10581 @section @code{TIME} --- Time function
10583 @cindex time, current
10584 @cindex current time
10587 @item @emph{Description}:
10588 Returns the current time encoded as an integer (in the manner of the
10589 UNIX function @code{time(3)}). This value is suitable for passing to
10590 @code{CTIME()}, @code{GMTIME()}, and @code{LTIME()}.
10592 This intrinsic is not fully portable, such as to systems with 32-bit
10593 @code{INTEGER} types but supporting times wider than 32 bits. Therefore,
10594 the values returned by this intrinsic might be, or become, negative, or
10595 numerically less than previous values, during a single run of the
10598 See @ref{TIME8}, for information on a similar intrinsic that might be
10599 portable to more GNU Fortran implementations, though to fewer Fortran
10602 @item @emph{Standard}:
10605 @item @emph{Class}:
10608 @item @emph{Syntax}:
10609 @code{RESULT = TIME()}
10611 @item @emph{Return value}:
10612 The return value is a scalar of type @code{INTEGER(4)}.
10614 @item @emph{See also}:
10615 @ref{CTIME}, @ref{GMTIME}, @ref{LTIME}, @ref{MCLOCK}, @ref{TIME8}
10622 @section @code{TIME8} --- Time function (64-bit)
10624 @cindex time, current
10625 @cindex current time
10628 @item @emph{Description}:
10629 Returns the current time encoded as an integer (in the manner of the
10630 UNIX function @code{time(3)}). This value is suitable for passing to
10631 @code{CTIME()}, @code{GMTIME()}, and @code{LTIME()}.
10633 @emph{Warning:} this intrinsic does not increase the range of the timing
10634 values over that returned by @code{time(3)}. On a system with a 32-bit
10635 @code{time(3)}, @code{TIME8()} will return a 32-bit value, even though
10636 it is converted to a 64-bit @code{INTEGER(8)} value. That means
10637 overflows of the 32-bit value can still occur. Therefore, the values
10638 returned by this intrinsic might be or become negative or numerically
10639 less than previous values during a single run of the compiled program.
10641 @item @emph{Standard}:
10644 @item @emph{Class}:
10647 @item @emph{Syntax}:
10648 @code{RESULT = TIME8()}
10650 @item @emph{Return value}:
10651 The return value is a scalar of type @code{INTEGER(8)}.
10653 @item @emph{See also}:
10654 @ref{CTIME}, @ref{GMTIME}, @ref{LTIME}, @ref{MCLOCK8}, @ref{TIME}
10661 @section @code{TINY} --- Smallest positive number of a real kind
10663 @cindex limits, smallest number
10664 @cindex model representation, smallest number
10667 @item @emph{Description}:
10668 @code{TINY(X)} returns the smallest positive (non zero) number
10669 in the model of the type of @code{X}.
10671 @item @emph{Standard}:
10672 Fortran 95 and later
10674 @item @emph{Class}:
10677 @item @emph{Syntax}:
10678 @code{RESULT = TINY(X)}
10680 @item @emph{Arguments}:
10681 @multitable @columnfractions .15 .70
10682 @item @var{X} @tab Shall be of type @code{REAL}.
10685 @item @emph{Return value}:
10686 The return value is of the same type and kind as @var{X}
10688 @item @emph{Example}:
10689 See @code{HUGE} for an example.
10695 @section @code{TRAILZ} --- Number of trailing zero bits of an integer
10700 @item @emph{Description}:
10701 @code{TRAILZ} returns the number of trailing zero bits of an integer.
10703 @item @emph{Standard}:
10704 Fortran 2008 and later
10706 @item @emph{Class}:
10709 @item @emph{Syntax}:
10710 @code{RESULT = TRAILZ(I)}
10712 @item @emph{Arguments}:
10713 @multitable @columnfractions .15 .70
10714 @item @var{I} @tab Shall be of type @code{INTEGER}.
10717 @item @emph{Return value}:
10718 The type of the return value is the default @code{INTEGER}.
10719 If all the bits of @code{I} are zero, the result value is @code{BIT_SIZE(I)}.
10721 @item @emph{Example}:
10723 PROGRAM test_trailz
10724 WRITE (*,*) TRAILZ(8) ! prints 3
10728 @item @emph{See also}:
10729 @ref{BIT_SIZE}, @ref{LEADZ}
10735 @section @code{TRANSFER} --- Transfer bit patterns
10741 @item @emph{Description}:
10742 Interprets the bitwise representation of @var{SOURCE} in memory as if it
10743 is the representation of a variable or array of the same type and type
10744 parameters as @var{MOLD}.
10746 This is approximately equivalent to the C concept of @emph{casting} one
10749 @item @emph{Standard}:
10750 Fortran 95 and later
10752 @item @emph{Class}:
10753 Transformational function
10755 @item @emph{Syntax}:
10756 @code{RESULT = TRANSFER(SOURCE, MOLD[, SIZE])}
10758 @item @emph{Arguments}:
10759 @multitable @columnfractions .15 .70
10760 @item @var{SOURCE} @tab Shall be a scalar or an array of any type.
10761 @item @var{MOLD} @tab Shall be a scalar or an array of any type.
10762 @item @var{SIZE} @tab (Optional) shall be a scalar of type
10766 @item @emph{Return value}:
10767 The result has the same type as @var{MOLD}, with the bit level
10768 representation of @var{SOURCE}. If @var{SIZE} is present, the result is
10769 a one-dimensional array of length @var{SIZE}. If @var{SIZE} is absent
10770 but @var{MOLD} is an array (of any size or shape), the result is a one-
10771 dimensional array of the minimum length needed to contain the entirety
10772 of the bitwise representation of @var{SOURCE}. If @var{SIZE} is absent
10773 and @var{MOLD} is a scalar, the result is a scalar.
10775 If the bitwise representation of the result is longer than that of
10776 @var{SOURCE}, then the leading bits of the result correspond to those of
10777 @var{SOURCE} and any trailing bits are filled arbitrarily.
10779 When the resulting bit representation does not correspond to a valid
10780 representation of a variable of the same type as @var{MOLD}, the results
10781 are undefined, and subsequent operations on the result cannot be
10782 guaranteed to produce sensible behavior. For example, it is possible to
10783 create @code{LOGICAL} variables for which @code{@var{VAR}} and
10784 @code{.NOT.@var{VAR}} both appear to be true.
10786 @item @emph{Example}:
10788 PROGRAM test_transfer
10789 integer :: x = 2143289344
10790 print *, transfer(x, 1.0) ! prints "NaN" on i686
10798 @section @code{TRANSPOSE} --- Transpose an array of rank two
10800 @cindex array, transpose
10801 @cindex matrix, transpose
10805 @item @emph{Description}:
10806 Transpose an array of rank two. Element (i, j) of the result has the value
10807 @code{MATRIX(j, i)}, for all i, j.
10809 @item @emph{Standard}:
10810 Fortran 95 and later
10812 @item @emph{Class}:
10813 Transformational function
10815 @item @emph{Syntax}:
10816 @code{RESULT = TRANSPOSE(MATRIX)}
10818 @item @emph{Arguments}:
10819 @multitable @columnfractions .15 .70
10820 @item @var{MATRIX} @tab Shall be an array of any type and have a rank of two.
10823 @item @emph{Return value}:
10824 The result has the same type as @var{MATRIX}, and has shape
10825 @code{(/ m, n /)} if @var{MATRIX} has shape @code{(/ n, m /)}.
10831 @section @code{TRIM} --- Remove trailing blank characters of a string
10833 @cindex string, remove trailing whitespace
10836 @item @emph{Description}:
10837 Removes trailing blank characters of a string.
10839 @item @emph{Standard}:
10840 Fortran 95 and later
10842 @item @emph{Class}:
10843 Transformational function
10845 @item @emph{Syntax}:
10846 @code{RESULT = TRIM(STRING)}
10848 @item @emph{Arguments}:
10849 @multitable @columnfractions .15 .70
10850 @item @var{STRING} @tab Shall be a scalar of type @code{CHARACTER}.
10853 @item @emph{Return value}:
10854 A scalar of type @code{CHARACTER} which length is that of @var{STRING}
10855 less the number of trailing blanks.
10857 @item @emph{Example}:
10860 CHARACTER(len=10), PARAMETER :: s = "GFORTRAN "
10861 WRITE(*,*) LEN(s), LEN(TRIM(s)) ! "10 8", with/without trailing blanks
10865 @item @emph{See also}:
10866 @ref{ADJUSTL}, @ref{ADJUSTR}
10872 @section @code{TTYNAM} --- Get the name of a terminal device.
10874 @cindex system, terminal
10877 @item @emph{Description}:
10878 Get the name of a terminal device. For more information,
10879 see @code{ttyname(3)}.
10881 This intrinsic is provided in both subroutine and function forms;
10882 however, only one form can be used in any given program unit.
10884 @item @emph{Standard}:
10887 @item @emph{Class}:
10888 Subroutine, function
10890 @item @emph{Syntax}:
10891 @multitable @columnfractions .80
10892 @item @code{CALL TTYNAM(UNIT, NAME)}
10893 @item @code{NAME = TTYNAM(UNIT)}
10896 @item @emph{Arguments}:
10897 @multitable @columnfractions .15 .70
10898 @item @var{UNIT} @tab Shall be a scalar @code{INTEGER}.
10899 @item @var{NAME} @tab Shall be of type @code{CHARACTER}.
10902 @item @emph{Example}:
10904 PROGRAM test_ttynam
10907 IF (isatty(unit=unit)) write(*,*) ttynam(unit)
10912 @item @emph{See also}:
10919 @section @code{UBOUND} --- Upper dimension bounds of an array
10921 @cindex array, upper bound
10924 @item @emph{Description}:
10925 Returns the upper bounds of an array, or a single upper bound
10926 along the @var{DIM} dimension.
10927 @item @emph{Standard}:
10928 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
10930 @item @emph{Class}:
10933 @item @emph{Syntax}:
10934 @code{RESULT = UBOUND(ARRAY [, DIM [, KIND]])}
10936 @item @emph{Arguments}:
10937 @multitable @columnfractions .15 .70
10938 @item @var{ARRAY} @tab Shall be an array, of any type.
10939 @item @var{DIM} @tab (Optional) Shall be a scalar @code{INTEGER}.
10940 @item @var{KIND}@tab (Optional) An @code{INTEGER} initialization
10941 expression indicating the kind parameter of the result.
10944 @item @emph{Return value}:
10945 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
10946 @var{KIND} is absent, the return value is of default integer kind.
10947 If @var{DIM} is absent, the result is an array of the upper bounds of
10948 @var{ARRAY}. If @var{DIM} is present, the result is a scalar
10949 corresponding to the upper bound of the array along that dimension. If
10950 @var{ARRAY} is an expression rather than a whole array or array
10951 structure component, or if it has a zero extent along the relevant
10952 dimension, the upper bound is taken to be the number of elements along
10953 the relevant dimension.
10955 @item @emph{See also}:
10962 @section @code{UMASK} --- Set the file creation mask
10964 @cindex file system, file creation mask
10967 @item @emph{Description}:
10968 Sets the file creation mask to @var{MASK} and returns the old value in
10969 argument @var{OLD} if it is supplied. See @code{umask(2)}.
10971 @item @emph{Standard}:
10974 @item @emph{Class}:
10977 @item @emph{Syntax}:
10978 @code{CALL UMASK(MASK [, OLD])}
10980 @item @emph{Arguments}:
10981 @multitable @columnfractions .15 .70
10982 @item @var{MASK} @tab Shall be a scalar of type @code{INTEGER}.
10983 @item @var{MASK} @tab (Optional) Shall be a scalar of type
10992 @section @code{UNLINK} --- Remove a file from the file system
10994 @cindex file system, remove file
10997 @item @emph{Description}:
10998 Unlinks the file @var{PATH}. A null character (@code{CHAR(0)}) can be
10999 used to mark the end of the name in @var{PATH}; otherwise, trailing
11000 blanks in the file name are ignored. If the @var{STATUS} argument is
11001 supplied, it contains 0 on success or a nonzero error code upon return;
11002 see @code{unlink(2)}.
11004 This intrinsic is provided in both subroutine and function forms;
11005 however, only one form can be used in any given program unit.
11007 @item @emph{Standard}:
11010 @item @emph{Class}:
11011 Subroutine, function
11013 @item @emph{Syntax}:
11014 @multitable @columnfractions .80
11015 @item @code{CALL UNLINK(PATH [, STATUS])}
11016 @item @code{STATUS = UNLINK(PATH)}
11019 @item @emph{Arguments}:
11020 @multitable @columnfractions .15 .70
11021 @item @var{PATH} @tab Shall be of default @code{CHARACTER} type.
11022 @item @var{STATUS} @tab (Optional) Shall be of default @code{INTEGER} type.
11025 @item @emph{See also}:
11026 @ref{LINK}, @ref{SYMLNK}
11032 @section @code{UNPACK} --- Unpack an array of rank one into an array
11034 @cindex array, unpacking
11035 @cindex array, increase dimension
11036 @cindex array, scatter elements
11039 @item @emph{Description}:
11040 Store the elements of @var{VECTOR} in an array of higher rank.
11042 @item @emph{Standard}:
11043 Fortran 95 and later
11045 @item @emph{Class}:
11046 Transformational function
11048 @item @emph{Syntax}:
11049 @code{RESULT = UNPACK(VECTOR, MASK, FIELD)}
11051 @item @emph{Arguments}:
11052 @multitable @columnfractions .15 .70
11053 @item @var{VECTOR} @tab Shall be an array of any type and rank one. It
11054 shall have at least as many elements as @var{MASK} has @code{TRUE} values.
11055 @item @var{MASK} @tab Shall be an array of type @code{LOGICAL}.
11056 @item @var{FIELD} @tab Shall be of the same type as @var{VECTOR} and have
11057 the same shape as @var{MASK}.
11060 @item @emph{Return value}:
11061 The resulting array corresponds to @var{FIELD} with @code{TRUE} elements
11062 of @var{MASK} replaced by values from @var{VECTOR} in array element order.
11064 @item @emph{Example}:
11066 PROGRAM test_unpack
11067 integer :: vector(2) = (/1,1/)
11068 logical :: mask(4) = (/ .TRUE., .FALSE., .FALSE., .TRUE. /)
11069 integer :: field(2,2) = 0, unity(2,2)
11071 ! result: unity matrix
11072 unity = unpack(vector, reshape(mask, (/2,2/)), field)
11076 @item @emph{See also}:
11077 @ref{PACK}, @ref{SPREAD}
11083 @section @code{VERIFY} --- Scan a string for the absence of a set of characters
11085 @cindex string, find missing set
11088 @item @emph{Description}:
11089 Verifies that all the characters in a @var{SET} are present in a @var{STRING}.
11091 If @var{BACK} is either absent or equals @code{FALSE}, this function
11092 returns the position of the leftmost character of @var{STRING} that is
11093 not in @var{SET}. If @var{BACK} equals @code{TRUE}, the rightmost position
11094 is returned. If all characters of @var{SET} are found in @var{STRING}, the
11097 @item @emph{Standard}:
11098 Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later
11100 @item @emph{Class}:
11103 @item @emph{Syntax}:
11104 @code{RESULT = VERIFY(STRING, SET[, BACK [, KIND]])}
11106 @item @emph{Arguments}:
11107 @multitable @columnfractions .15 .70
11108 @item @var{STRING} @tab Shall be of type @code{CHARACTER}.
11109 @item @var{SET} @tab Shall be of type @code{CHARACTER}.
11110 @item @var{BACK} @tab (Optional) shall be of type @code{LOGICAL}.
11111 @item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
11112 expression indicating the kind parameter of the result.
11115 @item @emph{Return value}:
11116 The return value is of type @code{INTEGER} and of kind @var{KIND}. If
11117 @var{KIND} is absent, the return value is of default integer kind.
11119 @item @emph{Example}:
11121 PROGRAM test_verify
11122 WRITE(*,*) VERIFY("FORTRAN", "AO") ! 1, found 'F'
11123 WRITE(*,*) VERIFY("FORTRAN", "FOO") ! 3, found 'R'
11124 WRITE(*,*) VERIFY("FORTRAN", "C++") ! 1, found 'F'
11125 WRITE(*,*) VERIFY("FORTRAN", "C++", .TRUE.) ! 7, found 'N'
11126 WRITE(*,*) VERIFY("FORTRAN", "FORTRAN") ! 0' found none
11130 @item @emph{See also}:
11131 @ref{SCAN}, @ref{INDEX intrinsic}
11137 @section @code{XOR} --- Bitwise logical exclusive OR
11139 @cindex bitwise logical exclusive or
11140 @cindex logical exclusive or, bitwise
11143 @item @emph{Description}:
11144 Bitwise logical exclusive or.
11146 This intrinsic routine is provided for backwards compatibility with
11147 GNU Fortran 77. For integer arguments, programmers should consider
11148 the use of the @ref{IEOR} intrinsic defined by the Fortran standard.
11150 @item @emph{Standard}:
11153 @item @emph{Class}:
11156 @item @emph{Syntax}:
11157 @code{RESULT = XOR(X, Y)}
11159 @item @emph{Arguments}:
11160 @multitable @columnfractions .15 .70
11161 @item @var{X} @tab The type shall be either a scalar @code{INTEGER}
11162 type or a scalar @code{LOGICAL} type.
11163 @item @var{Y} @tab The type shall be the same as the type of @var{I}.
11166 @item @emph{Return value}:
11167 The return type is either a scalar @code{INTEGER} or a scalar
11168 @code{LOGICAL}. If the kind type parameters differ, then the
11169 smaller kind type is implicitly converted to larger kind, and the
11170 return has the larger kind.
11172 @item @emph{Example}:
11175 LOGICAL :: T = .TRUE., F = .FALSE.
11177 DATA a / Z'F' /, b / Z'3' /
11179 WRITE (*,*) XOR(T, T), XOR(T, F), XOR(F, T), XOR(F, F)
11180 WRITE (*,*) XOR(a, b)
11184 @item @emph{See also}:
11185 Fortran 95 elemental function: @ref{IEOR}
11190 @node Intrinsic Modules
11191 @chapter Intrinsic Modules
11192 @cindex intrinsic Modules
11194 @c @node ISO_FORTRAN_ENV
11195 @section @code{ISO_FORTRAN_ENV}
11197 @item @emph{Standard}:
11198 Fortran 2003 and later
11201 The @code{ISO_FORTRAN_ENV} module provides the following scalar default-integer
11205 @item @code{CHARACTER_STORAGE_SIZE}:
11206 Size in bits of the character storage unit.
11208 @item @code{ERROR_UNIT}:
11209 Identifies the preconnected unit used for error reporting.
11211 @item @code{FILE_STORAGE_SIZE}:
11212 Size in bits of the file-storage unit.
11214 @item @code{INPUT_UNIT}:
11215 Identifies the preconnected unit identified by the asterisk
11216 (@code{*}) in @code{READ} statement.
11218 @item @code{IOSTAT_END}:
11219 The value assigned to the variable passed to the IOSTAT= specifier of
11220 an input/output statement if an end-of-file condition occurred.
11222 @item @code{IOSTAT_EOR}:
11223 The value assigned to the variable passed to the IOSTAT= specifier of
11224 an input/output statement if an end-of-record condition occurred.
11226 @item @code{NUMERIC_STORAGE_SIZE}:
11227 The size in bits of the numeric storage unit.
11229 @item @code{OUTPUT_UNIT}:
11230 Identifies the preconnected unit identified by the asterisk
11231 (@code{*}) in @code{WRITE} statement.
11234 @c @node ISO_C_BINDING
11235 @section @code{ISO_C_BINDING}
11237 @item @emph{Standard}:
11238 Fortran 2003 and later, GNU extensions
11241 The following intrinsic procedures are provided by the module; their
11242 definition can be found in the section Intrinsic Procedures of this
11246 @item @code{C_ASSOCIATED}
11247 @item @code{C_F_POINTER}
11248 @item @code{C_F_PROCPOINTER}
11249 @item @code{C_FUNLOC}
11252 @c TODO: Vertical spacing between C_FUNLOC and C_LOC wrong in PDF,
11253 @c don't really know why.
11255 The @code{ISO_C_BINDING} module provides the following named constants of the
11256 type integer, which can be used as KIND type parameter. Note that GNU
11257 Fortran currently does not support the @code{C_INT_FAST...} KIND type
11258 parameters (marked by an asterisk (@code{*}) in the list below).
11259 The @code{C_INT_FAST...} parameters have therefore the value @math{-2}
11260 and cannot be used as KIND type parameter of the @code{INTEGER} type.
11262 In addition to the integer named constants required by the Fortran 2003
11263 standard, GNU Fortran provides as an extension named constants for the
11264 128-bit integer types supported by the C compiler: @code{C_INT128_T,
11265 C_INT_LEAST128_T, C_INT_FAST128_T}.
11267 @multitable @columnfractions .15 .35 .35 .35
11268 @item Fortran Type @tab Named constant @tab C type @tab Extension
11269 @item @code{INTEGER}@tab @code{C_INT} @tab @code{int}
11270 @item @code{INTEGER}@tab @code{C_SHORT} @tab @code{short int}
11271 @item @code{INTEGER}@tab @code{C_LONG} @tab @code{long int}
11272 @item @code{INTEGER}@tab @code{C_LONG_LONG} @tab @code{long long int}
11273 @item @code{INTEGER}@tab @code{C_SIGNED_CHAR} @tab @code{signed char}/@code{unsigned char}
11274 @item @code{INTEGER}@tab @code{C_SIZE_T} @tab @code{size_t}
11275 @item @code{INTEGER}@tab @code{C_INT8_T} @tab @code{int8_t}
11276 @item @code{INTEGER}@tab @code{C_INT16_T} @tab @code{int16_t}
11277 @item @code{INTEGER}@tab @code{C_INT32_T} @tab @code{int32_t}
11278 @item @code{INTEGER}@tab @code{C_INT64_T} @tab @code{int64_t}
11279 @item @code{INTEGER}@tab @code{C_INT128_T} @tab @code{int128_t} @tab Ext.
11280 @item @code{INTEGER}@tab @code{C_INT_LEAST8_T} @tab @code{int_least8_t}
11281 @item @code{INTEGER}@tab @code{C_INT_LEAST16_T} @tab @code{int_least16_t}
11282 @item @code{INTEGER}@tab @code{C_INT_LEAST32_T} @tab @code{int_least32_t}
11283 @item @code{INTEGER}@tab @code{C_INT_LEAST64_T} @tab @code{int_least64_t}
11284 @item @code{INTEGER}@tab @code{C_INT_LEAST128_T} @tab @code{int_least128_t} @tab Ext.
11285 @item @code{INTEGER}@tab @code{C_INT_FAST8_T}* @tab @code{int_fast8_t}
11286 @item @code{INTEGER}@tab @code{C_INT_FAST16_T}* @tab @code{int_fast16_t}
11287 @item @code{INTEGER}@tab @code{C_INT_FAST32_T}* @tab @code{int_fast32_t}
11288 @item @code{INTEGER}@tab @code{C_INT_FAST64_T}* @tab @code{int_fast64_t}
11289 @item @code{INTEGER}@tab @code{C_INT_FAST128_T}* @tab @code{int_fast128_t} @tab Ext.
11290 @item @code{INTEGER}@tab @code{C_INTMAX_T} @tab @code{intmax_t}
11291 @item @code{INTEGER}@tab @code{C_INTPTR_T} @tab @code{intptr_t}
11292 @item @code{REAL} @tab @code{C_FLOAT} @tab @code{float}
11293 @item @code{REAL} @tab @code{C_DOUBLE} @tab @code{double}
11294 @item @code{REAL} @tab @code{C_LONG_DOUBLE} @tab @code{long double}
11295 @item @code{COMPLEX}@tab @code{C_FLOAT_COMPLEX} @tab @code{float _Complex}
11296 @item @code{COMPLEX}@tab @code{C_DOUBLE_COMPLEX}@tab @code{double _Complex}
11297 @item @code{COMPLEX}@tab @code{C_LONG_DOUBLE_COMPLEX}@tab @code{long double _Complex}
11298 @item @code{LOGICAL}@tab @code{C_BOOL} @tab @code{_Bool}
11299 @item @code{CHARACTER}@tab @code{C_CHAR} @tab @code{char}
11302 Additionally, the following @code{(CHARACTER(KIND=C_CHAR))} are
11305 @multitable @columnfractions .20 .45 .15
11306 @item Name @tab C definition @tab Value
11307 @item @code{C_NULL_CHAR} @tab null character @tab @code{'\0'}
11308 @item @code{C_ALERT} @tab alert @tab @code{'\a'}
11309 @item @code{C_BACKSPACE} @tab backspace @tab @code{'\b'}
11310 @item @code{C_FORM_FEED} @tab form feed @tab @code{'\f'}
11311 @item @code{C_NEW_LINE} @tab new line @tab @code{'\n'}
11312 @item @code{C_CARRIAGE_RETURN} @tab carriage return @tab @code{'\r'}
11313 @item @code{C_HORIZONTAL_TAB} @tab horizontal tab @tab @code{'\t'}
11314 @item @code{C_VERTICAL_TAB} @tab vertical tab @tab @code{'\v'}
11317 @c @node OpenMP Modules OMP_LIB and OMP_LIB_KINDS
11318 @section OpenMP Modules @code{OMP_LIB} and @code{OMP_LIB_KINDS}
11320 @item @emph{Standard}:
11321 OpenMP Application Program Interface v3.0
11325 The OpenMP Fortran runtime library routines are provided both in
11326 a form of two Fortran 90 modules, named @code{OMP_LIB} and
11327 @code{OMP_LIB_KINDS}, and in a form of a Fortran @code{include} file named
11328 @file{omp_lib.h}. The procedures provided by @code{OMP_LIB} can be found
11329 in the @ref{Top,,Introduction,libgomp,GNU OpenMP runtime library} manual,
11330 the named constants defined in the @code{OMP_LIB_KINDS} module are listed
11333 For details refer to the actual
11334 @uref{http://www.openmp.org/mp-documents/spec30.pdf,
11335 OpenMP Application Program Interface v3.0}.
11337 @code{OMP_LIB_KINDS} provides the following scalar default-integer
11341 @item @code{omp_integer_kind}
11342 @item @code{omp_logical_kind}
11343 @item @code{omp_lock_kind}
11344 @item @code{omp_nest_lock_kind}
11345 @item @code{omp_sched_kind}