diff options
Diffstat (limited to 'gcc/fortran/intrinsic.texi')
| -rw-r--r-- | gcc/fortran/intrinsic.texi | 87 |
1 files changed, 59 insertions, 28 deletions
diff --git a/gcc/fortran/intrinsic.texi b/gcc/fortran/intrinsic.texi index d2b3b94dd38..5c7d4630aaf 100644 --- a/gcc/fortran/intrinsic.texi +++ b/gcc/fortran/intrinsic.texi @@ -143,7 +143,7 @@ Some basic guidelines for editing this document: * @code{GMTIME}: GMTIME, Convert time to GMT info * @code{HOSTNM}: HOSTNM, Get system host name * @code{HUGE}: HUGE, Largest number of a kind -* @code{HYPOT}: HYPOT, Euclidian distance function +* @code{HYPOT}: HYPOT, Euclidean distance function * @code{IACHAR}: IACHAR, Code in @acronym{ASCII} collating sequence * @code{IALL}: IALL, Bitwise AND of array elements * @code{IAND}: IAND, Bitwise logical and @@ -156,7 +156,7 @@ Some basic guidelines for editing this document: * @code{IDATE}: IDATE, Current local time (day/month/year) * @code{IEOR}: IEOR, Bitwise logical exclusive or * @code{IERRNO}: IERRNO, Function to get the last system error number -* @code{IMAGE_INDEX}: IMAGE_INDEX, Cosubscript to image index convertion +* @code{IMAGE_INDEX}: IMAGE_INDEX, Cosubscript to image index conversion * @code{INDEX}: INDEX intrinsic, Position of a substring within a string * @code{INT}: INT, Convert to integer type * @code{INT2}: INT2, Convert to 16-bit integer type @@ -1443,7 +1443,7 @@ Inverse function: @ref{TAN} @item @emph{Description}: @code{ATAN2(Y, X)} computes the principal value of the argument function of the complex number @math{X + i Y}. This function can -be used to transform from carthesian into polar coordinates and +be used to transform from Cartesian into polar coordinates and allows to determine the angle in the correct quadrant. @item @emph{Standard}: @@ -1660,7 +1660,7 @@ of the first kind of the orders @var{N1} to @var{N2}. Fortran 2008 and later, negative @var{N} is allowed as GNU extension @item @emph{Class}: -Elemental function, except for the tranformational function +Elemental function, except for the transformational function @code{BESSEL_JN(N1, N2, X)} @item @emph{Syntax}: @@ -1820,7 +1820,7 @@ of the first kind of the orders @var{N1} to @var{N2}. Fortran 2008 and later, negative @var{N} is allowed as GNU extension @item @emph{Class}: -Elemental function, except for the tranformational function +Elemental function, except for the transformational function @code{BESSEL_YN(N1, N2, X)} @item @emph{Syntax}: @@ -4114,7 +4114,7 @@ end program test_exec @item @emph{Note}: Because this intrinsic is implemented in terms of the @code{system()} -function call, its behavior with respect to signalling is processor +function call, its behavior with respect to signaling is processor dependent. In particular, on POSIX-compliant systems, the SIGINT and SIGQUIT signals will be ignored, and the SIGCHLD will be blocked. As such, if the parent process is terminated, the child process might not be @@ -5464,7 +5464,7 @@ END PROGRAM @node GETGID @section @code{GETGID} --- Group ID function @fnindex GETGID -@cindex system, group id +@cindex system, group ID @table @asis @item @emph{Description}: @@ -5541,8 +5541,8 @@ END PROGRAM @node GETPID @section @code{GETPID} --- Process ID function @fnindex GETPID -@cindex system, process id -@cindex process id +@cindex system, process ID +@cindex process ID @table @asis @item @emph{Description}: @@ -5580,7 +5580,7 @@ end program info @node GETUID @section @code{GETUID} --- User ID function @fnindex GETUID -@cindex system, user id +@cindex system, user ID @cindex user id @table @asis @@ -6169,7 +6169,7 @@ The correspondence between characters and their codes is not necessarily the same across different GNU Fortran implementations. @item @emph{Standard}: -Fortan 95 and later, with @var{KIND} argument Fortran 2003 and later +Fortran 95 and later, with @var{KIND} argument Fortran 2003 and later @item @emph{Class}: Elemental function @@ -6285,7 +6285,7 @@ end program test_idate @table @asis @item @emph{Description}: -@code{IEOR} returns the bitwise boolean exclusive-OR of @var{I} and +@code{IEOR} returns the bitwise Boolean exclusive-OR of @var{I} and @var{J}. @item @emph{Standard}: @@ -6351,7 +6351,7 @@ kind. @node IMAGE_INDEX @section @code{IMAGE_INDEX} --- Function that converts a cosubscript to an image index @fnindex IMAGE_INDEX -@cindex coarray, IMAGE_INDEX +@cindex coarray, @code{IMAGE_INDEX} @cindex images, cosubscript to image index conversion @table @asis @@ -6588,7 +6588,7 @@ The return value is a @code{INTEGER(8)} variable. @table @asis @item @emph{Description}: -@code{IOR} returns the bitwise boolean inclusive-OR of @var{I} and +@code{IOR} returns the bitwise Boolean inclusive-OR of @var{I} and @var{J}. @item @emph{Standard}: @@ -6734,7 +6734,7 @@ end program test_irand @node IS_IOSTAT_END @section @code{IS_IOSTAT_END} --- Test for end-of-file value @fnindex IS_IOSTAT_END -@cindex IOSTAT, end of file +@cindex @code{IOSTAT}, end of file @table @asis @item @emph{Description}: @@ -6760,7 +6760,7 @@ Elemental function @item @emph{Return value}: Returns a @code{LOGICAL} of the default kind, which @code{.TRUE.} if @var{I} has the value which indicates an end of file condition for -IOSTAT= specifiers, and is @code{.FALSE.} otherwise. +@code{IOSTAT=} specifiers, and is @code{.FALSE.} otherwise. @item @emph{Example}: @smallexample @@ -6779,7 +6779,7 @@ END PROGRAM @node IS_IOSTAT_EOR @section @code{IS_IOSTAT_EOR} --- Test for end-of-record value @fnindex IS_IOSTAT_EOR -@cindex IOSTAT, end of record +@cindex @code{IOSTAT}, end of record @table @asis @item @emph{Description}: @@ -6805,7 +6805,7 @@ Elemental function @item @emph{Return value}: Returns a @code{LOGICAL} of the default kind, which @code{.TRUE.} if @var{I} has the value which indicates an end of file condition for -IOSTAT= specifiers, and is @code{.FALSE.} otherwise. +@code{IOSTAT=} specifiers, and is @code{.FALSE.} otherwise. @item @emph{Example}: @smallexample @@ -9112,7 +9112,7 @@ end program test_nint @table @asis @item @emph{Description}: -Calculates the Euclidean vector norm (@math{L_2}) norm of +Calculates the Euclidean vector norm (@math{L_2} norm) of of @var{ARRAY} along dimension @var{DIM}. @item @emph{Standard}: @@ -9163,7 +9163,7 @@ END PROGRAM @table @asis @item @emph{Description}: -@code{NOT} returns the bitwise boolean inverse of @var{I}. +@code{NOT} returns the bitwise Boolean inverse of @var{I}. @item @emph{Standard}: Fortran 95 and later @@ -9200,7 +9200,7 @@ argument. @item @emph{Description}: Returns a disassociated pointer. -If @var{MOLD} is present, a dissassociated pointer of the same type is +If @var{MOLD} is present, a disassociated pointer of the same type is returned, otherwise the type is determined by context. In Fortran 95, @var{MOLD} is optional. Please note that Fortran 2003 @@ -9238,7 +9238,7 @@ REAL, POINTER, DIMENSION(:) :: VEC => NULL () @node NUM_IMAGES @section @code{NUM_IMAGES} --- Function that returns the number of images @fnindex NUM_IMAGES -@cindex coarray, NUM_IMAGES +@cindex coarray, @code{NUM_IMAGES} @cindex images, number of @table @asis @@ -9409,7 +9409,7 @@ END PROGRAM @table @asis @item @emph{Description}: -Calculates the partity, i.e. the reduction using @code{.XOR.}, +Calculates the parity, i.e. the reduction using @code{.XOR.}, of @var{MASK} along dimension @var{DIM}. @item @emph{Standard}: @@ -11868,7 +11868,7 @@ end program test_tanh @node THIS_IMAGE @section @code{THIS_IMAGE} --- Function that returns the cosubscript index of this image @fnindex THIS_IMAGE -@cindex coarray, THIS_IMAGE +@cindex coarray, @code{THIS_IMAGE} @cindex images, index of this image @table @asis @@ -12606,6 +12606,10 @@ integer variables used in atomic operations. (Fortran 2008 or later.) Default-kind integer constant to be used as kind parameter when defining logical variables used in atomic operations. (Fortran 2008 or later.) +@item @code{CHARACTER_KINDS}: +Default-kind integer constant array of rank one containing the supported kind +parameters of the @code{CHARACTER} type. (Fortran 2008 or later.) + @item @code{CHARACTER_STORAGE_SIZE}: Size in bits of the character storage unit. @@ -12624,22 +12628,30 @@ Kind type parameters to specify an INTEGER type with a storage size of 16, 32, and 64 bits. It is negative if a target platform does not support the particular kind. (Fortran 2008 or later.) +@item @code{INTEGER_KINDS}: +Default-kind integer constant array of rank one containing the supported kind +parameters of the @code{INTEGER} type. (Fortran 2008 or later.) + @item @code{IOSTAT_END}: -The value assigned to the variable passed to the IOSTAT= specifier of +The value assigned to the variable passed to the @code{IOSTAT=} specifier of an input/output statement if an end-of-file condition occurred. @item @code{IOSTAT_EOR}: -The value assigned to the variable passed to the IOSTAT= specifier of +The value assigned to the variable passed to the @code{IOSTAT=} specifier of an input/output statement if an end-of-record condition occurred. @item @code{IOSTAT_INQUIRE_INTERNAL_UNIT}: Scalar default-integer constant, used by @code{INQUIRE} for the -IOSTAT= specifier to denote an that a unit number identifies an +@code{IOSTAT=} specifier to denote an that a unit number identifies an internal unit. (Fortran 2008 or later.) @item @code{NUMERIC_STORAGE_SIZE}: The size in bits of the numeric storage unit. +@item @code{LOGICAL_KINDS}: +Default-kind integer constant array of rank one containing the supported kind +parameters of the @code{LOGICAL} type. (Fortran 2008 or later.) + @item @code{OUTPUT_UNIT}: Identifies the preconnected unit identified by the asterisk (@code{*}) in @code{WRITE} statement. @@ -12649,6 +12661,10 @@ Kind type parameters to specify a REAL type with a storage size of 32, 64, and 128 bits. It is negative if a target platform does not support the particular kind. (Fortran 2008 or later.) +@item @code{REAL_KINDS}: +Default-kind integer constant array of rank one containing the supported kind +parameters of the @code{REAL} type. (Fortran 2008 or later.) + @item @code{STAT_LOCKED}: Scalar default-integer constant used as STAT= return value by @code{LOCK} to denote that the lock variable is locked by the executing image. (Fortran 2008 @@ -12773,7 +12789,7 @@ a form of two Fortran 90 modules, named @code{OMP_LIB} and @code{OMP_LIB_KINDS}, and in a form of a Fortran @code{include} file named @file{omp_lib.h}. The procedures provided by @code{OMP_LIB} can be found in the @ref{Top,,Introduction,libgomp,GNU OpenMP runtime library} manual, -the named constants defined in the @code{OMP_LIB_KINDS} module are listed +the named constants defined in the modules are listed below. For details refer to the actual @@ -12790,3 +12806,18 @@ named constants: @item @code{omp_nest_lock_kind} @item @code{omp_sched_kind} @end table + +@code{OMP_LIB} provides the scalar default-integer +named constant @code{openmp_version} with a value of the form +@var{yyyymm}, where @code{yyyy} is the year and @var{mm} the month +of the OpenMP version; for OpenMP v3.0 the value is @code{200805}. + +And the following scalar integer named constants of the +kind @code{omp_sched_kind}: + +@table @asis +@item @code{omp_sched_static} +@item @code{omp_sched_dynamic} +@item @code{omp_sched_guided} +@item @code{omp_sched_auto} +@end table |