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

Detailed Description

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

Parameters

[out]	conversion	: The output scalar or array of the same shape as other array-like arguments, of type `logical` of kind any supported by the processor (e.g., LK), containing the conversion of the input value `val`. 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 type `character` of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU), whose value will be converted to an output of type `logical`.
[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_val2logical, only: setLogical

call setLogical(conversion, val)

call setLogical(conversion, val, iostat)

pm_val2logical::setLogical
Return the conversion of the input value to a logical value of arbitrary kind.
Definition: pm_val2logical.F90:237

pm_val2logical
This module contains procedures and types for facilitating the conversion of values of different type...
Definition: pm_val2logical.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
setStr
getInt
setInt
getLogical
setLogical
getComplex
setComplex
getReal
setReal

Example usage ⛓

: 1program example

2

3 use pm_kind, only: IK

4 use pm_kind, only: SK ! all other string kinds are also supported.

5 use pm_kind, only: LK ! all other logical kinds are also supported.

6 use pm_io, only: display_type

7 use pm_val2logical, only: setLogical

8

9 implicit none

10

11 logical(LK) :: Conversion(10)

12 integer(IK) :: iostat(10)

13

14 type(display_type) :: disp

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

16

17 call disp%skip()

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

19 call disp%show("! Convert string values to logical.")

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

21 call disp%skip()

22

23 call disp%skip()

24 call disp%show("call setLogical(Conversion(1), 'F')")

25 call setLogical(Conversion(1), 'F')

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

27 call disp%show( Conversion(1) )

28 call disp%skip()

29

30 call disp%skip()

31 call disp%show("call setLogical(Conversion(1), 'f')")

32 call setLogical(Conversion(1), 'f')

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

34 call disp%show( Conversion(1) )

35 call disp%skip()

36

37 call disp%skip()

38 call disp%show("call setLogical(Conversion(1), 'T')")

39 call setLogical(Conversion(1), 'T')

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

41 call disp%show( Conversion(1) )

42 call disp%skip()

43

44 call disp%skip()

45 call disp%show("call setLogical(Conversion(1), 't')")

46 call setLogical(Conversion(1), 't')

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

48 call disp%show( Conversion(1) )

49 call disp%skip()

50

51 call disp%skip()

52 call disp%show("call setLogical(Conversion(1), '.F.')")

53 call setLogical(Conversion(1), '.F.')

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

55 call disp%show( Conversion(1) )

56 call disp%skip()

57

58 call disp%skip()

59 call disp%show("call setLogical(Conversion(1), '.T.')")

60 call setLogical(Conversion(1), '.T.')

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

62 call disp%show( Conversion(1) )

63 call disp%skip()

64

65 call disp%skip()

66 call disp%show("call setLogical(Conversion(1), '.false.')")

67 call setLogical(Conversion(1), '.false.')

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

69 call disp%show( Conversion(1) )

70 call disp%skip()

71

72 call disp%skip()

73 call disp%show("call setLogical(Conversion(1), '.true.')")

74 call setLogical(Conversion(1), '.true.')

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

76 call disp%show( Conversion(1) )

77 call disp%skip()

78

79 call disp%skip()

80 call disp%show("call setLogical(Conversion(1), 'false')")

81 call setLogical(Conversion(1), 'false')

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

83 call disp%show( Conversion(1) )

84 call disp%skip()

85

86 call disp%skip()

87 call disp%show("call setLogical(Conversion(1), 'true')")

88 call setLogical(Conversion(1), 'true')

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

90 call disp%show( Conversion(1) )

91 call disp%skip()

92

93 call disp%skip()

94 call disp%show("call setLogical(Conversion(1), 'true, false')")

95 call setLogical(Conversion(1), 'true, false')

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

97 call disp%show( Conversion(1) )

98 call disp%skip()

99

100 call disp%skip()

101 call disp%show("call setLogical(Conversion(1:2), [character(5,SK) :: 'true', 'false'])")

102 call setLogical(Conversion(1:2), [character(5,SK) :: 'true', 'false'])

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

104 call disp%show( Conversion(1:2) )

105 call disp%skip()

106

107 call disp%skip()

108 call disp%show("call setLogical(Conversion(1), 'true, paramonte', iostat(1))")

109 call setLogical(Conversion(1), 'true, paramonte', iostat(1))

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

111 call disp%show( Conversion(1) )

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

113 call disp%show( iostat(1) )

114 call disp%skip()

115

116 call disp%skip()

117 call disp%show("call setLogical(Conversion(1), 'paramonte, true', iostat(1))")

118 call setLogical(Conversion(1), 'paramonte, true', iostat(1))

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

120 call disp%show( Conversion(1) )

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

122 call disp%show( iostat(1) )

123 call disp%skip()

124

125 call disp%skip()

126 call disp%show("call setLogical(Conversion(1:3), [character(5,SK) :: 't', 'F', 'TRUE'])")

127 call setLogical(Conversion(1:3), [character(5,SK) :: 't', 'F', 'TRUE'])

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

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

130 call disp%skip()

131

132 call disp%skip()

133 call disp%show("call setLogical(Conversion(1:3), [character(10,SK) :: 'F', 'True', 'paramonte'], iostat(1:3))")

134 call setLogical(Conversion(1:3), [character(10,SK) :: 'F', 'True', 'paramonte'], iostat(1:3))

135 call disp%show("Conversion(1:2) ! Do not print the last element since it was an illegal conversion.")

136 call disp%show( Conversion(1:2) )

137 call disp%show("iostat(1:3)")

138 call disp%show( iostat(1:3) )

139 call disp%skip()

140

141end 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::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 string values to logical.

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

5

6

7call setLogical(Conversion(1), 'F')

8Conversion(1)

9F

10

11

12call setLogical(Conversion(1), 'f')

13Conversion(1)

14F

15

16

17call setLogical(Conversion(1), 'T')

18Conversion(1)

19T

20

21

22call setLogical(Conversion(1), 't')

23Conversion(1)

24T

25

26

27call setLogical(Conversion(1), '.F.')

28Conversion(1)

29F

30

31

32call setLogical(Conversion(1), '.T.')

33Conversion(1)

34T

35

36

37call setLogical(Conversion(1), '.false.')

38Conversion(1)

39F

40

41

42call setLogical(Conversion(1), '.true.')

43Conversion(1)

44T

45

46

47call setLogical(Conversion(1), 'false')

48Conversion(1)

49F

50

51

52call setLogical(Conversion(1), 'true')

53Conversion(1)

54T

55

56

57call setLogical(Conversion(1), 'true, false')

58Conversion(1)

59T

60

61

62call setLogical(Conversion(1:2), [character(5,SK) :: 'true', 'false'])

63Conversion(1:2)

64T, F

65

66

67call setLogical(Conversion(1), 'true, paramonte', iostat(1))

68Conversion(1)

69T

70iostat(1)

71+0

72

73

74call setLogical(Conversion(1), 'paramonte, true', iostat(1))

75Conversion(1)

76T

77iostat(1)

78+5010

79

80

81call setLogical(Conversion(1:3), [character(5,SK) :: 't', 'F', 'TRUE'])

82Conversion(1:3)

83T, F, T

84

85

86call setLogical(Conversion(1:3), [character(10,SK) :: 'F', 'True', 'paramonte'], iostat(1:3))

87Conversion(1:2) ! Do not print the last element since it was an illegal conversion.

88F, T

89iostat(1:3)

90+0, +0, +5010

91

92

Test:: test_pm_val2logical

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 at Austin

Definition at line 237 of file pm_val2logical.F90.

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

src/fortran/main/pm_val2logical.F90