Generate and return maximum character value in 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 maxVal .
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))] ) |
- Returns
maxVal
: The output scalar or array of the same type, kind, and rank as the input str
but with a len
type-parameter of 1
containing the character of maximum value in the input str
.
Possible calling interfaces ⛓
character(1, kind(str)) :: maxVal
Generate and return maximum character value in the input string(s).
This module contains classes and procedures for various string manipulations and inquiries.
- 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.
- Note
- The procedures under this generic interface are intended to (partially) overload the functionality of the Fortran intrinsic function
maxval
to also accept input scalar string arguments.
- See also
- getMinLoc
getMaxLoc
getMinVal
getMaxVal
Example usage ⛓
11 logical(LK) ,
allocatable :: Mask(:)
12 character(:, SK),
allocatable :: str
15 type(display_type) :: disp
19 call disp%show(
"getMaxVal(SK_'ParaMonte')")
24 call disp%show(
"getMaxVal(SK_'The ParaMonte Parallel Library')")
25 call disp%show(
getMaxVal(SK_
'The ParaMonte Parallel Library') , deliml
= SK_
"""" )
29 call disp%show(
"str = SK_'The ParaMonte Parallel Library'")
30 str
= SK_
'The ParaMonte Parallel Library'
31 call disp%show(
"Mask = [logical(LK) :: (.true., i = 1, len(str))]; Mask(getLoc(str, SK_'y')) = .false._LK ! set all `y` locations in the Mask to `.false.`")
32 Mask
= [
logical(
LK) :: (
.true., i
= 1,
len(str))]; Mask(
getLoc(str, SK_
'y'))
= .false._LK
35 call disp%show(
"getMaxVal(str, Mask)")
42 call disp%show(
"getMaxVal([character(11,SK) :: 'The Fortran', 'Programming', 'Language']) ! Note that 'Language' is padded with blanks.")
43 call disp%show(
getMaxVal([
character(
11,SK) ::
'The Fortran',
'Programming',
'Language']) , deliml
= SK_
"""" )
Generate and return an allocatable array containing the indices of the locations within the input arr...
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
This module contains procedures and generic interfaces for finding locations of a pattern in arrays o...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort
compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
6getMaxVal(SK_
'The ParaMonte Parallel Library')
10str
= SK_
'The ParaMonte Parallel Library'
11Mask
= [
logical(
LK) :: (
.true., i
= 1,
len(str))]; Mask(
getLoc(str, SK_
'y'))
= .false._LK
13T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, F
20getMaxVal([
character(
11,SK) ::
'The Fortran',
'Programming',
'Language'])
- Test:
- test_pm_str
- Todo:
- High Priority: The restriction on the non-zero length of the input string can be lifted to make the behavior compatible with the corresponding intrinsic routine.
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.
-
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.
-
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 1077 of file pm_str.F90.