ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_io::display_type Type Reference

Generate and return an object of type display_type. More...

Public Attributes

integer(IK), public width = -huge(0_IK)
 The scalar integer of default kind IK containing the width of the runtime Shell screen or -huge(0_IK) if the inference fails or the display is not the standard output output_unit. More...
 
integer(IK), public height = -huge(0_IK)
 The scalar integer of default kind IK containing the height of the runtime Shell screen or -huge(0_IK) if the inference fails or the display is not the standard output output_unit. More...
 
integer(IK), public tmsize = 0_IK
 The scalar integer of default kind IK containing the number of records to skip on top of the current record. More...
 
integer(IK), public count = 1_IK
 The scalar integer of default kind IK containing the number of times to repeat the current record. More...
 
integer(IK), public bmsize = 0_IK
 The scalar integer of default kind IK containing the number of records to skip on the bottom of the current record. More...
 
integer(IK), public unit = output_unit
 The scalar integer of default kind IK containing the unit number of the file to which the record must be written. More...
 
character(3, SK), public advance = SK_"YES"
 The scalar character of default kind SK containing the default IO advance mode for reading/writing actions. More...
 
character(:, SK), allocatable, public file
 The scalar character of default kind SK containing the file path to which the record must be written. More...
 
type(field_type), public format
 The scalar character of default kind SK containing the default IO format with which the records should be displayed. More...
 
type(field_type), public deliml
 The scalar object of type field_type containing the left-delimiters for objects of various types. More...
 
type(field_type), public delimr
 The scalar object of type field_type containing the right-delimiters for objects of various types. More...
 
type(wrap_type), public text
 The scalar of type wrap_type containing the runtime settings and a method to wrap strings within a fixed width. More...
 
type(mark_type), public mark
 The scalar of type mark_type containing the runtime settings and a method to display remarks. More...
 
type(note_type), public note
 The scalar of type note_type containing the runtime settings and a method to display notification messages. More...
 
type(warn_type), public warn
 The scalar of type warn_type containing the runtime settings and a method to display warning messages. More...
 
type(stop_type), public stop
 The scalar of type stop_type containing the runtime settings and a method to and stop the program and display program abortion messages. More...
 

Detailed Description

Generate and return an object of type display_type.

The generated object can be used to show decorated string or other string values on the standard output or an optionally-specified external file.

Parameters
[in]file: The input scalar of type character of default kind SK, containing the path to the unconnected external file to be opened and used as the display.
  1. If the file does not exist, it will be created, unless other behavior is dictated by the input optional argument status.
  2. If it exists, it will be closed and reopened and the file position will be set to the input position argument.
If present, the unit component of the output display object will be set to the unit of the connected file.
(optional. It can be present only if the input argument unit is missing.)
[in]unit: The input scalar integer of default kind IK representing the output display unit number where contents will be displayed.
If the specified unit is not connected, it will be connected to a temporary file with status = "scratch".
(optional, default = output_unit. It can be present only if the input argument file is missing.)
[in]status: The input scalar of type character of default kind SK, whose contents represent the status of the input file.
It can take any value acceptable by the same argument to the Fortran intrinsic open() statement: "old", "replace", "new", "unknown", etc.
(optional, default = SK_"old" if the input file is already opened, otherwise SK_"unknown". It can be present only if the input argument file is also present.)
[in]position: The input scalar of type character of default kind SK, whose contents represent the position of the input connected file.
It can take any value acceptable by the same argument to the Fortran intrinsic open() statement: "asis", "rewind", "append", etc.
(optional, default = SK_"append" if the input file is already opened, otherwise SK_"asis". It can be present only if the input argument file is also present.)
[in]advance: The input scalar of type character of default kind SK, whose contents represent the default advance mode of the IO.
The contents of advance are directly passed to the corresponding advance argument of the Fortran intrinsic read() or write procedures.
(optional, default = \(\ms{SK_"YES"}\).)
[in]format: The input scalar of type field_type, whose components represent the formats to be used for the output records of various intrinsic types.
Note that the components of the input format are applied to each output record, that is, one output row.
The components of format are directly used as the format argument of the Fortran intrinsic read() and write() statements.
To simply the specification of mathematical display formats for complex values as in \(u + v\up{i}\), the complex component of the input object of type field_type can be also set to SK_"math".
In such a case, the math-style complex format FORMAT_GENERIC_DISPLAY_COMPLEX_MATH will be used for displaying complex valued objects.
See also the generic interface getFormat for creating custom formats for objects of specific type and kind.
(optional, default = \(\ms{"(sp,*(deliml,g0,', ',g0,delimr,:,', '))"}\) for complex fields and \(\ms{"(sp,*(deliml,g0,delimr,:,', '))"}\) for all other field types, where deliml and delimr refer to the corresponding left and right fields delimiter components of the input arguments deliml and delimr.)
[in]deliml: The input scalar of type field_type, whose components represent the left-delimiters to be used for left-delimiting (wrapping) fields of various intrinsic types.
The two most common left-delimiters for strings are the single \(\texttt{'}\) and double \(\texttt{"}\) quotation marks.
The common Fortran-style left-delimiter for complex values is the left-parenthesis \(\texttt{(}\).
The left-delimiter can be also set directly individually for objects of specific intrinsic types as an input argument to the relevant methods for displaying objects (e.g., show()).
Initializing the left-delimiters here, however, defines it globally for all relevant methods throughout the life of the current object of type display_type.
Any component of the input deliml will be ignored in constructing the generic field formats, if the input argument format is present and its corresponding component is allocated.
(optional, default = delimr or if missing or any component is unallocated, "(" for field of type complex and \(\ms{""}\) (i.e., no left-delimiter) for all other field types.)
[in]delimr: The input scalar of type field_type, whose components represent the right-delimiters to be used for right-delimiting (wrapping) fields of various intrinsic types.
The two most common right-delimiters for strings are the single \(\texttt{'}\) and double \(\texttt{"}\) quotation marks.
The common Fortran-style right-delimiter for complex values is the right-parenthesis \(\texttt{)}\).
The right-delimiter can be also set directly individually for objects of specific intrinsic types as an input argument to the relevant methods for displaying objects (e.g., show()).
Initializing the right-delimiters here, however, defines it globally for all relevant methods throughout the life of the current object of type display_type.
Any component of the input delimr will be ignored in constructing the generic field formats, if the input argument format is present and its corresponding component is allocated.
(optional, default = deliml or if missing or any component is unallocated, ")" for field of type complex and \(\ms{""}\) (i.e., no right-delimiter) for all other field types.)
[in]tmsize: The input scalar integer of default kind IK representing the size of the top margin of any value that will be shown in the display.
For more details, see the documentation of the corresponding argument in getCentered.
(optional, default = 0)
[in]bmsize: The input scalar integer of default kind IK representing the size of the bottom margin of value that will be shown in the display.
For more details, see the documentation of the corresponding argument in getCentered.
(optional, default = 0)
[in]count: The input scalar integer of default kind IK representing the number of times each input value has to be displayed. (optional, default = 1. It can be present if and only if the optional input argument file is missing.)
[in]sticky: The input scalar of type logical of default kind LK.
If .true., the global properties (i.e., components) of the object of class display_type can be overridden by the corresponding arguments passed to the dynamic methods of the object.
(optional, default = .false.)
[in]text: The input scalar of type wrap_type containing the runtime settings and a method to wrap strings within a fixed width.
(optional, default = wrap_type(tmsize = disp%tmsize, bmsize = disp%bmsize, width = disp%width, unit = disp%unit, sticky = disp%sticky))
[in]mark: The input scalar of type mark_type containing the runtime settings and a method to display remarks.
(optional, default = mark_type(tmsize = disp%tmsize, bmsize = disp%bmsize, width = disp%width, unit = disp%unit, sticky = disp%sticky))
[in]note: The input scalar of type note_type containing the runtime settings and a method to display notification messages.
(optional, default = note_type(tmsize = disp%tmsize, bmsize = disp%bmsize, width = disp%width, unit = disp%unit, sticky = disp%sticky))
[in]warn: The input scalar of type warn_type containing the runtime settings and a method to display warning messages.
(optional, default = warn_type(tmsize = disp%tmsize, bmsize = disp%bmsize, width = disp%width, unit = disp%unit, sticky = disp%sticky))
[in]stop: The input scalar of type stop_type containing the runtime settings and a method to and stop the program and display program abortion messages.
(optional, default = stop_type(tmsize = disp%tmsize, bmsize = disp%bmsize, width = disp%width, unit = disp%unit, sticky = disp%sticky))


Possible calling interfaces

use pm_io, only: display_type
type(display_type) :: disp
disp = display_type( format = format &
, advance = advance &
, deliml = deliml &
, delimr = delimr &
, tmsize = tmsize &
, bmsize = bmsize &
, count = count &
, sticky = sticky &
, text = text &
, mark = mark &
, note = note &
, warn = warn &
, stop = stop &
)
! The `unit` of an already opened (connected file). If not connected, will be connected to a `scratch` file.
disp = display_type( unit &
, format = format &
, advance = advance &
, format = format &
, deliml = deliml &
, delimr = delimr &
, tmsize = tmsize &
, bmsize = bmsize &
, count = count &
, sticky = sticky &
, text = text &
, mark = mark &
, note = note &
, warn = warn &
, stop = stop &
)
! The path to an external old or new `file`. If `file` is connected, it will be closed and reopened.
disp = display_type( file &
, status = status &
, position = position &
, advance = advance &
, format = format &
, deliml = deliml &
, delimr = delimr &
, tmsize = tmsize &
, bmsize = bmsize &
, count = count &
, sticky = sticky &
, text = text &
, mark = mark &
, note = note &
, warn = warn &
, stop = stop &
)
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
Generate and return an object of type display_type.
Definition: pm_io.F90:10282
Warning
The condition isValidStatus(status) must hold for the corresponding input arguments.
The condition isValidPosition(position) must hold for the corresponding input arguments.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.
Any overflow of a single line beyond the specified width is handled as described in the documentation of getCentered.
All components of this derived type are protected and read-only.
However, all components are currently public until the protected attribute of Fortran 2023 is implemented by the compiler vendors.
Remarks
The procedures under discussion are impure.
See also
wrap_type%%wrap()
display_type%%show()
display_type%%skip()
getStrWrapped
getCentered
setCentered
isFailedGetShellWidth
isFailedGetShellHeight


Example usage

1program example
2
3 use pm_kind, only: SK, IK, LK
4 use pm_io, only: display_type
5 use pm_distUnif, only: getUnifRand
6 use pm_distUnif, only: setUnifRand
7
8 implicit none
9
10 type(display_type) :: disp
11 disp = display_type(file = SK_"main.out.F90")
12
13 call disp%skip()
14 call disp%show('disp = display_type(file = SK_"main.out.F90", status = "old", position = "append")')
15 call disp%skip()
16 call disp%show("call disp%show('ParaMonte') ! output without quotation marks.")
17 call disp%show('ParaMonte')
18 call disp%skip()
19 call disp%show("call disp%show('ParaMonte', deliml = '''') ! output with single quotation marks.")
20 call disp%show('ParaMonte', deliml = '''')
21 call disp%skip()
22 call disp%show('call disp%show("ParaMonte", deliml = """") ! output with double quotation marks.')
23 call disp%show('ParaMonte', deliml = """")
24 call disp%skip()
25 call disp%show('call disp%show("ParaMonte", deliml = "`") ! output with backtick marks.')
26 call disp%show('ParaMonte', deliml = "`")
27 call disp%skip()
28
29 call disp%skip()
30 call disp%show('disp = display_type(disp%unit)')
31 disp = display_type(disp%unit)
32 call disp%skip()
33 call disp%show("call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.']) ! output without quotation marks.")
34 call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.'])
35 call disp%skip()
36 call disp%show("call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.'], deliml = SK_'''') ! output with single quotation marks.")
37 call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.'], deliml = SK_'''')
38 call disp%skip()
39 call disp%show('call disp%show([character(10) :: "ParaMonte", "is", "a", "machine", "learning", "library."], deliml = SK_"""") ! output with double quotation marks.')
40 call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.'], deliml = SK_"""")
41 call disp%skip()
42 call disp%show('call disp%show([character(10) :: "ParaMonte", "is", "a", "machine", "learning", "library."], deliml = SK_"`") ! output with backtick marks.')
43 call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.'], deliml = SK_"`")
44 call disp%skip()
45
46 call disp%skip()
47 call disp%show('disp = display_type(disp%unit)')
48 disp = display_type(disp%unit)
49 call disp%skip()
50 call disp%show("call disp%show(.true.)")
51 call disp%show(.true.)
52 call disp%skip()
53 call disp%show("call disp%show([.true., .false.])")
54 call disp%show([.true., .false.])
55 call disp%skip()
56
57 call disp%skip()
58 call disp%show('disp = display_type(disp%unit)')
59 disp = display_type(disp%unit)
60 call disp%skip()
61 call disp%show("call disp%show(1)")
62 call disp%show(1)
63 call disp%skip()
64 call disp%show("call disp%show([1, 2])")
65 call disp%show([1, 2])
66 call disp%skip()
67
68 call disp%skip()
69 call disp%show('disp = display_type(disp%unit)')
70 disp = display_type(disp%unit)
71 call disp%skip()
72 call disp%show("call disp%show(1.)")
73 call disp%show(1.)
74 call disp%skip()
75 call disp%show("call disp%show([1., 2.])")
76 call disp%show([1., 2.])
77 call disp%skip()
78
79 call disp%skip()
80 call disp%show('disp = display_type(disp%unit)')
81 disp = display_type(disp%unit)
82 call disp%skip()
83 call disp%show("call disp%show((1.,-1.))")
84 call disp%show((1.,-1.))
85 call disp%skip()
86 call disp%show("call disp%show([(1.,-1.), (2.,-2.)])")
87 call disp%show([(1.,-1.), (2.,-2.)])
88 call disp%skip()
89
90 call disp%skip()
91 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
92 call disp%show("! Display matrices of values.")
93 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
94 call disp%skip()
95
96 call disp%skip()
97 call disp%show('disp = display_type(disp%unit)')
98 disp = display_type(disp%unit)
99 call disp%skip()
100 call disp%show("call disp%show(reshape(getUnifRand(0, 1, 9), [3, 3]))")
101 call disp%show(reshape(getUnifRand(0, 1, 9), [3, 3]))
102 call disp%skip()
103
104 call disp%skip()
105 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
106 call disp%show("! Display contents of containers of matrices.")
107 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
108 call disp%skip()
109
110 block
111 use pm_container, only: cmi_type
112 type(cmi_type) :: ConMat(3)
113 call disp%skip()
114 call disp%show('allocate(ConMat(1)%val(2,2)); call setUnifRand(ConMat(1)%val)')
115 allocate(ConMat(1)%val(2,2)); call setUnifRand(ConMat(1)%val)
116 call disp%show('allocate(ConMat(2)%val(3,5)); call setUnifRand(ConMat(2)%val)')
117 allocate(ConMat(2)%val(3,5)); call setUnifRand(ConMat(2)%val)
118 call disp%show('allocate(ConMat(3)%val(5,3)); call setUnifRand(ConMat(3)%val)')
119 allocate(ConMat(3)%val(5,3)); call setUnifRand(ConMat(3)%val)
120 call disp%show('disp = display_type(disp%unit)')
121 disp = display_type(disp%unit)
122 call disp%skip()
123 call disp%show("call disp%show(ConMat(:))")
124 call disp%show(ConMat(:))
125 call disp%skip()
126 end block
127
128 call disp%skip()
129 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%")
130 call disp%show("! Display cubes of values.")
131 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%")
132 call disp%skip()
133
134 call disp%skip()
135 call disp%show('disp = display_type(disp%unit)')
136 disp = display_type(disp%unit)
137 call disp%skip()
138 call disp%show("call disp%show(reshape(getUnifRand(0, 1, 27), [3, 3, 3]))")
139 call disp%show(reshape(getUnifRand(0, 1, 27), [3, 3, 3]))
140 call disp%skip()
141
142end program example
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
Return a uniform random scalar or contiguous array of arbitrary rank of randomly uniformly distribute...
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 the derived types for generating allocatable containers of scalar,...
This module contains classes and procedures for computing various statistical quantities related to t...
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
This is the derived type for generating a container of a matrix component of type integer of default ...

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
2disp = display_type(file = SK_"main.out.F90", status = "old", position = "append")
3
4call disp%show('ParaMonte') ! output without quotation marks.
5ParaMonte
6
7call disp%show('ParaMonte', deliml = '''') ! output with single quotation marks.
8'ParaMonte'
9
10call disp%show("ParaMonte", deliml = """") ! output with double quotation marks.
11"ParaMonte"
12
13call disp%show("ParaMonte", deliml = "`") ! output with backtick marks.
14`ParaMonte`
15
16
18
19call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.']) ! output without quotation marks.
20ParaMonte , is , a , machine , learning , library.
21
22call disp%show([character(10) :: 'ParaMonte', 'is', 'a', 'machine', 'learning', 'library.'], deliml = SK_'''') ! output with single quotation marks.
23'ParaMonte ', 'is ', 'a ', 'machine ', 'learning ', 'library. '
24
25call disp%show([character(10) :: "ParaMonte", "is", "a", "machine", "learning", "library."], deliml = SK_"""") ! output with double quotation marks.
26"ParaMonte ", "is ", "a ", "machine ", "learning ", "library. "
27
28call disp%show([character(10) :: "ParaMonte", "is", "a", "machine", "learning", "library."], deliml = SK_"`") ! output with backtick marks.
29`ParaMonte `, `is `, `a `, `machine `, `learning `, `library. `
30
31
33
34call disp%show(.true.)
35T
36
37call disp%show([.true., .false.])
38T, F
39
40
42
43call disp%show(1)
44+1
45
46call disp%show([1, 2])
47+1, +2
48
49
51
52call disp%show(1.)
53+1.00000000
54
55call disp%show([1., 2.])
56+1.00000000, +2.00000000
57
58
60
61call disp%show((1.,-1.))
62(+1.00000000, -1.00000000)
63
64call disp%show([(1.,-1.), (2.,-2.)])
65(+1.00000000, -1.00000000), (+2.00000000, -2.00000000)
66
67
68!%%%%%%%%%%%%%%%%%%%%%%%%%%%%
69! Display matrices of values.
70!%%%%%%%%%%%%%%%%%%%%%%%%%%%%
71
72
74
75call disp%show(reshape(getUnifRand(0, 1, 9), [3, 3]))
76+0, +0, +1
77+0, +1, +0
78+1, +0, +0
79
80
81!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
82! Display contents of containers of matrices.
83!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
84
85
86allocate(ConMat(1)%val(2,2)); call setUnifRand(ConMat(1)%val)
87allocate(ConMat(2)%val(3,5)); call setUnifRand(ConMat(2)%val)
88allocate(ConMat(3)%val(5,3)); call setUnifRand(ConMat(3)%val)
90
91call disp%show(ConMat(:))
92object(1)%val(:,:) =
93+1793032556, +209404012
94-1640074858, -1012903990
95object(2)%val(:,:) =
96+102770329, -21998112, -501190467, -2002038353, -924710969
97-1462760072, -182417970, -1193828396, -2049031646, -1312982783
98-555015687, -1606992716, +807035452, -1736782897, +257561863
99object(3)%val(:,:) =
100+682344719, +480369026, +1514508678
101+565005939, +1477528259, +640936187
102-360895291, +1751372957, +1187225048
103-1357458221, +1140758477, +1678600726
104-1197184882, +194553956, +546538460
105
106
107!%%%%%%%%%%%%%%%%%%%%%%%%%
108! Display cubes of values.
109!%%%%%%%%%%%%%%%%%%%%%%%%%
110
111
112disp = display_type(disp%unit)
113
114call disp%show(reshape(getUnifRand(0, 1, 27), [3, 3, 3]))
115slice(:,:,1) =
116+1, +1, +0
117+0, +1, +1
118+1, +0, +0
119slice(:,:,2) =
120+1, +0, +0
121+0, +0, +1
122+1, +0, +1
123slice(:,:,3) =
124+1, +1, +1
125+1, +0, +0
126+1, +1, +1
127
128
Test:
test_pm_io
Bug:

Status: Unresolved
Source: Intel LLVM Fortran Compiler ifx version 2024.0.0
Description: The Intel LLVM Fortran Compiler ifx version 2024.0.0 memory sanitizer in debug compilation (with heap memory, serial shared library generation) reports an uninitialized heap memory allocation usage where the constructor opens the specified input file.
open(newunit = disp%unit, file = file, status = status_def, position = position_def)

The cause of this error could not be identified, although the error can be bypassed by compiling in release mode.
Remedy (as of ParaMonte Library version 2.0.0): Currently none. This may need the attention of the Intel LLVM compiler developer team.

Todo:
Critical Priority: The public attributes of all components of this derived type must be converted to protected once the protected attribute of Fortran 2023 is supported by the Fortran compilers supported by the ParaMonte library.


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, Tuesday March 7, 2017, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 10282 of file pm_io.F90.

Member Data Documentation

◆ advance

character(3, SK), public pm_io::display_type::advance = SK_"YES"

The scalar character of default kind SK containing the default IO advance mode for reading/writing actions.

Definition at line 10294 of file pm_io.F90.

◆ bmsize

integer(IK), public pm_io::display_type::bmsize = 0_IK

The scalar integer of default kind IK containing the number of records to skip on the bottom of the current record.

Definition at line 10292 of file pm_io.F90.

◆ count

integer(IK), public pm_io::display_type::count = 1_IK

The scalar integer of default kind IK containing the number of times to repeat the current record.

Definition at line 10291 of file pm_io.F90.

◆ deliml

type(field_type), public pm_io::display_type::deliml

The scalar object of type field_type containing the left-delimiters for objects of various types.

Definition at line 10297 of file pm_io.F90.

◆ delimr

type(field_type), public pm_io::display_type::delimr

The scalar object of type field_type containing the right-delimiters for objects of various types.

Definition at line 10298 of file pm_io.F90.

◆ file

character(:, SK), allocatable, public pm_io::display_type::file

The scalar character of default kind SK containing the file path to which the record must be written.

Definition at line 10295 of file pm_io.F90.

◆ format

type(field_type), public pm_io::display_type::format

The scalar character of default kind SK containing the default IO format with which the records should be displayed.

Definition at line 10296 of file pm_io.F90.

◆ height

integer(IK), public pm_io::display_type::height = -huge(0_IK)

The scalar integer of default kind IK containing the height of the runtime Shell screen or -huge(0_IK) if the inference fails or the display is not the standard output output_unit.

Definition at line 10289 of file pm_io.F90.

◆ mark

type(mark_type), public pm_io::display_type::mark

The scalar of type mark_type containing the runtime settings and a method to display remarks.

Definition at line 10300 of file pm_io.F90.

◆ note

type(note_type), public pm_io::display_type::note

The scalar of type note_type containing the runtime settings and a method to display notification messages.

Definition at line 10301 of file pm_io.F90.

◆ stop

type(stop_type), public pm_io::display_type::stop

The scalar of type stop_type containing the runtime settings and a method to and stop the program and display program abortion messages.

Definition at line 10303 of file pm_io.F90.

◆ text

type(wrap_type), public pm_io::display_type::text

The scalar of type wrap_type containing the runtime settings and a method to wrap strings within a fixed width.

Definition at line 10299 of file pm_io.F90.

◆ tmsize

integer(IK), public pm_io::display_type::tmsize = 0_IK

The scalar integer of default kind IK containing the number of records to skip on top of the current record.

Definition at line 10290 of file pm_io.F90.

◆ unit

integer(IK), public pm_io::display_type::unit = output_unit

The scalar integer of default kind IK containing the unit number of the file to which the record must be written.

Definition at line 10293 of file pm_io.F90.

◆ warn

type(warn_type), public pm_io::display_type::warn

The scalar of type warn_type containing the runtime settings and a method to display warning messages.

Definition at line 10302 of file pm_io.F90.

◆ width

integer(IK), public pm_io::display_type::width = -huge(0_IK)

The scalar integer of default kind IK containing the width of the runtime Shell screen or -huge(0_IK) if the inference fails or the display is not the standard output output_unit.

Definition at line 10288 of file pm_io.F90.


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