Write the input string in the format of a notification to the output.
The procedures under this generic interface call getStrWrapped with the input string to obtain a wrapped text within the specified width
and maxwidth
where the input prefix
is suffixed with - NOTE:
and then prepended to the beginning of each wrapped line and then printed on the display.
- Parameters
-
[in] | msg | : The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) representing the text to be wrapped and displayed.
|
[in] | prefix | : See the corresponding definition in the documentation of getStrWrapped.
(optional, default = "" ) |
[in] | indent | : See the corresponding definition in the documentation of getStrWrapped.
(optional. The default is set by getStrWrapped.) |
[in] | break | : See the corresponding definition in the documentation of getStrWrapped.
(optional. The default is set by getStrWrapped.) |
[in] | newline | : See the corresponding definition in the documentation of getStrWrapped.
(optional. The default is set by getStrWrapped.) |
[in] | width | : See the corresponding definition in the documentation of getStrWrapped.
(optional. The default is set by getStrWrapped.) |
[in] | maxwidth | : See the corresponding definition in the documentation of getStrWrapped.
(optional. The default is set by getStrWrapped.) |
[in] | tmsize | : The input scalar of integer of default kind IK representing the number of empty lines preceding the text in the display.
(optional, default = 1_IK ) |
[in] | bmsize | : The input scalar of integer of default kind IK representing the number of empty lines succeeding the text in the display.
(optional, default = 0_IK ) |
[in] | unit | : The input scalar integer of default kind IK containing the output file unit.
(optional, default = output_unit taken from the intrinsic module iso_fortran_env .) |
Possible calling interfaces ⛓
call setNoted(msg, prefix
= prefix, indent
= indent, break
= break, newline
= newline, width
= width, maxwidth
= maxwidth, tmsize
= tmsize, bmsize
= bmsize,
unit = unit)
Write the input string in the format of a notification to the output.
This module contains classes and procedures for reporting and handling errors.
- See also
- getStr
setNoted
setWarned
setAborted
setAsserted
getLine
Example usage ⛓
10 character(:, SK),
allocatable :: str, strWrapped
12 type(display_type) :: disp
16 str
= "ParaMonte is a serial/parallel library of Monte Carlo routines for \n&
20 &of mathematical objective functions of arbitrary-dimensions in particular, the posterior distributions of Bayesian models in \n&
22 & + Machine Learning, and \n&
23 & + scientific inference, \n&
24 &with the design goal of unifying the \n&
25 & + automation (of Monte Carlo simulations), \n&
26 & + user-friendliness (of the library), \n&
27 & + accessibility (from multiple programming environments), \n&
28 & + high-performance (at runtime), and \n&
29 & + scalability (across many parallel processors)."
32 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
33 call disp%show(
"! Notify the user about an important message.")
34 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
38 call disp%show( str, deliml
= SK_
"""" )
39 call disp%show(
"call setNoted(str, newline = SK_'\n', unit = disp%unit)")
42 call disp%show(
"call setNoted(str, prefix = SK_' ParaMonte', newline = SK_'\n', unit = disp%unit)")
43 call setNoted(str, prefix
= SK_
' ParaMonte', newline
= SK_
'\n',
unit = disp%unit)
45 call disp%show(
"call setNoted(str, prefix = SK_' ParaMonte', newline = SK_'\n', width = 72_IK, unit = disp%unit)")
46 call setNoted(str, prefix
= SK_
' ParaMonte', newline
= SK_
'\n', width
= 72_IK,
unit = disp%unit)
Generate and return an object of type stop_type with the user-specified input attributes.
This is a generic method of the derived type display_type with pass attribute.
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort
compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
7"ParaMonte is a serial/parallel library of Monte Carlo routines for \n + optimization, \n + sampling, and \n + integration \nof mathematical objective functions of arbitrary-dimensions in particular, the posterior distributions of Bayesian models in \n + data science, \n + Machine Learning, and \n + scientific inference, \nwith the design goal of unifying the \n + automation (of Monte Carlo simulations), \n + user-friendliness (of the library), \n + accessibility (from multiple programming environments), \n + high-performance (at runtime), and \n + scalability (across many parallel processors)."
10 - NOTE: ParaMonte is a serial
/parallel library of Monte Carlo routines for
11 - NOTE:
+ optimization,
12 - NOTE:
+ sampling, and
14 - NOTE: of mathematical objective functions of arbitrary
-dimensions in particular, the posterior distributions of Bayesian models in
15 - NOTE:
+ data science,
16 - NOTE:
+ Machine Learning, and
17 - NOTE:
+ scientific inference,
18 - NOTE: with the design goal of unifying the
19 - NOTE:
+ automation(of Monte Carlo simulations),
20 - NOTE:
+ user
-friendliness(of the library),
21 - NOTE:
+ accessibility(from multiple programming environments),
22 - NOTE:
+ high
-performance(at runtime), and
23 - NOTE:
+ scalability(across many parallel processors).
25call setNoted(str, prefix
= SK_
' ParaMonte', newline
= SK_
'\n',
unit = disp%unit)
27 ParaMonte
- NOTE: ParaMonte is a serial
/parallel library of Monte Carlo routines for
28 ParaMonte
- NOTE:
+ optimization,
29 ParaMonte
- NOTE:
+ sampling, and
30 ParaMonte
- NOTE:
+ integration
31 ParaMonte
- NOTE: of mathematical objective functions of arbitrary
-dimensions in particular, the posterior distributions of Bayesian models in
32 ParaMonte
- NOTE:
+ data science,
33 ParaMonte
- NOTE:
+ Machine Learning, and
34 ParaMonte
- NOTE:
+ scientific inference,
35 ParaMonte
- NOTE: with the design goal of unifying the
36 ParaMonte
- NOTE:
+ automation(of Monte Carlo simulations),
37 ParaMonte
- NOTE:
+ user
-friendliness(of the library),
38 ParaMonte
- NOTE:
+ accessibility(from multiple programming environments),
39 ParaMonte
- NOTE:
+ high
-performance(at runtime), and
40 ParaMonte
- NOTE:
+ scalability(across many parallel processors).
42call setNoted(str, prefix
= SK_
' ParaMonte', newline
= SK_
'\n', width
= 72_IK,
unit = disp%unit)
44 ParaMonte
- NOTE: ParaMonte is a serial
/parallel library of Monte Carlo routines for
45 ParaMonte
- NOTE:
+ optimization,
46 ParaMonte
- NOTE:
+ sampling, and
47 ParaMonte
- NOTE:
+ integration
48 ParaMonte
- NOTE: of mathematical objective functions of arbitrary
-dimensions in particular,
49 ParaMonte
- NOTE: the posterior distributions of Bayesian models in
50 ParaMonte
- NOTE:
+ data science,
51 ParaMonte
- NOTE:
+ Machine Learning, and
52 ParaMonte
- NOTE:
+ scientific inference,
53 ParaMonte
- NOTE: with the design goal of unifying the
54 ParaMonte
- NOTE:
+ automation(of Monte Carlo simulations),
55 ParaMonte
- NOTE:
+ user
-friendliness(of the library),
56 ParaMonte
- NOTE:
+ accessibility(from multiple programming environments),
57 ParaMonte
- NOTE:
+ high
-performance(at runtime), and
58 ParaMonte
- NOTE:
+ scalability(across many parallel processors).
test_pm_err
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, 9:49 PM Friday, March 1, 2013, Institute for Fusion Studies, The University of Texas Austin
Definition at line 2141 of file pm_err.F90.