pm_err::setAborted Interface Reference

Write the input string in the format of a fatal error to the output, then call error stop or return the control to the caller if requested.
More...

Detailed Description

Write the input string in the format of a fatal error to the output, then call error stop or return the control to the caller if requested.

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 - FATAL: 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]	help	: The input scalar character of the same kind as msg containing a descriptive help message to display separately after the fatal error message. (optional, default = "")
[in]	prefix	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	indent	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	break	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	newline	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	width	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	maxwidth	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[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. If the input unit is different from the standard output (output_unit), all messages will also be printed on stdout recursively. (optional, default = output_unit taken from the intrinsic module iso_fortran_env.)
[in]	stat	: The input scalar integer of default kind IK containing the error stat code, frequently returned by the compiler. (optional. If missing, no error code will be suffixed to the output error message.)
[in]	renabled	: The input scalar logical of default kind LK. If .true., the program-control will be returned to the calling routine instead of terminating the program via error stop. This capability is particularly needed during the testing of the various components of the ParaMonte library, when fatal error must be handled gracefully. (optional, default = SOFT_EXIT_ENABLED)

Possible calling interfaces ⛓

use pm_err, only: setAborted
 
call setAborted(msg, help = help, prefix = prefix, indent = indent, break = break, newline = newline, width = width, maxwidth = maxwidth, tmsize = tmsize, bmsize = bmsize, unit = unit, stat = stat, renabled = renabled)

Remarks

The procedures under discussion are impure.

See also

getStr
setNoted
setWarned
setAborted
setAsserted
getLine

Example usage ⛓

program example
 
    use pm_kind, only: IK, LK
    use pm_kind, only: SK ! All kinds are supported.
    use pm_err, only: setAborted
    use pm_io, only: display_type
 
    implicit none
 
    character(:, SK), allocatable   :: str, strWrapped
 
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    str =   "ParaMonte is a serial/parallel library of Monte Carlo routines for \n&
            &   +   optimization, \n&
            &   +   sampling, and \n&
            &   +   integration \n&
            &of 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, \n&
            &with 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)."
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Notify the user about a fatal error occurrence.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%show("str")
    call disp%show( str, deliml = SK_"""" )
    call disp%show("call setAborted(str, newline = SK_'\n', renabled = .true._LK, unit = disp%unit) ! To halt the program, omit `renabled`.")
                    call setAborted(str, newline = SK_'\n', renabled = .true._LK, unit = disp%unit)
    call disp%skip()
    call disp%show("call setAborted(str, prefix = SK_'    ParaMonte', newline = SK_'\n', renabled = .true._LK, unit = disp%unit)")
                    call setAborted(str, prefix = SK_'    ParaMonte', newline = SK_'\n', renabled = .true._LK, unit = disp%unit)
    call disp%skip()
    call disp%show("call setAborted(str, prefix = SK_'    ParaMonte', newline = SK_'\n', width = 72_IK, renabled = .true._LK, unit = disp%unit)")
                    call setAborted(str, prefix = SK_'    ParaMonte', newline = SK_'\n', width = 72_IK, renabled = .true._LK, unit = disp%unit)
    call disp%skip()
    call disp%show("call setAborted(SK_'    '//str, help = SK_'Contact cdslab.org for help.', prefix = SK_'    ParaMonte', newline = SK_'\n', width = 72_IK, renabled = .true._LK, unit = disp%unit)")
                    call setAborted(SK_'    '//str, help = SK_'Contact cdslab.org for help.', prefix = SK_'    ParaMonte', newline = SK_'\n', width = 72_IK, renabled = .true._LK, unit = disp%unit)
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Notify the user about a fatal error occurrence.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
str
"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)."
call setAborted(str, newline = SK_'\n', renabled = .true._LK, unit = disp%unit) ! To halt the program, omit `renabled`.
 
 - FATAL: ParaMonte is a serial/parallel library of Monte Carlo routines for 
 - FATAL:    +   optimization, 
 - FATAL:    +   sampling, and 
 - FATAL:    +   integration 
 - FATAL: of mathematical objective functions of arbitrary-dimensions in particular, the posterior distributions of Bayesian models in 
 - FATAL:    +   data science, 
 - FATAL:    +   Machine Learning, and 
 - FATAL:    +   scientific inference, 
 - FATAL: with the design goal of unifying the 
 - FATAL:    +   automation(of Monte Carlo simulations), 
 - FATAL:    +   user-friendliness(of the library), 
 - FATAL:    +   accessibility(from multiple programming environments), 
 - FATAL:    +   high-performance(at runtime), and 
 - FATAL:    +   scalability(across many parallel processors).
 
call setAborted(str, prefix = SK_'    ParaMonte', newline = SK_'\n', renabled = .true._LK, unit = disp%unit)
 
    ParaMonte - FATAL: ParaMonte is a serial/parallel library of Monte Carlo routines for 
    ParaMonte - FATAL:    +   optimization, 
    ParaMonte - FATAL:    +   sampling, and 
    ParaMonte - FATAL:    +   integration 
    ParaMonte - FATAL: of mathematical objective functions of arbitrary-dimensions in particular, the posterior distributions of Bayesian models in 
    ParaMonte - FATAL:    +   data science, 
    ParaMonte - FATAL:    +   Machine Learning, and 
    ParaMonte - FATAL:    +   scientific inference, 
    ParaMonte - FATAL: with the design goal of unifying the 
    ParaMonte - FATAL:    +   automation(of Monte Carlo simulations), 
    ParaMonte - FATAL:    +   user-friendliness(of the library), 
    ParaMonte - FATAL:    +   accessibility(from multiple programming environments), 
    ParaMonte - FATAL:    +   high-performance(at runtime), and 
    ParaMonte - FATAL:    +   scalability(across many parallel processors).
 
call setAborted(str, prefix = SK_'    ParaMonte', newline = SK_'\n', width = 72_IK, renabled = .true._LK, unit = disp%unit)
 
    ParaMonte - FATAL: ParaMonte is a serial/parallel library of Monte Carlo routines for 
    ParaMonte - FATAL:    +   optimization, 
    ParaMonte - FATAL:    +   sampling, and 
    ParaMonte - FATAL:    +   integration 
    ParaMonte - FATAL: of mathematical objective functions of arbitrary-dimensions in particular, 
    ParaMonte - FATAL: the posterior distributions of Bayesian models in 
    ParaMonte - FATAL:    +   data science, 
    ParaMonte - FATAL:    +   Machine Learning, and 
    ParaMonte - FATAL:    +   scientific inference, 
    ParaMonte - FATAL: with the design goal of unifying the 
    ParaMonte - FATAL:    +   automation(of Monte Carlo simulations), 
    ParaMonte - FATAL:    +   user-friendliness(of the library), 
    ParaMonte - FATAL:    +   accessibility(from multiple programming environments), 
    ParaMonte - FATAL:    +   high-performance(at runtime), and 
    ParaMonte - FATAL:    +   scalability(across many parallel processors).
 
call setAborted(SK_'    '//str, help = SK_'Contact cdslab.org for help.', prefix = SK_'    ParaMonte', newline = SK_'\n', width = 72_IK, renabled = .true._LK, unit = disp%unit)
 
    ParaMonte - FATAL:     ParaMonte is a serial/parallel library of Monte Carlo routines for 
    ParaMonte - FATAL:        +   optimization, 
    ParaMonte - FATAL:        +   sampling, and 
    ParaMonte - FATAL:        +   integration 
    ParaMonte - FATAL:     of mathematical objective functions of arbitrary-dimensions in particular, 
    ParaMonte - FATAL:     the posterior distributions of Bayesian models in 
    ParaMonte - FATAL:        +   data science, 
    ParaMonte - FATAL:        +   Machine Learning, and 
    ParaMonte - FATAL:        +   scientific inference, 
    ParaMonte - FATAL:     with the design goal of unifying the 
    ParaMonte - FATAL:        +   automation(of Monte Carlo simulations), 
    ParaMonte - FATAL:        +   user-friendliness(of the library), 
    ParaMonte - FATAL:        +   accessibility(from multiple programming environments), 
    ParaMonte - FATAL:        +   high-performance(at runtime), and 
    ParaMonte - FATAL:        +   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.

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.

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 2436 of file pm_err.F90.

---

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

• src/fortran/main/pm_err.F90