#
Fortran Wiki

maxloc

## Description

Determines the location of the element in the array with the maximum value, or, if the `dim`

argument is supplied, determines the locations of the maximum element along each row of the array in the `dim`

direction. If `mask`

is present, only the elements for which `mask`

is `.true.`

are considered. If more than one element in the array has the maximum value, the location returned is that of the first such element in array element order. If the array has zero size, or all of the elements of `mask`

are `.false.`

, then the result is an array of zeroes. Similarly, if `dim`

is supplied and all of the elements of `mask`

along a given row are zero, the result value for that row is zero.

## Standard

Fortran 95 and later; `array`

of `character`

and the `kind`

argument are available in Fortran 2003 and later.

## Class

Transformational function

## Syntax

`result = maxloc(array, dim [, mask] [, kind])`

`result = maxloc(array [, mask] [, kind])`

## Arguments

`array`

- Shall be an array of type `integer`

, `real`

, or `character`

.
`dim`

- (Optional) Shall be a scalar of type `integer`

, with a value between one and the rank of `array`

, inclusive. It may not be an optional dummy argument.
`mask`

- Shall be an array of type `logical`

, and conformable with `array`

.
`kind`

- (Optional) An `integer`

initialization expression indicating the kind parameter of the result.

## Return value

If `dim`

is absent, the result is a rank-one array with a length equal to the rank of `array`

. If `dim`

is present, the result is an array with a rank one less than the rank of `array`

, and a size corresponding to the size of `array`

with the `dim`

dimension removed. If `dim`

is present and `array`

has a rank of one, the result is a scalar. If the optional argument `kind`

is present, the result is an integer of kind `kind`

, otherwise it is of default kind.

## See also

max, maxval

Revised on January 5, 2018 10:02:55
by

Jason Blevins
(66.171.36.83)
(2021 characters / 0.0 pages)