pm_err::mark_type Type Reference

This is the derived type for constructing objects that contain the specifications of the generic interface setMarked along with a dynamic method show that acts as a convenience wrapper around the generic interface setMarked.
More...

Inheritance diagram for pm_err::mark_type:

Collaboration diagram for pm_err::mark_type:

Public Member Functions
	excluded

Additional Inherited Members
Public Attributes inherited from pm_err::message_type
character(:, SK), allocatable, public	prefix
	See the corresponding definition in the documentation of getStrWrapped. More...
character(:, SK), allocatable, public	indent
	See the corresponding definition in the documentation of getStrWrapped. More...
character(:, SK), allocatable, public	break
	See the corresponding definition in the documentation of getStrWrapped. More...
character(:, SK), allocatable, public	newline
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	width
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	maxwidth
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	tmsize
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	bmsize
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	unit
	See the corresponding definition in the documentation of message_type. More...
logical(LK), public	sticky = .false._LK
	See the corresponding argument in the documentation of message_type. More...

Detailed Description

This is the derived type for constructing objects that contain the specifications of the generic interface setMarked along with a dynamic method show that acts as a convenience wrapper around the generic interface setMarked.

See the documentation of the parent type message_type for more details and inherited derived type components.

Returns

mark : An object of type mark_type containing the attributes and wrapper method for outputting a remark.

Possible calling interfaces ⛓

use pm_err, only: mark_type
type(mark_type) :: spec
 
spec = mark_type( prefix = prefix       &
                , indent = indent       &
                , break = break         &
                , newline = newline     &
                , width = width         &
                , maxwidth = maxwidth   &
                , tmsize = tmsize       &
                , bmsize = bmsize       &
                , unit = unit           &
                , sticky = sticky       &
                )

Developer Remark:

The allocation status of the components is used to signify the optional argument presence within the methods.

See also

mark_type
note_type
warn_type
stop_type
display_type
message_type
getStrWrapped
getCentered
setCentered

Example usage ⛓

program example
 
    use pm_kind, only: IK, LK
    use pm_io, only: display_type
    use pm_err, only: mark_type
    use pm_kind, only: SK ! All kinds are supported.
    use iso_fortran_env, only: output_unit
 
    implicit none
 
    character(:, SK), allocatable :: str, strWrapped
 
    type(display_type) :: disp
 
    disp = display_type(file = SK_"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 an important message.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    block
        type(mark_type) :: mark
        call disp%show("mark = mark_type(unit = disp%unit, newline = SK_'\n', prefix = SK_'    ParaMonte')")
                        mark = mark_type(unit = disp%unit, newline = SK_'\n', prefix = SK_'    ParaMonte')
        call disp%show("str")
        call disp%show( str, deliml = SK_"""" )
        call disp%skip()
        call disp%show("call mark%show(str)")
                        call mark%show(str)
        call disp%skip()
        call disp%show("call mark%show(str, width = 72_IK, sticky = .true._LK)")
                        call mark%show(str, width = 72_IK, sticky = .true._LK)
        call disp%skip()
        call disp%show("call mark%show(str) ! same width as before.")
                        call mark%show(str) ! same width as before.
        call disp%skip()
    end block
 
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 an important message.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
mark = mark_type(unit = disp%unit, newline = SK_'\n', prefix = SK_'    ParaMonte')
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 mark%show(str)
 
    ParaMonteParaMonte is a serial/parallel library of Monte Carlo routines for 
    ParaMonte   +   optimization, 
    ParaMonte   +   sampling, and 
    ParaMonte   +   integration 
    ParaMonteof mathematical objective functions of arbitrary-dimensions, in particular, the posterior distributions of Bayesian models in 
    ParaMonte   +   data science, 
    ParaMonte   +   Machine Learning, and 
    ParaMonte   +   scientific inference, 
    ParaMontewith the design goal of unifying the 
    ParaMonte   +   automation(of Monte Carlo simulations), 
    ParaMonte   +   user-friendliness(of the library), 
    ParaMonte   +   accessibility(from multiple programming environments), 
    ParaMonte   +   high-performance(at runtime), and 
    ParaMonte   +   scalability(across many parallel processors).
 
call mark%show(str, width = 72_IK, sticky = .true._LK)
 
    ParaMonteParaMonte is a serial/parallel library of Monte Carlo routines for 
    ParaMonte   +   optimization, 
    ParaMonte   +   sampling, and 
    ParaMonte   +   integration 
    ParaMonteof mathematical objective functions of arbitrary-dimensions, in particular, 
    ParaMontethe posterior distributions of Bayesian models in 
    ParaMonte   +   data science, 
    ParaMonte   +   Machine Learning, and 
    ParaMonte   +   scientific inference, 
    ParaMontewith the design goal of unifying the 
    ParaMonte   +   automation(of Monte Carlo simulations), 
    ParaMonte   +   user-friendliness(of the library), 
    ParaMonte   +   accessibility(from multiple programming environments), 
    ParaMonte   +   high-performance(at runtime), and 
    ParaMonte   +   scalability(across many parallel processors).
 
call mark%show(str) ! same width as before.
 
    ParaMonteParaMonte is a serial/parallel library of Monte Carlo routines for 
    ParaMonte   +   optimization, 
    ParaMonte   +   sampling, and 
    ParaMonte   +   integration 
    ParaMonteof mathematical objective functions of arbitrary-dimensions, in particular, 
    ParaMontethe posterior distributions of Bayesian models in 
    ParaMonte   +   data science, 
    ParaMonte   +   Machine Learning, and 
    ParaMonte   +   scientific inference, 
    ParaMontewith the design goal of unifying the 
    ParaMonte   +   automation(of Monte Carlo simulations), 
    ParaMonte   +   user-friendliness(of the library), 
    ParaMonte   +   accessibility(from multiple programming environments), 
    ParaMonte   +   high-performance(at runtime), and 
    ParaMonte   +   scalability(across many parallel processors).
 
 

Test:

test_pm_err

Bug:

Status: Unresolved
Source: GNU Fortran Compiler gfortran version 11-13
Description: GNU Fortran Compiler gfortran cannot properly construct the allocatable scalar non-character components of objects of type warn_type using the default constructor.
For example, when unit is set via the default constructor, the program behaves as if the unit component of the object is allocated but unset, yielding a segmentation fault error.

Remedy (as of ParaMonte Library version 2.0.0): For now, the custom constructor bypasses GNU Fortran Compiler gfortran bug.

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

Definition at line 973 of file pm_err.F90.

Member Function/Subroutine Documentation

excluded()

pm_err::mark_type::excluded

Definition at line 996 of file pm_err.F90.

---

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

• src/fortran/main/pm_err.F90