Commit bc5b7642 by Brooks Moses Committed by Brooks Moses

intrinsic.texi (LBOUND): Add documentation.

* intrinsic.texi (LBOUND): Add documentation.
(LGE): Add documentation.
(LGT): Add documentation.
(LINK): Add documentation.
(LLE): Add documentation.
(LLT): Add documentation.
(LNBLNK): Add documentation.
(UBOUND): Add documentation.
(UNLINK): Add documentation.

From-SVN: r120466
parent a87948f7
2007-01-04 Brooks Moses <brooks.moses@codesourcery.com> 2007-01-04 Brooks Moses <brooks.moses@codesourcery.com>
* intrinsic.texi (LBOUND): Add documentation.
(LGE): Add documentation.
(LGT): Add documentation.
(LINK): Add documentation.
(LLE): Add documentation.
(LLT): Add documentation.
(LNBLNK): Add documentation.
(UBOUND): Add documentation.
(UNLINK): Add documentation.
2007-01-04 Brooks Moses <brooks.moses@codesourcery.com>
* intrinsic.texi (IAND): Clarify argument specifications. * intrinsic.texi (IAND): Clarify argument specifications.
(IBCLR): Add documentation. (IBCLR): Add documentation.
(IBITS): Add documentation. (IBITS): Add documentation.
......
...@@ -5288,12 +5288,11 @@ end program test_kind ...@@ -5288,12 +5288,11 @@ end program test_kind
@node LBOUND @node LBOUND
@section @code{LBOUND} --- Lower dimension bounds of an array @section @code{LBOUND} --- Lower dimension bounds of an array
@cindex @code{LBOUND} intrinsic @cindex @code{LBOUND} intrinsic
@cindex undocumented intrinsic
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Returns the lower bounds of an array, or a single lower bound
along the @var{DIM} dimension.
@item @emph{Standard}: @item @emph{Standard}:
F95 and later F95 and later
...@@ -5301,16 +5300,28 @@ F95 and later ...@@ -5301,16 +5300,28 @@ F95 and later
Inquiry function Inquiry function
@item @emph{Syntax}: @item @emph{Syntax}:
@code{I = LBOUND(ARRAY [, DIM])}
@item @emph{Arguments}: @item @emph{Arguments}:
@multitable @columnfractions .15 .80
@item @var{ARRAY} @tab Shall be an array, of any type.
@item @var{DIM} @tab (Optional) Shall be a scalar @code{INTEGER(*)}.
@end multitable
@item @emph{Return value}: @item @emph{Return value}:
@item @emph{Example}: If @var{DIM} is absent, the result is an array of the lower bounds of
@var{ARRAY}. If @var{DIM} is present, the result is a scalar
corresponding to the lower bound of the array along that dimension. If
@var{ARRAY} is an expression rather than a whole array or array
structure component, or if it has a zero extent along the relevant
dimension, the lower bound is taken to be 1.
@item @emph{See also}: @item @emph{See also}:
@ref{UBOUND} @ref{UBOUND}
@end table @end table
@node LEN @node LEN
@section @code{LEN} --- Length of a character entity @section @code{LEN} --- Length of a character entity
@cindex @code{LEN} intrinsic @cindex @code{LEN} intrinsic
...@@ -5378,16 +5389,27 @@ The return value is of @code{INTEGER(kind=4)} type. ...@@ -5378,16 +5389,27 @@ The return value is of @code{INTEGER(kind=4)} type.
@node LGE @node LGE
@section @code{LGE} --- Lexical greater than or equal @section @code{LGE} --- Lexical greater than or equal
@cindex @code{LGE} intrinsic @cindex @code{LGE} intrinsic
@cindex comparison (lexical) @cindex comparison (lexical)
@cindex lexical comparison
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Determines whether one string is lexically greater than or equal to
another string, where the two strings are interpreted as containing
ASCII character codes. If the String A and String B are not the same
length, the shorter is compared as if spaces were appended to it to form
a value that has the same length as the longer.
In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
@code{LLE}, and @code{LLT} differ from the corresponding intrinsic
operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
that the latter use the processor's character ordering (which is not
ASCII on some targets), whereas the former always use the ASCII
ordering.
@item @emph{Standard}: @item @emph{Standard}:
F77 and later F77 and later
...@@ -5395,9 +5417,17 @@ F77 and later ...@@ -5395,9 +5417,17 @@ F77 and later
Elemental function Elemental function
@item @emph{Syntax}: @item @emph{Syntax}:
@code{L = LGE(STRING_A, STRING_B)}
@item @emph{Arguments}: @item @emph{Arguments}:
@multitable @columnfractions .15 .80
@item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
@item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
@end multitable
@item @emph{Return value}: @item @emph{Return value}:
@item @emph{Example}: Returns @code{.TRUE.} if @code{STRING_A >= STRING_B}, and @code{.FALSE.}
otherwise, based on the ASCII ordering.
@item @emph{See also}: @item @emph{See also}:
@ref{LGT}, @ref{LLE}, @ref{LLT} @ref{LGT}, @ref{LLE}, @ref{LLT}
...@@ -5405,16 +5435,27 @@ Elemental function ...@@ -5405,16 +5435,27 @@ Elemental function
@node LGT @node LGT
@section @code{LGT} --- Lexical greater than @section @code{LGT} --- Lexical greater than
@cindex @code{LGT} intrinsic @cindex @code{LGT} intrinsic
@cindex comparison (lexical) @cindex comparison (lexical)
@cindex lexical comparison
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Determines whether one string is lexically greater than another string,
where the two strings are interpreted as containing ASCII character
codes. If the String A and String B are not the same length, the
shorter is compared as if spaces were appended to it to form a value
that has the same length as the longer.
In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
@code{LLE}, and @code{LLT} differ from the corresponding intrinsic
operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
that the latter use the processor's character ordering (which is not
ASCII on some targets), whereas the former always use the ASCII
ordering.
@item @emph{Standard}: @item @emph{Standard}:
F77 and later F77 and later
...@@ -5422,9 +5463,17 @@ F77 and later ...@@ -5422,9 +5463,17 @@ F77 and later
Elemental function Elemental function
@item @emph{Syntax}: @item @emph{Syntax}:
@code{L = LGT(STRING_A, STRING_B)}
@item @emph{Arguments}: @item @emph{Arguments}:
@multitable @columnfractions .15 .80
@item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
@item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
@end multitable
@item @emph{Return value}: @item @emph{Return value}:
@item @emph{Example}: Returns @code{.TRUE.} if @code{STRING_A > STRING_B}, and @code{.FALSE.}
otherwise, based on the ASCII ordering.
@item @emph{See also}: @item @emph{See also}:
@ref{LGE}, @ref{LLE}, @ref{LLT} @ref{LGE}, @ref{LLE}, @ref{LLT}
...@@ -5432,16 +5481,18 @@ Elemental function ...@@ -5432,16 +5481,18 @@ Elemental function
@node LINK @node LINK
@section @code{LINK} --- Create a hard link @section @code{LINK} --- Create a hard link
@cindex @code{LINK} intrinsic @cindex @code{LINK} intrinsic
@cindex file system operations @cindex file system operations
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Makes a (hard) link from file @var{PATH1} to @var{PATH2}. A null character (@code{CHAR(0)}) can be used to mark the
end of the names in @var{PATH1} and @var{PATH2}; otherwise, trailing blanks in the file names are
ignored. If the @var{STATUS} argument is supplied, it contains 0 on success or a nonzero error code
upon return; see @code{link(2)}.
@item @emph{Standard}: @item @emph{Standard}:
GNU extension GNU extension
...@@ -5449,10 +5500,14 @@ GNU extension ...@@ -5449,10 +5500,14 @@ GNU extension
Subroutine Subroutine
@item @emph{Syntax}: @item @emph{Syntax}:
@code{CALL LINK(PATH1, PATH2 [, STATUS])}
@item @emph{Arguments}: @item @emph{Arguments}:
@item @emph{Return value}: @multitable @columnfractions .15 .80
@item @emph{Example}: @item @var{PATH1} @tab Shall be of default @code{CHARACTER} type.
@item @emph{Specific names}: @item @var{PATH2} @tab Shall be of default @code{CHARACTER} type.
@item @var{STATUS} @tab (Optional) Shall be of default @code{INTEGER} type.
@end multitable
@item @emph{See also}: @item @emph{See also}:
@ref{UNLINK} @ref{UNLINK}
...@@ -5460,16 +5515,27 @@ Subroutine ...@@ -5460,16 +5515,27 @@ Subroutine
@node LLE @node LLE
@section @code{LLE} --- Lexical less than or equal @section @code{LLE} --- Lexical less than or equal
@cindex @code{LLE} intrinsic @cindex @code{LLE} intrinsic
@cindex comparison (lexical) @cindex comparison (lexical)
@cindex lexical comparison
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Determines whether one string is lexically less than or equal to another
string, where the two strings are interpreted as containing ASCII
character codes. If the String A and String B are not the same length,
the shorter is compared as if spaces were appended to it to form a value
that has the same length as the longer.
In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
@code{LLE}, and @code{LLT} differ from the corresponding intrinsic
operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
that the latter use the processor's character ordering (which is not
ASCII on some targets), whereas the former always use the ASCII
ordering.
@item @emph{Standard}: @item @emph{Standard}:
F77 and later F77 and later
...@@ -5477,9 +5543,17 @@ F77 and later ...@@ -5477,9 +5543,17 @@ F77 and later
Elemental function Elemental function
@item @emph{Syntax}: @item @emph{Syntax}:
@code{L = LLE(STRING_A, STRING_B)}
@item @emph{Arguments}: @item @emph{Arguments}:
@multitable @columnfractions .15 .80
@item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
@item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
@end multitable
@item @emph{Return value}: @item @emph{Return value}:
@item @emph{Example}: Returns @code{.TRUE.} if @code{STRING_A <= STRING_B}, and @code{.FALSE.}
otherwise, based on the ASCII ordering.
@item @emph{See also}: @item @emph{See also}:
@ref{LGE}, @ref{LGT}, @ref{LLT} @ref{LGE}, @ref{LGT}, @ref{LLT}
...@@ -5487,16 +5561,29 @@ Elemental function ...@@ -5487,16 +5561,29 @@ Elemental function
@node LLT @node LLT
@section @code{LLT} --- Lexical less than @section @code{LLT} --- Lexical less than
@cindex @code{LLT} intrinsic @cindex @code{LLT} intrinsic
@cindex comparison (lexical) @cindex comparison (lexical)
@cindex lexical comparison
Intrinsic implemented, documentation pending. Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Determines whether one string is lexically less than another string,
where the two strings are interpreted as containing ASCII character
codes. If the String A and String B are not the same length, the
shorter is compared as if spaces were appended to it to form a value
that has the same length as the longer.
In general, the lexical comparison intrinsics @code{LGE}, @code{LGT},
@code{LLE}, and @code{LLT} differ from the corresponding intrinsic
operators @code{.GE.}, @code{.GT.}, @code{.LE.}, and @code{.LT.}, in
that the latter use the processor's character ordering (which is not
ASCII on some targets), whereas the former always use the ASCII
ordering.
@item @emph{Standard}: @item @emph{Standard}:
F77 and later F77 and later
...@@ -5504,9 +5591,17 @@ F77 and later ...@@ -5504,9 +5591,17 @@ F77 and later
Elemental function Elemental function
@item @emph{Syntax}: @item @emph{Syntax}:
@code{L = LLT(STRING_A, STRING_B)}
@item @emph{Arguments}: @item @emph{Arguments}:
@multitable @columnfractions .15 .80
@item @var{STRING_A} @tab Shall be of default @code{CHARACTER} type.
@item @var{STRING_B} @tab Shall be of default @code{CHARACTER} type.
@end multitable
@item @emph{Return value}: @item @emph{Return value}:
@item @emph{Example}: Returns @code{.TRUE.} if @code{STRING_A < STRING_B}, and @code{.FALSE.}
otherwise, based on the ASCII ordering.
@item @emph{See also}: @item @emph{See also}:
@ref{LGE}, @ref{LGT}, @ref{LLE} @ref{LGE}, @ref{LGT}, @ref{LLE}
...@@ -5514,25 +5609,33 @@ Elemental function ...@@ -5514,25 +5609,33 @@ Elemental function
@node LNBLNK @node LNBLNK
@section @code{LNBLNK} --- Index of the last non-blank character in a string @section @code{LNBLNK} --- Index of the last non-blank character in a string
@cindex @code{LNBLNK} intrinsic @cindex @code{LNBLNK} intrinsic
@cindex undocumented intrinsic
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Returns the length of a character string, ignoring any trailing blanks.
This is identical to the standard @code{LEN_TRIM} intrinsic, and is only
included for backwards compatibility.
@item @emph{Standard}: @item @emph{Standard}:
GNU extension GNU extension
@item @emph{Class}: @item @emph{Class}:
Elemental function
@item @emph{Syntax}: @item @emph{Syntax}:
@code{L = LNBLNK(STRING)}
@item @emph{Arguments}: @item @emph{Arguments}:
@multitable @columnfractions .15 .80
@item @var{STRING} @tab Shall be a scalar of type @code{CHARACTER(*)},
with @code{INTENT(IN)}
@end multitable
@item @emph{Return value}: @item @emph{Return value}:
@item @emph{Example}: The return value is of @code{INTEGER(kind=4)} type.
@item @emph{Specific names}:
@item @emph{See also}: @item @emph{See also}:
@ref{INDEX}, @ref{LEN_TRIM} @ref{INDEX}, @ref{LEN_TRIM}
...@@ -5540,7 +5643,6 @@ GNU extension ...@@ -5540,7 +5643,6 @@ GNU extension
@node LOC @node LOC
@section @code{LOC} --- Returns the address of a variable @section @code{LOC} --- Returns the address of a variable
@cindex @code{LOC} intrinsic @cindex @code{LOC} intrinsic
...@@ -8247,17 +8349,14 @@ Transformational function ...@@ -8247,17 +8349,14 @@ Transformational function
@node UBOUND @node UBOUND
@section @code{UBOUND} --- Upper dimension bounds of an array @section @code{UBOUND} --- Upper dimension bounds of an array
@cindex @code{UBOUND} intrinsic @cindex @code{UBOUND} intrinsic
@cindex undocumented intrinsic
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Returns the upper bounds of an array, or a single upper bound
along the @var{DIM} dimension.
@item @emph{Standard}: @item @emph{Standard}:
F95 and later F95 and later
...@@ -8265,10 +8364,22 @@ F95 and later ...@@ -8265,10 +8364,22 @@ F95 and later
Inquiry function Inquiry function
@item @emph{Syntax}: @item @emph{Syntax}:
@code{I = UBOUND(ARRAY [, DIM])}
@item @emph{Arguments}: @item @emph{Arguments}:
@multitable @columnfractions .15 .80
@item @var{ARRAY} @tab Shall be an array, of any type.
@item @var{DIM} @tab (Optional) Shall be a scalar @code{INTEGER(*)}.
@end multitable
@item @emph{Return value}: @item @emph{Return value}:
@item @emph{Example}: If @var{DIM} is absent, the result is an array of the upper bounds of
@item @emph{Specific names}: @var{ARRAY}. If @var{DIM} is present, the result is a scalar
corresponding to the upper bound of the array along that dimension. If
@var{ARRAY} is an expression rather than a whole array or array
structure component, or if it has a zero extent along the relevant
dimension, the upper bound is taken to be the number of elements along
the relevant dimension.
@item @emph{See also}: @item @emph{See also}:
@ref{LBOUND} @ref{LBOUND}
...@@ -8276,7 +8387,6 @@ Inquiry function ...@@ -8276,7 +8387,6 @@ Inquiry function
@node UMASK @node UMASK
@section @code{UMASK} --- Set the file creation mask @section @code{UMASK} --- Set the file creation mask
@cindex @code{UMASK} intrinsic @cindex @code{UMASK} intrinsic
...@@ -8302,16 +8412,18 @@ Subroutine ...@@ -8302,16 +8412,18 @@ Subroutine
@node UNLINK @node UNLINK
@section @code{UNLINK} --- Remove a file from the file system @section @code{UNLINK} --- Remove a file from the file system
@cindex @code{UNLINK} intrinsic @cindex @code{UNLINK} intrinsic
@cindex file system operations @cindex file system operations
Intrinsic implemented, documentation pending.
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Unlinks the file @var{PATH}. A null character (@code{CHAR(0)}) can be used to mark the
end of the name in @var{PATH}; otherwise, trailing blanks in the file name are
ignored. If the @var{STATUS} argument is supplied, it contains 0 on success or a nonzero error code
upon return; see @code{link(2)}.
@item @emph{Standard}: @item @emph{Standard}:
GNU extension GNU extension
...@@ -8319,9 +8431,13 @@ GNU extension ...@@ -8319,9 +8431,13 @@ GNU extension
Subroutine Subroutine
@item @emph{Syntax}: @item @emph{Syntax}:
@code{CALL UNLINK(PATH [, STATUS])}
@item @emph{Arguments}: @item @emph{Arguments}:
@item @emph{Return value}: @multitable @columnfractions .15 .80
@item @emph{Example}: @item @var{PATH} @tab Shall be of default @code{CHARACTER} type.
@item @var{STATUS} @tab (Optional) Shall be of default @code{INTEGER} type.
@end multitable
@item @emph{See also}: @item @emph{See also}:
@ref{LINK} @ref{LINK}
...@@ -8329,7 +8445,6 @@ Subroutine ...@@ -8329,7 +8445,6 @@ Subroutine
@node UNMASK @node UNMASK
@section @code{UNMASK} --- (?) @section @code{UNMASK} --- (?)
@cindex @code{UNMASK} intrinsic @cindex @code{UNMASK} intrinsic
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment