ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_val2int::setInt Interface Reference

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

Detailed Description

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

Parameters
[out]conversion: The output scalar or array of the same shape as other array-like arguments, of type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64), containing the conversion of the input value val.
  1. If the input val is a logical that evaluates to .true., then conversion = 1, otherwise conversion = 0.
  2. 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
  1. type character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU), or
  2. type logical of kind any supported by the processor (e.g., LK), or
whose value will be converted to an output of type integer.
[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_val2int, only: setInt
call setInt(conversion, val)
call setInt(conversion, val, iostat)
Return the conversion of the input value to a integer value of arbitrary kind.
Definition: pm_val2int.F90:297
This module contains procedures and types for facilitating the conversion of values of different type...
Definition: pm_val2int.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, LK, SK ! all processor types and kinds are supported.
4 use pm_io, only: display_type
5 use pm_val2int, only: setInt
6
7 implicit none
8
9 integer(IK) :: iostat(10)
10 integer(IK) :: Conversion(10)
11
12 type(display_type) :: disp
13 disp = display_type(file = "main.out.F90")
14
15 call disp%skip()
16 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
17 call disp%show("! Convert logical values to integer.")
18 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
19 call disp%skip()
20
21 call disp%skip()
22 call disp%show("call setInt(Conversion(1), .true._LK)")
23 call setInt(Conversion(1), .true._LK)
24 call disp%show("Conversion(1)")
25 call disp%show( Conversion(1) )
26 call disp%skip()
27
28 call disp%skip()
29 call disp%show("call setInt(Conversion(1), .false._LK)")
30 call setInt(Conversion(1), .false._LK)
31 call disp%show("Conversion(1)")
32 call disp%show( Conversion(1) )
33 call disp%skip()
34
35 call disp%skip()
36 call disp%show("call setInt(Conversion(1:3), [.true._LK, .false._LK, .true._LK])")
37 call setInt(Conversion(1:3), [.true._LK, .false._LK, .true._LK])
38 call disp%show("Conversion(1:3)")
39 call disp%show( Conversion(1:3) )
40 call disp%skip()
41
42 call disp%skip()
43 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
44 call disp%show("! Convert string values to real.")
45 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
46 call disp%skip()
47
48 call disp%skip()
49 call disp%show("call setInt(Conversion(1), SK_'1')")
50 call setInt(Conversion(1), SK_'1')
51 call disp%show("Conversion(1)")
52 call disp%show( Conversion(1) )
53 call disp%skip()
54
55 call disp%skip()
56 call disp%show("call setInt(Conversion(1), SK_'1')")
57 call setInt(Conversion(1), SK_'1')
58 call disp%show("Conversion(1)")
59 call disp%show( Conversion(1) )
60 call disp%skip()
61
62 call disp%skip()
63 call disp%show("call setInt(Conversion(1:2), SK_'1 -1')")
64 call setInt(Conversion(1:2), SK_'1 -1')
65 call disp%show("Conversion(1)")
66 call disp%show( Conversion(1) )
67 call disp%skip()
68
69 call disp%skip()
70 call disp%show("call setInt(Conversion(1), SK_'1, -1')")
71 call setInt(Conversion(1), SK_'1, -1')
72 call disp%show("Conversion(1)")
73 call disp%show( Conversion(1) )
74 call disp%skip()
75
76 call disp%skip()
77 call disp%show("call setInt(Conversion(1:3), [character(10,SK) :: '-1', '10', '100, -100'])")
78 call setInt(Conversion(1:3), [character(10,SK) :: '-1', '10', '100, -100'])
79 call disp%show("Conversion(1:3)")
80 call disp%show( Conversion(1:3) )
81 call disp%skip()
82
83 call disp%skip()
84 call disp%show("call setInt(Conversion(1), SK_'1, paramonte', iostat(1))")
85 call setInt(Conversion(1), SK_'1, paramonte', iostat(1))
86 call disp%show("Conversion(1)")
87 call disp%show( Conversion(1) )
88 call disp%show("iostat(1)")
89 call disp%show( iostat(1) )
90 call disp%skip()
91
92 call disp%skip()
93 call disp%show("call setInt(Conversion(1), SK_'1', iostat(1))")
94 call setInt(Conversion(1), SK_'1', iostat(1))
95 call disp%show("Conversion(1)")
96 call disp%show( Conversion(1) )
97 call disp%show("iostat(1)")
98 call disp%show( iostat(1) )
99 call disp%skip()
100
101 call disp%skip()
102 call disp%show("call setInt(Conversion(1:4), [character(10,SK) :: '1, -1', '1, paramonte', '100, -100', 'paramonte, 1'], iostat(1:4))")
103 call setInt(Conversion(1:4), [character(10,SK) :: '1, -1', '1, paramonte', '100, -100', 'paramonte, 1'], iostat(1:4))
104 call disp%show("Conversion(1:3) ! excluding the last one because it is an illegal read.")
105 call disp%show( Conversion(1:3) )
106 call disp%show("iostat(1:4)")
107 call disp%show( iostat(1:4) )
108 call disp%skip()
109
110 call disp%skip()
111 call disp%show("call setInt(Conversion(1), SK_'paramonte', iostat(1))")
112 call setInt(Conversion(1), SK_'paramonte', iostat(1))
113 call disp%show("iostat(1)")
114 call disp%show( iostat(1) )
115 call disp%skip()
116
117end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
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
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
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 integer.
4!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5
6
7call setInt(Conversion(1), .true._LK)
8Conversion(1)
9+1
10
11
12call setInt(Conversion(1), .false._LK)
13Conversion(1)
14+0
15
16
17call setInt(Conversion(1:3), [.true._LK, .false._LK, .true._LK])
18Conversion(1:3)
19+1, +0, +1
20
21
22!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
23! Convert string values to real.
24!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25
26
27call setInt(Conversion(1), SK_'1')
28Conversion(1)
29+1
30
31
32call setInt(Conversion(1), SK_'1')
33Conversion(1)
34+1
35
36
37call setInt(Conversion(1:2), SK_'1 -1')
38Conversion(1)
39+1
40
41
42call setInt(Conversion(1), SK_'1, -1')
43Conversion(1)
44+1
45
46
47call setInt(Conversion(1:3), [character(10,SK) :: '-1', '10', '100, -100'])
48Conversion(1:3)
49-1, +10, +100
50
51
52call setInt(Conversion(1), SK_'1, paramonte', iostat(1))
53Conversion(1)
54+1
55iostat(1)
56+0
57
58
59call setInt(Conversion(1), SK_'1', iostat(1))
60Conversion(1)
61+1
62iostat(1)
63+0
64
65
66call setInt(Conversion(1:4), [character(10,SK) :: '1, -1', '1, paramonte', '100, -100', 'paramonte, 1'], iostat(1:4))
67Conversion(1:3) ! excluding the last one because it is an illegal read.
68+1, +1, +100
69iostat(1:4)
70+0, +0, +0, +5010
71
72
73call setInt(Conversion(1), SK_'paramonte', iostat(1))
74iostat(1)
75+5010
76
77
Test:
test_pm_val2int


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.

  1. 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.
  2. 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.

Author:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 297 of file pm_val2int.F90.


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