Generate and return the component-wise location of the maximum value of (both real and imaginary parts of) the input complex.
More...
Generate and return the component-wise location of the maximum value of (both real and imaginary parts of) the input complex.
This generic interfaces extends the behavior of the intrinsic Fortran maxloc(a, dim = dim) for arguments of real type to arguments of type complex.
- Parameters
-
| [in] | array | : The input array of rank (1..2) of type complex of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128). |
| [in] | dim | : The input scalar of type integer of default kind IK of value 1 <= dim <= rank(array), representing the dimension along which the location of the maximum must be computed.
(optional. If missing, the output value is a scalar containing the location of the maximum of the entire input array.) |
- Returns
val : The output,
-
vector of size
2, if array is of rank 1 or if the input argument dim is missing,
-
array of shape
(1:2, size(array, 3 - dim)), if array is of rank 2 and the input argument dim is present,
of type integer of default kind IK.
-
The elements in the first row of
loc contain the locations of the first occurrences of the maximum values of the corresponding real parts of the input array.
-
The elements in the second row of
loc contain the locations of the first occurrences of the maximum values of the corresponding imaginary parts of the input array.
The returned locations are 0 if the input array has a zero size.
Possible calling interfaces ⛓
loc(1:2) = maxloc(array)
loc(1:2) = maxloc(array(:), dim)
loc(1:2, 1:size(array, 3 - dim)) = maxloc(array(:,:), dim)
Generate and return the component-wise location of the maximum value of (both real and imaginary part...
This module contains procedures and generic interfaces for computing element-wise minimum/maximum val...
- Warning
- The condition
1 <= dim .and. dim <= rank(sample) must hold for the corresponding input arguments.
This condition is 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.
- See also
- min
max
minval
maxval
minloc
maxloc
pm_complexCompareAll
pm_complexCompareAny
pm_complexCompareLex
pm_arrayMinMax
pm_mathMinMax
Example usage ⛓
10 integer(IK) :: ndim, nsam
11 type(display_type) :: disp
16 complex(CKG),
allocatable :: array(:,:)
20 call disp%show(
"array = getUnifRand((-9._CKG, -9._CKG), (+9._CKG, +9._CKG), ndim, nsam)")
21 array
= getUnifRand((
-9._CKG,
-9._CKG), (
+9._CKG,
+9._CKG), ndim, nsam)
26 call disp%show(
"maxloc(array, dim = 1_IK)")
27 call disp%show(
maxloc(array,
dim = 1_IK) )
28 call disp%show(
"maxloc(array, dim = 2_IK)")
29 call disp%show(
maxloc(array,
dim = 2_IK) )
30 call disp%show(
"maxloc([complex(CKG)::])")
31 call disp%show(
maxloc([
complex(CKG)::]) )
32 call disp%show(
"maxloc([complex(CKG)::], dim = 1_IK)")
33 call disp%show(
maxloc([
complex(CKG)::],
dim = 1_IK) )
34 call disp%show(
"maxloc([complex(CKG)::], dim = 2_IK)")
35 call disp%show(
maxloc([
complex(CKG)::],
dim = 2_IK) )
41 complex(CKG),
allocatable :: array(:,:)
45 call disp%show(
"array = getUnifRand((-9._CKG, -9._CKG), (+9._CKG, +9._CKG), ndim, nsam)")
46 array
= getUnifRand((
-9._CKG,
-9._CKG), (
+9._CKG,
+9._CKG), ndim, nsam)
51 call disp%show(
"maxloc(array, dim = 1_IK)")
52 call disp%show(
maxloc(array,
dim = 1_IK) )
53 call disp%show(
"maxloc(array, dim = 2_IK)")
54 call disp%show(
maxloc(array,
dim = 2_IK) )
55 call disp%show(
"maxloc([complex(CKG)::])")
56 call disp%show(
maxloc([
complex(CKG)::]) )
57 call disp%show(
"maxloc([complex(CKG)::], dim = 1_IK)")
58 call disp%show(
maxloc([
complex(CKG)::],
dim = 1_IK) )
59 call disp%show(
"maxloc([complex(CKG)::], dim = 2_IK)")
60 call disp%show(
maxloc([
complex(CKG)::],
dim = 2_IK) )
66 complex(CKG),
allocatable :: array(:,:)
70 call disp%show(
"array = getUnifRand((-9._CKG, -9._CKG), (+9._CKG, +9._CKG), ndim, nsam)")
71 array
= getUnifRand((
-9._CKG,
-9._CKG), (
+9._CKG,
+9._CKG), ndim, nsam)
76 call disp%show(
"maxloc(array, dim = 1_IK)")
77 call disp%show(
maxloc(array,
dim = 1_IK) )
78 call disp%show(
"maxloc(array, dim = 2_IK)")
79 call disp%show(
maxloc(array,
dim = 2_IK) )
80 call disp%show(
"maxloc([complex(CKG)::])")
81 call disp%show(
maxloc([
complex(CKG)::]) )
82 call disp%show(
"maxloc([complex(CKG)::], dim = 1_IK)")
83 call disp%show(
maxloc([
complex(CKG)::],
dim = 1_IK) )
84 call disp%show(
"maxloc([complex(CKG)::], dim = 2_IK)")
85 call disp%show(
maxloc([
complex(CKG)::],
dim = 2_IK) )
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
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 classes and procedures for computing various statistical quantities related to t...
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 CKH
The scalar integer constant of intrinsic default kind, representing the highest-precision complex kin...
integer, parameter CKS
The single-precision complex kind in Fortran mode. On most platforms, this is a 32-bit real kind.
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter CKD
The double precision complex kind in Fortran mode. On most platforms, this is a 64-bit real 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 ⛓
3array
= getUnifRand((
-9._CKG,
-9._CKG), (
+9._CKG,
+9._CKG), ndim, nsam)
5(
+3.25106597,
+1.84307480), (
+3.81602383,
-3.78438568), (
+3.62549138,
-5.45730305), (
-1.01946068,
+3.73767304), (
-8.40431023,
-3.03153443)
6(
+3.70533657,
+8.80641747), (
-4.41627312,
-6.70866108), (
+3.98268890,
-7.34395599), (
-8.39045525,
+5.69211388), (
+2.16366386,
+2.08434868)
7(
-2.47557473,
+6.20758438), (
-1.98255920,
+4.39084816), (
-5.46919441,
+8.64269257), (
+2.95076013,
+8.89157295), (
+4.15985489,
+0.425465584)
10maxloc(array,
dim = 1_IK)
13maxloc(array,
dim = 2_IK)
16maxloc([
complex(CKG)::])
18maxloc([
complex(CKG)::],
dim = 1_IK)
20maxloc([
complex(CKG)::],
dim = 2_IK)
25array
= getUnifRand((
-9._CKG,
-9._CKG), (
+9._CKG,
+9._CKG), ndim, nsam)
27(
-6.7238548848682420,
+7.4968332786530070), (
+6.4841482979647758,
+2.9940563547801027), (
+4.8119556080425330,
+0.68983492518578871), (
-1.3904435576392071,
-7.6957136846550007), (
+2.4678259005545975,
+5.6730568766820930)
28(
-5.4044108147311825,
+5.8911636130610177), (
+4.3145511374894241,
-7.7571688468227933), (
+2.5690117039972127,
-8.5798007394153153), (
-1.2969120925045430,
+6.7322657958944507), (
-7.8256166478328346,
+4.3142299009077441)
29(
-0.53821710180885773E-1,
-1.8918633582004714), (
-2.9196811789668291,
-5.1160606445671544), (
-7.8821014563248086,
+0.66912315919731924), (
+4.9971859580532794,
+2.4477175645696505), (
+1.8777132986785059,
-3.7451564173802017)
32maxloc(array,
dim = 1_IK)
35maxloc(array,
dim = 2_IK)
38maxloc([
complex(CKG)::])
40maxloc([
complex(CKG)::],
dim = 1_IK)
42maxloc([
complex(CKG)::],
dim = 2_IK)
47array
= getUnifRand((
-9._CKG,
-9._CKG), (
+9._CKG,
+9._CKG), ndim, nsam)
49(
-1.59200935758431177784479755745531631,
+3.45414453669153358432487407033909190), (
+8.94227043852094021000909893667522406,
+2.16544697587250153344720889212253063), (
-8.93923431850423848884288013146780772,
+1.72515213231882571774835950816218355), (
-6.25004022678027704787848703627274021,
+2.24291593975127116631583641064359505), (
+4.83494144210282580879314294019541273,
+4.98095341015177487629718025611140545)
50(
+5.58739230255389856061755093041662562,
+6.14567642669416749911444158188074208), (
-4.58825778337649325815415801560962752,
-8.11209907300853756746524164040851728), (
+8.30512350155458734419975920972552767,
-5.97462920229407357710074744004653975), (
+2.83386867020010482285102305056311453,
+1.55742675028552217596087644171608980), (
+7.93172435342282524644843029794558838,
-2.79697035606378722671260528208235606)
51(
-1.59146042088265835578491882947707774,
-0.194092659354632755679841369168243290E-1), (
+8.14889557352367021280301058759714594,
+4.01489296046572271828945319113406162), (
-0.531599310441796457858831556362816089,
+7.28093081144431664905786322633138586), (
+7.07428623269534176890768827875280089,
+3.36541384922714355053930625730329293), (
-1.62583253685625202749990449003865587,
-8.49746932766154158421423327010406584)
54maxloc(array,
dim = 1_IK)
57maxloc(array,
dim = 2_IK)
60maxloc([
complex(CKG)::])
62maxloc([
complex(CKG)::],
dim = 1_IK)
64maxloc([
complex(CKG)::],
dim = 2_IK)
- Test:
- test_pm_complexMinMax
- Todo:
- Normal Priority: This generic interface can be extended with optional
mask and back arguments to match those of the intrinsic maxloc().
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 1282 of file pm_complexMinMax.F90.
1.9.3