Return the conversion of the input value to a complex value of arbitrary kind. More...

Detailed Description

Return the conversion of the input value to a complex value of arbitrary kind.

Parameters

[out]	conversion	: The output scalar or array of the same shape as other array-like arguments, of type `complex` of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128), containing the conversion of the input value `val`. If the input `val` is a `logical` that evaluates to `.true.`, then `conversion = (1., 1.)`, otherwise `conversion = (0., 0.)`. If the input `val` is a `character`, then `conversion` is the result of the List-directed I/O action `read(val,*) conversion`.
[in]	val	: The input scalar or array of the same shape as other array-like arguments, of either type `character` of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU), or type `logical` of kind any supported by the processor (e.g., LK), whose value will be converted to an output of type `complex`.
[out]	iostat	: The output `integer` of default kind IK, of the same rank as the input `val` containing the Fortran IO status error code returned by the `read()` statement of the Fortran standard. On return, it is zero if and only if no error occurs during the execution of the Fortran `read()` statement. Refer to the Fortran standard `read/write` statements for the meaning of different non-zero output values for `iostat`. (optional, it can be present only if `val` is of type `character`. if missing, the program will halt upon an IO error.)

Possible calling interfaces ⛓

: use pm_val2complex, only: setComplex

call setComplex(conversion, val)

call setComplex(conversion, val, iostat)

pm_val2complex::setComplex
Return the conversion of the input value to a complex value of arbitrary kind.
Definition: pm_val2complex.F90:300

pm_val2complex
This module contains procedures and types for facilitating the conversion of values of different type...
Definition: pm_val2complex.F90:43

Warning: When the input val is an array, the output iostat, if present, must also be a vector of the same shape and size as val.

Remarks: The procedures under discussion are pure.; The purity of the procedures under this generic interface break when the output argument iostat is present.; The procedures under discussion are elemental.

See also: getStr
getInt
setInt
getReal
setReal
getComplex
setComplex
getLogical
setLogical

Example usage ⛓

: 1program example

2

3 use pm_kind, only: IK

4 use pm_kind, only: CK => CKS, LK, SK ! all processor types and kinds are supported.

5 use pm_io, only: display_type

6 use pm_val2complex, only: setComplex

7

8 implicit none

9

10 integer(IK) :: iostat(10)

11 complex(CK) :: Conversion(10)

12

13 type(display_type) :: disp

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

15

16 call disp%skip()

17 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

18 call disp%show("! Convert logical values to complex.")

19 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

20 call disp%skip()

21

22 call disp%skip()

23 call disp%show("call setComplex(Conversion(1), .true._LK)")

24 call setComplex(Conversion(1), .true._LK)

25 call disp%show("Conversion(1)")

26 call disp%show( Conversion(1) )

27 call disp%skip()

28

29 call disp%skip()

30 call disp%show("call setComplex(Conversion(1), .false._LK)")

31 call setComplex(Conversion(1), .false._LK)

32 call disp%show("Conversion(1)")

33 call disp%show( Conversion(1) )

34 call disp%skip()

35

36 call disp%skip()

37 call disp%show("call setComplex(Conversion(1:3), [.true._LK, .false._LK, .true._LK])")

38 call setComplex(Conversion(1:3), [.true._LK, .false._LK, .true._LK])

39 call disp%show("Conversion(1:3)")

40 call disp%show( Conversion(1:3) )

41 call disp%skip()

42

43 call disp%skip()

44 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

45 call disp%show("! Convert string values to complex.")

46 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

47 call disp%skip()

48

49 call disp%skip()

50 call disp%show("call setComplex(Conversion(1), SK_'1.e0')")

51 call setComplex(Conversion(1), SK_'1.e0')

52 call disp%show("Conversion(1)")

53 call disp%show( Conversion(1) )

54 call disp%skip()

55

56 call disp%skip()

57 call disp%show("call setComplex(Conversion(1), SK_'1.d0')")

58 call setComplex(Conversion(1), SK_'1.d0')

59 call disp%show("Conversion(1)")

60 call disp%show( Conversion(1) )

61 call disp%skip()

62

63 call disp%skip()

64 call disp%show("call setComplex(Conversion(1:2), SK_'1.d0 -1.d0')")

65 call setComplex(Conversion(1:2), SK_'1.d0 -1.d0')

66 call disp%show("Conversion(1)")

67 call disp%show( Conversion(1) )

68 call disp%skip()

69

70 call disp%skip()

71 call disp%show("call setComplex(Conversion(1), SK_'1.d0, -1.d0')")

72 call setComplex(Conversion(1), SK_'1.d0, -1.d0')

73 call disp%show("Conversion(1)")

74 call disp%show( Conversion(1) )

75 call disp%skip()

76

77 call disp%skip()

78 call disp%show("call setComplex(Conversion(1), SK_'(1.d0, -1.d0)')")

79 call setComplex(Conversion(1), SK_'(1.d0, -1.d0)')

80 call disp%show("Conversion(1)")

81 call disp%show( Conversion(1) )

82 call disp%skip()

83

84 call disp%skip()

85 call disp%show("call setComplex(Conversion(1:3), [character(10,SK) :: '(1, -1)', '10', '100, -100'])")

86 call setComplex(Conversion(1:3), [character(10,SK) :: '(1, -1)', '10', '100, -100'])

87 call disp%show("Conversion(1:3)")

88 call disp%show( Conversion(1:3) )

89 call disp%skip()

90

91 call disp%skip()

92 call disp%show("call setComplex(Conversion(1), SK_'(1.d0, -1.e0)', iostat(1))")

93 call setComplex(Conversion(1), SK_'(1.d0, -1.e0)', iostat(1))

94 call disp%show("Conversion(1)")

95 call disp%show( Conversion(1) )

96 call disp%show("iostat(1)")

97 call disp%show( iostat(1) )

98 call disp%skip()

99

100 call disp%skip()

101 call disp%show("call setComplex(Conversion(1), SK_'(1., -1.), paramonte', iostat(1))")

102 call setComplex(Conversion(1), SK_'(1., -1.), paramonte', iostat(1))

103 call disp%show("Conversion(1)")

104 call disp%show( Conversion(1) )

105 call disp%show("iostat(1)")

106 call disp%show( iostat(1) )

107 call disp%skip()

108

109 call disp%skip()

110 call disp%show("call setComplex(Conversion(1), SK_'1., -1., paramonte', iostat(1))")

111 call setComplex(Conversion(1), SK_'1., -1., paramonte', iostat(1))

112 call disp%show("Conversion(1)")

113 call disp%show( Conversion(1) )

114 call disp%show("iostat(1)")

115 call disp%show( iostat(1) )

116 call disp%skip()

117

118 call disp%skip()

119 call disp%show("call setComplex(Conversion(1), SK_'1., paramonte', iostat(1))")

120 call setComplex(Conversion(1), SK_'1., paramonte', iostat(1))

121 call disp%show("Conversion(1)")

122 call disp%show( Conversion(1) )

123 call disp%show("iostat(1)")

124 call disp%show( iostat(1) )

125 call disp%skip()

126

127 call disp%skip()

128 call disp%show("call setComplex(Conversion(1), SK_'1.d0', iostat(1))")

129 call setComplex(Conversion(1), SK_'1.d0', iostat(1))

130 call disp%show("Conversion(1)")

131 call disp%show( Conversion(1) )

132 call disp%show("iostat(1)")

133 call disp%show( iostat(1) )

134 call disp%skip()

135

136 call disp%skip()

137 call disp%show("call setComplex(Conversion(1:4), [character(10,SK) :: '1, -1', '1, paramonte', '100, -100', 'paramonte, 1'], iostat(1:4))")

138 call setComplex(Conversion(1:4), [character(10,SK) :: '1, -1', '1, paramonte', '100, -100', 'paramonte, 1'], iostat(1:4))

139 call disp%show("Conversion(1:3)")

140 call disp%show( Conversion(1:3) )

141 call disp%show("iostat(1:4)")

142 call disp%show( iostat(1:4) )

143 call disp%skip()

144

145 call disp%skip()

146 call disp%show("call setComplex(Conversion(1), SK_'paramonte', iostat(1))")

147 call setComplex(Conversion(1), SK_'paramonte', iostat(1))

148 call disp%show("iostat(1)")

149 call disp%show( iostat(1) )

150 call disp%skip()

151

152end program example

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_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::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541

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::CK
integer, parameter CK
The default complex kind in the ParaMonte library: real64 in Fortran, c_double_complex in C-Fortran I...
Definition: pm_kind.F90:542

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::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

2!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

3! Convert logical values to complex.

4!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

5

6

7call setComplex(Conversion(1), .true._LK)

8Conversion(1)

9(+1.00000000, +1.00000000)

10

11

12call setComplex(Conversion(1), .false._LK)

13Conversion(1)

14(+0.00000000, +0.00000000)

15

16

17call setComplex(Conversion(1:3), [.true._LK, .false._LK, .true._LK])

18Conversion(1:3)

19(+1.00000000, +1.00000000), (+0.00000000, +0.00000000), (+1.00000000, +1.00000000)

20

21

22!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

23! Convert string values to complex.

24!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

25

26

27call setComplex(Conversion(1), SK_'1.e0')

28Conversion(1)

29(+1.00000000, +0.00000000)

30

31

32call setComplex(Conversion(1), SK_'1.d0')

33Conversion(1)

34(+1.00000000, +0.00000000)

35

36

37call setComplex(Conversion(1:2), SK_'1.d0 -1.d0')

38Conversion(1)

39(+1.00000000, -1.00000000)

40

41

42call setComplex(Conversion(1), SK_'1.d0, -1.d0')

43Conversion(1)

44(+1.00000000, -1.00000000)

45

46

47call setComplex(Conversion(1), SK_'(1.d0, -1.d0)')

48Conversion(1)

49(+1.00000000, -1.00000000)

50

51

52call setComplex(Conversion(1:3), [character(10,SK) :: '(1, -1)', '10', '100, -100'])

53Conversion(1:3)

54(+1.00000000, -1.00000000), (+10.0000000, +0.00000000), (+100.000000, -100.000000)

55

56

57call setComplex(Conversion(1), SK_'(1.d0, -1.e0)', iostat(1))

58Conversion(1)

59(+1.00000000, -1.00000000)

60iostat(1)

61+0

62

63

64call setComplex(Conversion(1), SK_'(1., -1.), paramonte', iostat(1))

65Conversion(1)

66(+1.00000000, -1.00000000)

67iostat(1)

68+0

69

70

71call setComplex(Conversion(1), SK_'1., -1., paramonte', iostat(1))

72Conversion(1)

73(+1.00000000, -1.00000000)

74iostat(1)

75+0

76

77

78call setComplex(Conversion(1), SK_'1., paramonte', iostat(1))

79Conversion(1)

80(+1.00000000, +0.00000000)

81iostat(1)

82+0

83

84

85call setComplex(Conversion(1), SK_'1.d0', iostat(1))

86Conversion(1)

87(+1.00000000, +0.00000000)

88iostat(1)

89+0

90

91

92call setComplex(Conversion(1:4), [character(10,SK) :: '1, -1', '1, paramonte', '100, -100', 'paramonte, 1'], iostat(1:4))

93Conversion(1:3)

94(+1.00000000, -1.00000000), (+1.00000000, +0.00000000), (+100.000000, -100.000000)

95iostat(1:4)

96+0, +0, +0, +5010

97

98

99call setComplex(Conversion(1), SK_'paramonte', iostat(1))

100iostat(1)

101+5010

102

103

Test:: test_pm_val2complex

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 300 of file pm_val2complex.F90.

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

src/fortran/main/pm_val2complex.F90