[doc,fortran] Document FINDLOC
diff mbox series

Message ID b7262161-78c0-105a-81a8-20a3221ae4d1@tkoenig.net
State New
Headers show
Series
  • [doc,fortran] Document FINDLOC
Related show

Commit Message

Thomas König Oct. 28, 2018, 2:13 p.m. UTC
Hi,

here is the promised documentation for FINDLOC.  Tested
with "make dvi" and "make pdf".

OK for trunk?

Regards

	Thomas

2018-10-28  Thomas Koenig  <tkoenig@gcc.gnu.org>

         PR fortran/54613
         * gfortran.texi (File format of unformatted sequential files):
         Replace random comma with period.
         * intrinsic.texi (Intrinsic Procedures): Add FINDLOC to menu.
         (FINDLOC): Document.
         (MAXLOC): Add refrence to FINDLOC.
         (MINLOC): Likewise.

Comments

Bernhard Reutner-Fischer Oct. 29, 2018, 11:31 a.m. UTC | #1
Hi!

On Sun, 28 Oct 2018 15:13:49 +0100
Thomas König <tk@tkoenig.net> wrote:

One question and some nits below.

> ===================================================================
> --- intrinsic.texi	(Revision 265569)
> +++ intrinsic.texi	(Arbeitskopie)

> @@ -6021,8 +6022,68 @@ END PROGRAM
>  @ref{FGET}, @ref{FPUT}, @ref{FPUTC}
>  @end table
>  
> +@node FINDLOC
> +@section @code{FINDLOC} --- Search an array for a value

I think one should not put spaces around triple-dashes.

> +@fnindex FINDLOC
> +@cindex findloc
>  
> +@table @asis
> +@item @emph{Description}:
> +Determines the location of the element in the array with the value
> +given in the @var{VALUE} argument, or, if the @var{DIM} argument is
> +supplied, determines the locations of the maximum element along each
> +row of the array in the @var{DIM} direction. If @var{MASK} is present,

dot-space-space at end of sentence: direction.  If

> +only the elements for which @var{MASK} is @code{.TRUE.} are
> +considered.  If more than one element in the array has the value
> +@var{VALUE}, the location returned is that of the first such element
> +in array element order if the @var{BACK} is not present, or if it

missing "is": ...not present or if it is @code{.FALSE.}.

> +false; otherwise, the location returned is that of the first such
> +element. If the array has zero size, or all of the elements of

I think this should mention BACK=.TRUE. for clarity; and it should
refer to the _last_ such element, not the first, doesn't it?

Like:

If @var{BACK} is @code{.TRUE.} the location returned is that of the
last such element.

> +@var{MASK} are @code{.FALSE.}, then the result is an array of zeroes.
> +Similarly, if @var{DIM} is supplied and all of the elements of
> +@var{MASK} along a given row are zero, the result value for that row
> +is zero.
>  
> +@item @emph{Standard}:
> +Fortran 2008 and later.
> +
> +@item @emph{Class}:
> +Transformational function
> +
> +@item @emph{Syntax}:
> +@multitable @columnfractions .80
> +@item @code{RESULT = FINDLOC(ARRAY, VALUE, DIM [, MASK] [,KIND] [,BACK])}
> +@item @code{RESULT = FINDLOC(ARRAY, VALUE, [, MASK] [,KIND] [,BACK])}
> +@end multitable
> +
> +@item @emph{Arguments}:
> +@multitable @columnfractions .15 .70
> +@item @var{ARRAY} @tab Shall be an array of intrinsic type.
> +@item @var{VALUE} @tab A scalar of intrinsic type which is in type
> +conformance with @var{ARRAY}.
> +@item @var{DIM}   @tab (Optional) Shall be a scalar of type

Excess spaces between @var{DIM} and @tab?

> +@code{INTEGER}, with a value between one and the rank of @var{ARRAY},
> +inclusive.  It may not be an optional dummy argument.
> +@item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
> +expression indicating the kind parameter of the result.
> +@item @var{BACK} @tab (Optional) A scalar of type @code{LOGICAL}.
> +@end multitable
> +
> +@item @emph{Return value}:
> +If @var{DIM} is absent, the result is a rank-one array with a length
> +equal to the rank of @var{ARRAY}.  If @var{DIM} is present, the result
> +is an array with a rank one less than the rank of @var{ARRAY}, and a
> +size corresponding to the size of @var{ARRAY} with the @var{DIM}
> +dimension removed.  If @var{DIM} is present and @var{ARRAY} has a rank
> +of one, the result is a scalar.   If the optional argument @var{KIND}

Excess third space at the start of the sentence: dot-space-space

thanks,

> +is present, the result is an integer of kind @var{KIND}, otherwise it
> +is of default kind.
Thomas König Oct. 29, 2018, 9:29 p.m. UTC | #2
Am 29.10.18 um 12:31 schrieb Bernhard Reutner-Fischer:
> Hi!
> 
> On Sun, 28 Oct 2018 15:13:49 +0100
> Thomas König <tk@tkoenig.net> wrote:
> 
> One question and some nits below.
> 
>> ===================================================================
>> --- intrinsic.texi	(Revision 265569)
>> +++ intrinsic.texi	(Arbeitskopie)
> 
>> @@ -6021,8 +6022,68 @@ END PROGRAM
>>   @ref{FGET}, @ref{FPUT}, @ref{FPUTC}
>>   @end table
>>   
>> +@node FINDLOC
>> +@section @code{FINDLOC} --- Search an array for a value
> 
> I think one should not put spaces around triple-dashes.

We have it everywhere else.  Should we change this in general?
If so, that would probably make sense as a followup patch.

DIM} direction. If @var{MASK} is present,
> 
> dot-space-space at end of sentence: direction.  If

Done.

>> +only the elements for which @var{MASK} is @code{.TRUE.} are
>> +considered.  If more than one element in the array has the value
>> +@var{VALUE}, the location returned is that of the first such element
>> +in array element order if the @var{BACK} is not present, or if it
> 
> missing "is": ...not present or if it is @code{.FALSE.}.
> 
>> +false; otherwise, the location returned is that of the first such
>> +element. If the array has zero size, or all of the elements of
> 
> I think this should mention BACK=.TRUE. for clarity; and it should
> refer to the _last_ such element, not the first, doesn't it?

Reordered, to make it more sensible.

>> Excess spaces between @var{DIM} and @tab?

Removed.

> Excess third space at the start of the sentence: dot-space-space

Removed.

Unless there are other comments, I'll commit in a couple of days.

Regards

	Thomas
Index: gfortran.texi
===================================================================
--- gfortran.texi	(Revision 265569)
+++ gfortran.texi	(Arbeitskopie)
@@ -1479,7 +1479,7 @@ contains a negative number, then there is a preced
 
 In the most simple case, with only one subrecord per logical record,
 both record markers contain the number of bytes of user data in the
-record,
+record.
 
 The format for unformatted sequential data can be duplicated using
 unformatted stream, as shown in the example program for an unformatted
Index: intrinsic.texi
===================================================================
--- intrinsic.texi	(Revision 265569)
+++ intrinsic.texi	(Arbeitskopie)
@@ -148,6 +148,7 @@ Some basic guidelines for editing this document:
 * @code{FDATE}:         FDATE,     Subroutine (or function) to get the current time as a string
 * @code{FGET}:          FGET,      Read a single character in stream mode from stdin
 * @code{FGETC}:         FGETC,     Read a single character in stream mode
+* @code{FINDLOC}:       FINDLOC,   Search an array for a value
 * @code{FLOOR}:         FLOOR,     Integer floor function
 * @code{FLUSH}:         FLUSH,     Flush I/O unit(s)
 * @code{FNUM}:          FNUM,      File number function
@@ -6021,8 +6022,68 @@ END PROGRAM
 @ref{FGET}, @ref{FPUT}, @ref{FPUTC}
 @end table
 
+@node FINDLOC
+@section @code{FINDLOC} --- Search an array for a value
+@fnindex FINDLOC
+@cindex findloc
 
+@table @asis
+@item @emph{Description}:
+Determines the location of the element in the array with the value
+given in the @var{VALUE} argument, or, if the @var{DIM} argument is
+supplied, determines the locations of the maximum element along each
+row of the array in the @var{DIM} direction.  If @var{MASK} is
+present, only the elements for which @var{MASK} is @code{.TRUE.} are
+considered.  If more than one element in the array has the value
+@var{VALUE}, the location returned is that of the first such element
+in array element order if the @var{BACK} is not present or if it is
+@code{.FALSE.}. If @var{BACK} is true, the location returned is that
+of the last such element. If the array has zero size, or all of the
+elements of @var{MASK} are @code{.FALSE.}, then the result is an array
+of zeroes.  Similarly, if @var{DIM} is supplied and all of the
+elements of @var{MASK} along a given row are zero, the result value
+for that row is zero.
 
+@item @emph{Standard}:
+Fortran 2008 and later.
+
+@item @emph{Class}:
+Transformational function
+
+@item @emph{Syntax}:
+@multitable @columnfractions .80
+@item @code{RESULT = FINDLOC(ARRAY, VALUE, DIM [, MASK] [,KIND] [,BACK])}
+@item @code{RESULT = FINDLOC(ARRAY, VALUE, [, MASK] [,KIND] [,BACK])}
+@end multitable
+
+@item @emph{Arguments}:
+@multitable @columnfractions .15 .70
+@item @var{ARRAY} @tab Shall be an array of intrinsic type.
+@item @var{VALUE} @tab A scalar of intrinsic type which is in type
+conformance with @var{ARRAY}.
+@item @var{DIM} @tab (Optional) Shall be a scalar of type
+@code{INTEGER}, with a value between one and the rank of @var{ARRAY},
+inclusive.  It may not be an optional dummy argument.
+@item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
+expression indicating the kind parameter of the result.
+@item @var{BACK} @tab (Optional) A scalar of type @code{LOGICAL}.
+@end multitable
+
+@item @emph{Return value}:
+If @var{DIM} is absent, the result is a rank-one array with a length
+equal to the rank of @var{ARRAY}.  If @var{DIM} is present, the result
+is an array with a rank one less than the rank of @var{ARRAY}, and a
+size corresponding to the size of @var{ARRAY} with the @var{DIM}
+dimension removed.  If @var{DIM} is present and @var{ARRAY} has a rank
+of one, the result is a scalar.  If the optional argument @var{KIND}
+is present, the result is an integer of kind @var{KIND}, otherwise it
+is of default kind.
+
+@item @emph{See also}:
+@ref{MAXLOC}, @ref{MINLOC}
+
+@end table
+
 @node FLOOR
 @section @code{FLOOR} --- Integer floor function
 @fnindex FLOOR
@@ -10039,7 +10100,7 @@ is present, the result is an integer of kind @var{
 is of default kind.
 
 @item @emph{See also}:
-@ref{MAX}, @ref{MAXVAL}
+@ref{FINDLOC}, @ref{MAX}, @ref{MAXVAL}
 
 @end table
 
@@ -10395,7 +10456,7 @@ is present, the result is an integer of kind @var{
 is of default kind.
 
 @item @emph{See also}:
-@ref{MIN}, @ref{MINVAL}
+@ref{FINDLOC}, @ref{MIN}, @ref{MINVAL}
 
 @end table

Patch
diff mbox series

Index: gfortran.texi
===================================================================
--- gfortran.texi	(Revision 265569)
+++ gfortran.texi	(Arbeitskopie)
@@ -1479,7 +1479,7 @@  contains a negative number, then there is a preced
 
 In the most simple case, with only one subrecord per logical record,
 both record markers contain the number of bytes of user data in the
-record,
+record.
 
 The format for unformatted sequential data can be duplicated using
 unformatted stream, as shown in the example program for an unformatted
Index: intrinsic.texi
===================================================================
--- intrinsic.texi	(Revision 265569)
+++ intrinsic.texi	(Arbeitskopie)
@@ -148,6 +148,7 @@  Some basic guidelines for editing this document:
 * @code{FDATE}:         FDATE,     Subroutine (or function) to get the current time as a string
 * @code{FGET}:          FGET,      Read a single character in stream mode from stdin
 * @code{FGETC}:         FGETC,     Read a single character in stream mode
+* @code{FINDLOC}:       FINDLOC,   Search an array for a value
 * @code{FLOOR}:         FLOOR,     Integer floor function
 * @code{FLUSH}:         FLUSH,     Flush I/O unit(s)
 * @code{FNUM}:          FNUM,      File number function
@@ -6021,8 +6022,68 @@  END PROGRAM
 @ref{FGET}, @ref{FPUT}, @ref{FPUTC}
 @end table
 
+@node FINDLOC
+@section @code{FINDLOC} --- Search an array for a value
+@fnindex FINDLOC
+@cindex findloc
 
+@table @asis
+@item @emph{Description}:
+Determines the location of the element in the array with the value
+given in the @var{VALUE} argument, or, if the @var{DIM} argument is
+supplied, determines the locations of the maximum element along each
+row of the array in the @var{DIM} direction. If @var{MASK} is present,
+only the elements for which @var{MASK} is @code{.TRUE.} are
+considered.  If more than one element in the array has the value
+@var{VALUE}, the location returned is that of the first such element
+in array element order if the @var{BACK} is not present, or if it
+false; otherwise, the location returned is that of the first such
+element. If the array has zero size, or all of the elements of
+@var{MASK} are @code{.FALSE.}, then the result is an array of zeroes.
+Similarly, if @var{DIM} is supplied and all of the elements of
+@var{MASK} along a given row are zero, the result value for that row
+is zero.
 
+@item @emph{Standard}:
+Fortran 2008 and later.
+
+@item @emph{Class}:
+Transformational function
+
+@item @emph{Syntax}:
+@multitable @columnfractions .80
+@item @code{RESULT = FINDLOC(ARRAY, VALUE, DIM [, MASK] [,KIND] [,BACK])}
+@item @code{RESULT = FINDLOC(ARRAY, VALUE, [, MASK] [,KIND] [,BACK])}
+@end multitable
+
+@item @emph{Arguments}:
+@multitable @columnfractions .15 .70
+@item @var{ARRAY} @tab Shall be an array of intrinsic type.
+@item @var{VALUE} @tab A scalar of intrinsic type which is in type
+conformance with @var{ARRAY}.
+@item @var{DIM}   @tab (Optional) Shall be a scalar of type
+@code{INTEGER}, with a value between one and the rank of @var{ARRAY},
+inclusive.  It may not be an optional dummy argument.
+@item @var{KIND} @tab (Optional) An @code{INTEGER} initialization
+expression indicating the kind parameter of the result.
+@item @var{BACK} @tab (Optional) A scalar of type @code{LOGICAL}.
+@end multitable
+
+@item @emph{Return value}:
+If @var{DIM} is absent, the result is a rank-one array with a length
+equal to the rank of @var{ARRAY}.  If @var{DIM} is present, the result
+is an array with a rank one less than the rank of @var{ARRAY}, and a
+size corresponding to the size of @var{ARRAY} with the @var{DIM}
+dimension removed.  If @var{DIM} is present and @var{ARRAY} has a rank
+of one, the result is a scalar.   If the optional argument @var{KIND}
+is present, the result is an integer of kind @var{KIND}, otherwise it
+is of default kind.
+
+@item @emph{See also}:
+@ref{MAXLOC}, @ref{MINLOC}
+
+@end table
+
 @node FLOOR
 @section @code{FLOOR} --- Integer floor function
 @fnindex FLOOR
@@ -10039,7 +10100,7 @@  is present, the result is an integer of kind @var{
 is of default kind.
 
 @item @emph{See also}:
-@ref{MAX}, @ref{MAXVAL}
+@ref{FINDLOC}, @ref{MAX}, @ref{MAXVAL}
 
 @end table
 
@@ -10395,7 +10456,7 @@  is present, the result is an integer of kind @var{
 is of default kind.
 
 @item @emph{See also}:
-@ref{MIN}, @ref{MINVAL}
+@ref{FINDLOC}, @ref{MIN}, @ref{MINVAL}
 
 @end table