Generate and return the component-wise maximum value of (both real and imaginary parts of) the input complex. More...

Detailed Description

Generate and return the component-wise maximum value of (both real and imaginary parts of) the input complex.

This generic interfaces extends the behavior of the intrinsic Fortran maxval(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 maximum must be computed. (optional. If missing, the output value is a scalar containing the maximum of the entire input `array`.)

Returns: val : The output object of the same type and kind as the input array of rank rank(array) - 1 whose real and imaginary parts are the maximum values of the corresponding real and imaginary parts of the input array.
The returned values are -huge(real(0, kind(array)) if the input array has zero size along the dimension of interest.

Possible calling interfaces ⛓

: use pm_complexMinMax, only: maxval

val = maxval(array) ! = cmplx(maxval(array%re), maxval(array%im), kind(array))

val = maxval(array, dim) ! = cmplx(maxval(array%re, dim), maxval(array%im, dim), kind(array))

pm_complexMinMax::maxval
Generate and return the component-wise maximum value of (both real and imaginary parts of) the input ...
Definition: pm_complexMinMax.F90:646

pm_complexMinMax
This module contains procedures and generic interfaces for computing element-wise minimum/maximum val...
Definition: pm_complexMinMax.F90:45

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 ⛓

: 1program example

2

3 use pm_kind, only: SK, IK

4 use pm_complexMinMax, only: maxval

5 use pm_distUnif, only: getUnifRand

6 use pm_io, only: display_type

7

8 implicit none

9

10 integer(IK) :: ndim, nsam

11 type(display_type) :: disp

12 disp = display_type(file = "main.out.F90")

13

14 block

15 use pm_kind, only: CKG => CKS

16 complex(CKG), allocatable :: array(:,:)

17 call disp%skip()

18 call disp%show("ndim = 3; nsam = 5")

19 ndim = 3; nsam = 5

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)

22 call disp%show("array")

23 call disp%show( array )

24 call disp%show("maxval(array)")

25 call disp%show( maxval(array) )

26 call disp%show("maxval(array, dim = 1_IK)")

27 call disp%show( maxval(array, dim = 1_IK) )

28 call disp%show("maxval(array, dim = 2_IK)")

29 call disp%show( maxval(array, dim = 2_IK) )

30 call disp%show("maxval([complex(CKG)::])")

31 call disp%show( maxval([complex(CKG)::]) )

32 call disp%show("maxval([complex(CKG)::], dim = 1_IK)")

33 call disp%show( maxval([complex(CKG)::], dim = 1_IK) )

34 call disp%show("maxval([complex(CKG)::], dim = 2_IK)")

35 call disp%show( maxval([complex(CKG)::], dim = 2_IK) )

36 call disp%skip()

37 end block

38

39 block

40 use pm_kind, only: CKG => CKD

41 complex(CKG), allocatable :: array(:,:)

42 call disp%skip()

43 call disp%show("ndim = 3; nsam = 5")

44 ndim = 3; nsam = 5

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)

47 call disp%show("array")

48 call disp%show( array )

49 call disp%show("maxval(array)")

50 call disp%show( maxval(array) )

51 call disp%show("maxval(array, dim = 1_IK)")

52 call disp%show( maxval(array, dim = 1_IK) )

53 call disp%show("maxval(array, dim = 2_IK)")

54 call disp%show( maxval(array, dim = 2_IK) )

55 call disp%show("maxval([complex(CKG)::])")

56 call disp%show( maxval([complex(CKG)::]) )

57 call disp%show("maxval([complex(CKG)::], dim = 1_IK)")

58 call disp%show( maxval([complex(CKG)::], dim = 1_IK) )

59 call disp%show("maxval([complex(CKG)::], dim = 2_IK)")

60 call disp%show( maxval([complex(CKG)::], dim = 2_IK) )

61 call disp%skip()

62 end block

63

64 block

65 use pm_kind, only: CKG => CKH

66 complex(CKG), allocatable :: array(:,:)

67 call disp%skip()

68 call disp%show("ndim = 3; nsam = 5")

69 ndim = 3; nsam = 5

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)

72 call disp%show("array")

73 call disp%show( array )

74 call disp%show("maxval(array)")

75 call disp%show( maxval(array) )

76 call disp%show("maxval(array, dim = 1_IK)")

77 call disp%show( maxval(array, dim = 1_IK) )

78 call disp%show("maxval(array, dim = 2_IK)")

79 call disp%show( maxval(array, dim = 2_IK) )

80 call disp%show("maxval([complex(CKG)::])")

81 call disp%show( maxval([complex(CKG)::]) )

82 call disp%show("maxval([complex(CKG)::], dim = 1_IK)")

83 call disp%show( maxval([complex(CKG)::], dim = 1_IK) )

84 call disp%show("maxval([complex(CKG)::], dim = 2_IK)")

85 call disp%show( maxval([complex(CKG)::], dim = 2_IK) )

86 call disp%skip()

87 end block

88

89end program example

pm_distUnif::getUnifRand
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
Definition: pm_distUnif.F90:4150

pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726

pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508

pm_distUnif
This module contains classes and procedures for computing various statistical quantities related to t...
Definition: pm_distUnif.F90:274

pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252

pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::CKH
integer, parameter CKH
The scalar integer constant of intrinsic default kind, representing the highest-precision complex kin...
Definition: pm_kind.F90:843

pm_kind::CKS
integer, parameter CKS
The single-precision complex kind in Fortran mode. On most platforms, this is a 32-bit real kind.
Definition: pm_kind.F90:570

pm_kind::IK
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540

pm_kind::CKD
integer, parameter CKD
The double precision complex kind in Fortran mode. On most platforms, this is a 64-bit real kind.
Definition: pm_kind.F90:571

pm_kind::SK
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539

pm_io::display_type
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe

2set PATH=..\..\..\lib;%PATH%

3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe

4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example output ⛓
1

2ndim = 3; nsam = 5

3array = getUnifRand((-9._CKG, -9._CKG), (+9._CKG, +9._CKG), ndim, nsam)

4array

5(+4.98613071, -7.90774536), (+6.47559929, -7.35971498), (-8.58624458, +4.63791466), (-1.71218395, -6.12460709), (+8.96379852, -0.503336906)

6(-1.59380913, -6.91925240), (+6.01080894, +5.34035301), (-4.45245647, -5.66381073), (-6.29949760, -0.227310181), (-0.270719528, -1.27799225)

7(+4.89041138, -6.62820530), (-7.15019035, -2.63439727), (-5.61876011, +8.86721992), (-3.04657650, -4.68438339), (-3.18099689, +8.37940598)

8maxval(array)

9(+8.96379852, +8.86721992)

10maxval(array, dim = 1_IK)

11(+4.98613071, -6.62820530), (+6.47559929, +5.34035301), (-4.45245647, +8.86721992), (-1.71218395, -0.227310181), (+8.96379852, +8.37940598)

12maxval(array, dim = 2_IK)

13(+8.96379852, +4.63791466), (+6.01080894, +5.34035301), (+4.89041138, +8.86721992)

14maxval([complex(CKG)::])

15(-0.340282347E+39, -0.340282347E+39)

16maxval([complex(CKG)::], dim = 1_IK)

17(-0.340282347E+39, -0.340282347E+39)

18maxval([complex(CKG)::], dim = 2_IK)

19(-0.340282347E+39, -0.340282347E+39)

20

21

22ndim = 3; nsam = 5

23array = getUnifRand((-9._CKG, -9._CKG), (+9._CKG, +9._CKG), ndim, nsam)

24array

25(+6.6035235102358136, -5.1459447463353420), (-6.3030761068538048, -0.83780594159309274), (+1.8494297920031020, -7.4320406311128941), (+2.6834274204128223, +3.8924378462712994), (-2.5569831361480282, -1.2609126711421941)

26(+0.43693535826103513, -0.52730625462410430), (+0.56461291008886327, +2.3012681416644725), (-5.3786209981009989, +1.0511039494711341), (+2.5552815783184273, +4.3601669669397793), (-3.5176972502124997, +6.3515716708991246)

27(-5.7934334767803222, +1.8554368302290070), (+3.4075464837574305, +2.1281886629540518), (-6.4319523724280483, -8.5380935880782545), (+8.1987665108200645, +7.1523921223759457), (+5.8025997237926532, -6.7653322849587987)

28maxval(array)

29(+8.1987665108200645, +7.1523921223759457)

30maxval(array, dim = 1_IK)

31(+6.6035235102358136, +1.8554368302290070), (+3.4075464837574305, +2.3012681416644725), (+1.8494297920031020, +1.0511039494711341), (+8.1987665108200645, +7.1523921223759457), (+5.8025997237926532, +6.3515716708991246)

32maxval(array, dim = 2_IK)

33(+6.6035235102358136, +3.8924378462712994), (+2.5552815783184273, +6.3515716708991246), (+8.1987665108200645, +7.1523921223759457)

34maxval([complex(CKG)::])

35(-0.17976931348623157E+309, -0.17976931348623157E+309)

36maxval([complex(CKG)::], dim = 1_IK)

37(-0.17976931348623157E+309, -0.17976931348623157E+309)

38maxval([complex(CKG)::], dim = 2_IK)

39(-0.17976931348623157E+309, -0.17976931348623157E+309)

40

41

42ndim = 3; nsam = 5

43array = getUnifRand((-9._CKG, -9._CKG), (+9._CKG, +9._CKG), ndim, nsam)

44array

45(-1.47645141984182132468583999928938141, -0.975873832347476271896211509599653671), (+4.99714018188188692300937188227086363, -2.96974576160889192558111312612839003), (-3.86978707321398622359933109306748415, +1.19988812664502445164126284394434243), (+4.53666560038896627073537282116857834, +7.75275355205168139972619004922339525), (+2.80635376416265221717115608195158470, -2.71327587258373292372528662821402512)

46(+6.56896307811458412511954125733493701, -3.21257505375069635073043570583486465), (-6.95248523825611544781501498349802479, -4.29679185164063011586225922265441340), (-2.43209731289396222640159497975223661, +3.41932664720168340726248201767926719), (-0.428735687638731476271827124756563693E-1, +4.15130373826418105485016235720095870), (-3.91328237583352152920254918360884801, -4.43892799545066427894876120385610959)

47(-0.495327964437086495536726090103661703, +7.88138959622369454180610773633328960), (+5.78018558430469914359453470538646636, +0.261009144202971982968996049457890242), (-5.46060242598340455290024997889844682, -7.67955312228845216797221948140042216), (-5.62779401414282172505383351823022791, +0.199109210840091651969323470199762302), (-0.103154874644492047264027739657361087, -6.72657395163448153236414820897434701)

48maxval(array)

49(+6.56896307811458412511954125733493701, +7.88138959622369454180610773633328960)

50maxval(array, dim = 1_IK)

51(+6.56896307811458412511954125733493701, +7.88138959622369454180610773633328960), (+5.78018558430469914359453470538646636, +0.261009144202971982968996049457890242), (-2.43209731289396222640159497975223661, +3.41932664720168340726248201767926719), (+4.53666560038896627073537282116857834, +7.75275355205168139972619004922339525), (+2.80635376416265221717115608195158470, -2.71327587258373292372528662821402512)

52maxval(array, dim = 2_IK)

53(+4.99714018188188692300937188227086363, +7.75275355205168139972619004922339525), (+6.56896307811458412511954125733493701, +4.15130373826418105485016235720095870), (+5.78018558430469914359453470538646636, +7.88138959622369454180610773633328960)

54maxval([complex(CKG)::])

55(-0.118973149535723176508575932662800702E+4933, -0.118973149535723176508575932662800702E+4933)

56maxval([complex(CKG)::], dim = 1_IK)

57(-0.118973149535723176508575932662800702E+4933, -0.118973149535723176508575932662800702E+4933)

58maxval([complex(CKG)::], dim = 2_IK)

59(-0.118973149535723176508575932662800702E+4933, -0.118973149535723176508575932662800702E+4933)

60

61

Test:: test_pm_complexMinMax

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 646 of file pm_complexMinMax.F90.

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

src/fortran/main/pm_complexMinMax.F90