pm_str::getMaxLoc Interface Reference

Generate and return the location of the first occurrence of the maximum of the input string(s).
More...

Detailed Description

Generate and return the location of the first occurrence of the maximum of the input string(s).

Parameters

[in]	str	: The input scalar or array of arbitrary rank of type character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) of arbitrary len type parameter.
[in]	mask	: The input vector of type logical of default kind LK of the same length as the len type parameter of the input str. If present, then only those characters of str corresponding to a .true. in mask will be considered to find maxLoc. When mask is present, str must be a scalar (the procedures are non-elemental when mask is present). (optional, default = [(.true., i = 1, len(str))])
[in]	back	: The input scalar of type logical of default kind LK. If present and .true., then the location of the last element of maximum value in str will be output. (optional, default = .false.)

Returns

maxLoc : The output scalar or array of the same shape as the input str of type integer of default kind IK containing the location of the first character of maximum value in the input str.
If len(str) == 0 on input, then maxLoc = 1_IK on output, similar to the behavior of the Fortran intrinsic functions minloc and maxloc in the Intel Fortran compiler.

Possible calling interfaces ⛓

use pm_str, only: getMaxLoc
 
maxLoc = getMaxLoc(str, back = back)
maxLoc = getMaxLoc(str, mask, back = back)

Warning

The input str must have non-zero len type-parameter.
The length of the input mask vector must equal the length of the input str.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.

Remarks

Individual characters are compared using the Fortran intrinsic relational operators for objects of type character.

Note

The procedures under this generic interface are intended to (partially) overload the functionality of the Fortran intrinsic function maxloc to also accept input scalar string arguments.

See also

getMinLoc
getMaxLoc
getMinVal
getMaxVal

Example usage ⛓

program example
 
    use pm_kind, only: LK
    use pm_kind, only: SK ! all processor types and kinds are supported.
    use pm_io, only: display_type
    use pm_arrayFind, only: getLoc
    use pm_str, only: getMaxLoc
 
    implicit none
 
    logical(LK)     , allocatable   :: Mask(:)
    character(:, SK), allocatable   :: str
    integer :: i
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("getMaxLoc(SK_'ParaMonte')")
    call disp%show( getMaxLoc(SK_'ParaMonte') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getMaxLoc(SK_'The ParaMonte Parallel Library')")
    call disp%show( getMaxLoc(SK_'The ParaMonte Parallel Library') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getMaxLoc(SK_'The ParaMonte Parallel Library', back = .true._LK)")
    call disp%show( getMaxLoc(SK_'The ParaMonte Parallel Library', back = .true._LK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getMaxLoc(SK_'The ParaMonte Parallel Library', back = .false._LK)")
    call disp%show( getMaxLoc(SK_'The ParaMonte Parallel Library', back = .false._LK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("str = SK_'The ParaMonte Parallel Library'")
                    str = SK_'The ParaMonte Parallel Library'
    call disp%show("Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`")
                    Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`
    call disp%show("Mask")
    call disp%show( Mask )
    call disp%show("getMaxLoc(str, Mask)")
    call disp%show( getMaxLoc(str, Mask) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("str = SK_'The ParaMonte Parallel Library'")
                    str = SK_'The ParaMonte Parallel Library'
    call disp%show("Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`")
                    Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`
    call disp%show("Mask")
    call disp%show( Mask )
    call disp%show("getMaxLoc(str, Mask, back = .true._LK)")
    call disp%show( getMaxLoc(str, Mask, back = .true._LK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("str = SK_'The ParaMonte Parallel Library'")
                    str = SK_'The ParaMonte Parallel Library'
    call disp%show("Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`")
                    Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`
    call disp%show("Mask")
    call disp%show( Mask )
    call disp%show("getMaxLoc(str, Mask, back = .false._LK)")
    call disp%show( getMaxLoc(str, Mask, back = .false._LK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getMaxLoc([character(11,SK) :: 'The Fortran', 'Programming', 'Language']) ! Note that 'Language' is padded with blanks.")
    call disp%show( getMaxLoc([character(11,SK) :: 'The Fortran', 'Programming', 'Language']) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getMaxLoc([character(11,SK) :: 'The Fortran', 'Programming', 'Language'], back = .true._LK) ! Note that 'Language' is padded with blanks.")
    call disp%show( getMaxLoc([character(11,SK) :: 'The Fortran', 'Programming', 'Language'], back = .true._LK) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
getMaxLoc(SK_'ParaMonte')
+8
 
 
getMaxLoc(SK_'The ParaMonte Parallel Library')
+30
 
 
getMaxLoc(SK_'The ParaMonte Parallel Library', back = .true._LK)
+1
 
 
getMaxLoc(SK_'The ParaMonte Parallel Library', back = .false._LK)
+30
 
 
str = SK_'The ParaMonte Parallel Library'
Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`
Mask
T, T, T, F, T, T, T, T, T, T, T, T, T, F, T, T, T, T, T, T, T, T, F, T, T, T, T, T, T, T
getMaxLoc(str, Mask)
+30
 
 
str = SK_'The ParaMonte Parallel Library'
Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`
Mask
T, T, T, F, T, T, T, T, T, T, T, T, T, F, T, T, T, T, T, T, T, T, F, T, T, T, T, T, T, T
getMaxLoc(str, Mask, back = .true._LK)
+1
 
 
str = SK_'The ParaMonte Parallel Library'
Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_' ')) = .false._LK ! set all whitespace locations in the Mask to `.false.`
Mask
T, T, T, F, T, T, T, T, T, T, T, T, T, F, T, T, T, T, T, T, T, T, F, T, T, T, T, T, T, T
getMaxLoc(str, Mask, back = .false._LK)
+30
 
 
getMaxLoc([character(11,SK) :: 'The Fortran', 'Programming', 'Language']) ! Note that 'Language' is padded with blanks.
+8, +2, +5
 
 
getMaxLoc([character(11,SK) :: 'The Fortran', 'Programming', 'Language'], back = .true._LK) ! Note that 'Language' is padded with blanks.
+8, +5, +5
 
 

Test:

test_pm_str

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 691 of file pm_str.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_str.F90