Generate and return the conversion of the input value to a logical value of default kind LK. More...

Detailed Description

Generate and return the conversion of the input value to a logical value of default kind LK.

See the documentation of setLogical for methodological details.

Parameters

[in]

val

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

whose value will be converted to an output of type logical of default kind LK.

Returns: conversion : The scalar or array of the same shape as the input val of the type logical of default kind LK, containing the conversion of the input value val.

Possible calling interfaces ⛓

: use pm_val2logical, only: getLogical

conversion = getLogical(val)

pm_val2logical::getLogical
Generate and return the conversion of the input value to a logical value of default kind LK.
Definition: pm_val2logical.F90:107

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

Remarks: The procedures under discussion are pure.; 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: LK

4 use pm_kind, only: IK

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

6 use pm_io, only: display_type

7 use pm_val2logical, only: getLogical

8

9 implicit none

10

11 integer(IK) :: iostat(3)

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 string values to logical.")

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

20 call disp%skip()

21

22 call disp%skip()

23 call disp%show("getLogical('F')")

24 call disp%show( getLogical('F') )

25 call disp%skip()

26

27 call disp%skip()

28 call disp%show("getLogical('f')")

29 call disp%show( getLogical('f') )

30 call disp%skip()

31

32 call disp%skip()

33 call disp%show("getLogical('T')")

34 call disp%show( getLogical('T') )

35 call disp%skip()

36

37 call disp%skip()

38 call disp%show("getLogical('t')")

39 call disp%show( getLogical('t') )

40 call disp%skip()

41

42 call disp%skip()

43 call disp%show("getLogical('.F.')")

44 call disp%show( getLogical('.F.') )

45 call disp%skip()

46

47 call disp%skip()

48 call disp%show("getLogical('.T.')")

49 call disp%show( getLogical('.T.') )

50 call disp%skip()

51

52 call disp%skip()

53 call disp%show("getLogical('.false.')")

54 call disp%show( getLogical('.false.') )

55 call disp%skip()

56

57 call disp%skip()

58 call disp%show("getLogical('.true.')")

59 call disp%show( getLogical('.true.') )

60 call disp%skip()

61

62 call disp%skip()

63 call disp%show("getLogical('false')")

64 call disp%show( getLogical('false') )

65 call disp%skip()

66

67 call disp%skip()

68 call disp%show("getLogical('true')")

69 call disp%show( getLogical('true') )

70 call disp%skip()

71

72 call disp%skip()

73 call disp%show("getLogical('true, false')")

74 call disp%show( getLogical('true, false') )

75 call disp%skip()

76

77 call disp%skip()

78 call disp%show("getLogical([character(5,SK) :: 'true', 'false'])")

79 call disp%show( getLogical([character(5,SK) :: 'true', 'false']) )

80 call disp%skip()

81

82 call disp%skip()

83 call disp%show("getLogical([character(5,SK) :: 't', 'F', 'TRUE'])")

84 call disp%show( getLogical([character(5,SK) :: 't', 'F', 'TRUE']) )

85 call disp%skip()

86

87 call disp%skip()

88 call disp%show("getLogical('true, paramonte')")

89 call disp%show( getLogical('true, paramonte') )

90 call disp%skip()

91

92end 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

7getLogical('F')

8F

9

10

11getLogical('f')

12F

13

14

15getLogical('T')

16T

17

18

19getLogical('t')

20T

21

22

23getLogical('.F.')

24F

25

26

27getLogical('.T.')

28T

29

30

31getLogical('.false.')

32F

33

34

35getLogical('.true.')

36T

37

38

39getLogical('false')

40F

41

42

43getLogical('true')

44T

45

46

47getLogical('true, false')

48T

49

50

51getLogical([character(5,SK) :: 'true', 'false'])

52T, F

53

54

55getLogical([character(5,SK) :: 't', 'F', 'TRUE'])

56T, F, T

57

58

59getLogical('true, paramonte')

60T

61

62

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 Austin

Definition at line 107 of file pm_val2logical.F90.

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

src/fortran/main/pm_val2logical.F90