ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_paramonte.F90
Go to the documentation of this file.
1!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
2!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
3!!!! !!!!
4!!!! ParaMonte: Parallel Monte Carlo and Machine Learning Library. !!!!
5!!!! !!!!
6!!!! Copyright (C) 2012-present, The Computational Data Science Lab !!!!
7!!!! !!!!
8!!!! This file is part of the ParaMonte library. !!!!
9!!!! !!!!
10!!!! LICENSE !!!!
11!!!! !!!!
12!!!! https://github.com/cdslaborg/paramonte/blob/main/LICENSE.md !!!!
13!!!! !!!!
14!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
15!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
16
17! Define a quoting macro for better illustration in the output file.
19#ifdef __GFORTRAN__
20# define QSTART(X) "&
21# define QEND(X) &X"
22#else /* default quoting macro */
23# define GET_QUOTED(X) #X
24# define QSTART(X) &
25# define QEND(X) GET_QUOTED(X)
26#endif
27
28
36
37!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38
39module pm_paramonte
40
41 use pm_kind, only: SK, IK, LK
42 use pm_str, only: NLC, UNDEFINED
43 use iso_fortran_env, only: compiler_options, compiler_version
44
45 implicit none
46
47!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
48
68 character(*, SK), parameter :: PARAMONTE_WEB_REPOSITORY = SK_"https://github.com/cdslaborg/paramonte"
69
89 character(*, SK), parameter :: PARAMONTE_WEB_ISSUES = SK_"https://github.com/cdslaborg/paramonte/issues"
90
110 character(*, SK), parameter :: PARAMONTE_WEB_DOC = SK_"https://www.cdslab.org/paramonte/"
111
112!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
113
133 character(*, SK), parameter :: PARAMONTE_COMPILER_VERSION = compiler_version()
134
154 character(*, SK), parameter :: PARAMONTE_COMPILER_OPTIONS = compiler_options()
155
156!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
157
177 type :: paramonte_type
178 end type
179
199 type(paramonte_type), parameter :: paramonte = paramonte_type()
200#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
201 !DIR$ ATTRIBUTES DLLEXPORT :: paramonte
202#endif
203
204!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
205
206 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
207 ! The ParaMonte programming language interface.
208 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
209
211#if C_ENABLED
212
213#define PROGLANG c
214#define PROGNAME"C"
215
216#elif COBOL_ENABLED
217
218#define PROGLANG cobol
219#define PROGNAME"COBOL"
220
221#elif CPP_ENABLED
222
223#define PROGLANG cpp
224#define PROGNAME"C++"
225
226#elif CSHARP_ENABLED
227
228#define PROGLANG csharp
229#define PROGNAME"C#"
230
231#elif GO_ENABLED
232
233#define PROGLANG go
234#define PROGNAME"Go"
235
236#elif FORTRAN_ENABLED
237
238#define PROGLANG fortran
239#define PROGNAME"Fortran"
240
241#elif JAVA_ENABLED
242
243#define PROGLANG java
244#define PROGNAME"Java"
245
246#elif JAVASCRIPT_ENABLED
247
248#define PROGLANG javascript
249#define PROGNAME"JavaScript"
250
251#elif JULIA_ENABLED
252
253#define PROGLANG julia
254#define PROGNAME"Julia"
255
256#elif MATLAB_ENABLED
257
258#define PROGLANG matlab
259#define PROGNAME"MATLAB"
260
261#elif MATTHEMATICA_ENABLED
262
263#define PROGLANG mathematica
264#define PROGNAME"Wolfram Mathematica"
265
266#elif PYTHON_ENABLED
267
268#define PROGLANG python
269#define PROGNAME"Python"
270
271#elif R_ENABLED
272
273#define PROGLANG r
274#define PROGNAME"R"
275
276#elif RUST_ENABLED
277
278#define PROGLANG rust
279#define PROGNAME"Rust"
280
281#elif SAS_ENABLED
282
283#define PROGLANG sas
284#define PROGNAME"SAS"
285
286#elif SWIFT_ENABLED
287
288#define PROGLANG swift
289#define PROGNAME"Swift"
290
291#else
292! Assume default Fortran.
293#define PROGLANG fortran
294#define PROGNAME"Fortran"
295!#error "Unrecognized interface."
296#endif
297
298
312 character(*, SK), parameter :: envname = PROGNAME//" programming language"
313
331 type :: envis_type
332 logical(LK) :: c = .false._LK
333 logical(LK) :: cobol = .false._LK
334 logical(LK) :: cpp = .false._LK
335 logical(LK) :: csharp = .false._LK
336 logical(LK) :: go = .false._LK
337 logical(LK) :: fortran = .false._LK
338 logical(LK) :: java = .false._LK
339 logical(LK) :: javascript = .false._LK
340 logical(LK) :: julia = .false._LK
341 logical(LK) :: matlab = .false._LK
342 logical(LK) :: mathematica = .false._LK
343 logical(LK) :: python = .false._LK
344 logical(LK) :: r = .false._LK
345 logical(LK) :: rust = .false._LK
346 logical(LK) :: sas = .false._LK
347 logical(LK) :: swift = .false._LK
348 end type
349
363 type(envis_type), parameter :: envis = envis_type(PROGLANG = .true._LK)
364
366#undef PROGLANG
367#undef PROGNAME
368
369
370!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
371
407#if INTEL_ENABLED || GNU_ENABLED
408 character(*, SK), parameter :: PARAMONTE_BUILD_DATE = __TIMESTAMP__
410#elif defined PARAMONTE_BUILD_TIMESTAMP
411 character(*, SK), parameter :: PARAMONTE_BUILD_DATE = PARAMONTE_BUILD_TIMESTAMP
412#else
413 character(*, SK), parameter :: PARAMONTE_BUILD_DATE = UNDEFINED
414#endif
415
416
417!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
418
452#if defined __PARAMONTE_VERSION__
453 character(*, SK), parameter :: PARAMONTE_VERSION = __PARAMONTE_VERSION__
455#else
456 ! WARNING: The following ParaMonte library version tag will be taken from the declaration
457 ! WARNING: that is generated by the preprocessing build script of the ParaMonte library.
458 ! WARNING: This is superior to the above method of using the compiler Preprocessor
459 ! WARNING: since CMAKE triggers a complete lengthy rebuild of the library when the
460 ! WARNING: only the library version has changed.
461#include "pm_paramonte@version.inc.F90"
462#endif
463
464
465!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
466
507 character(*, SK), parameter :: PARAMONTE_SPLASH = NLC//NLC// &
508 SK_"ParaMonte"//NLC// &
509 SK_"Parallel Monte Carlo and"//NLC// &
510 SK_"Machine Learning Library"//NLC// &
511 NLC// &
512 SK_"Version "//PARAMONTE_VERSION//NLC// &
513 NLC// &
514 SK_"Build: "//PARAMONTE_BUILD_DATE//NLC// &
515 NLC// &
516 SK_"Developed by"//NLC// &
517 NLC// &
518 SK_"The computational Data Science Lab"//NLC// &
519 NLC// &
520 SK_"at"//NLC// &
521 NLC// &
522 SK_"Department of Physics"//NLC// &
523 SK_"Data Science Program, College of Science"//NLC// &
524 SK_"The University of Texas at Arlington"//NLC// &
525 NLC// &
526 SK_"Multiscale Modeling Group"//NLC// &
527 SK_"Center for Computational Oncology"//NLC// &
528 SK_"Oden Institute for Computational Engineering and Sciences"//NLC// &
529 SK_"Department of Aerospace Engineering and Engineering Mechanics"//NLC// &
530 SK_"Department of Neurology, Dell-Seton Medical School"//NLC// &
531 SK_"Department of Biomedical Engineering"//NLC// &
532 SK_"The University of Texas at Austin"//NLC// &
533 NLC// &
534 SK_"For questions and further information, please contact the PI:"//NLC// &
535 NLC// &
536 SK_"Amir Shahmoradi"//NLC// &
537 !NLC// &
538 SK_"shahmoradi@utexas.edu"//NLC// &
539 !SK_"amir.shahmoradi@uta.edu"//NLC// &
540 !SK_"ashahmoradi@gmail.com"//NLC// &
541 !SK_"amir@physics.utexas.edu"//NLC// &
542 !SK_"amir@austin.utexas.edu"//NLC// &
543 !SK_"amir@ph.utexas.edu"//NLC// &
544 !NLC// &
545 !NLC// &
546 !SK_"https://www.cdslab.org/pm"//NLC// &
547 SK_"cdslab.org/pm"//NLC// &
548 NLC//NLC
549
550!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
551
552contains
553
554!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
555
622 PURE function getParaMonteSplash(width, lwsize, twsize, rwsize, bwsize, fill, lwfill, twfill, rwfill, bwfill) result(splash)
623#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
624 !DEC$ ATTRIBUTES DLLEXPORT :: getParaMonteSplash
625#endif
626 use pm_option, only: getOption
627 use pm_arrayFind, only: setLoc
628 use pm_arrayResize, only: setResized
629 use pm_arrayCenter, only: setCentered
630 integer(IK) , intent(in) , optional :: width, lwsize, twsize, rwsize, bwsize
631 character(1, SK), intent(in) , optional :: fill , lwfill, twfill, rwfill, bwfill
632 character(:, SK), allocatable :: splash
633 integer(IK) , allocatable :: locNLC(:)
634 character(1, SK) :: fill_def , lwfill_def, twfill_def, rwfill_def, bwfill_def
635 integer(IK) :: splashLen, iline, ibeg, iend, sbeg, lenNLC, linewidth, lenLocNLC
636 integer(IK) :: lwsize_def, twsize_def, rwsize_def, bwsize_def
637 lwsize_def = getOption(4_IK, lwsize)
638 twsize_def = getOption(2_IK, twsize)
639 rwsize_def = getOption(4_IK, rwsize)
640 bwsize_def = getOption(2_IK, bwsize)
641 lwfill_def = getOption(SK_"%", lwfill)
642 twfill_def = getOption(SK_"%", twfill)
643 rwfill_def = getOption(SK_"%", rwfill)
644 bwfill_def = getOption(SK_"%", bwfill)
645 fill_def = getOption(SK_" ", fill)
646 lenNLC = len(NLC, IK)
647 call setResized(locNLC, 47_IK)
648 call setLoc(locNLC, lenLocNLC, PARAMONTE_SPLASH, NLC, blindness = lenNLC)
649 ! Ensure the width is minimally set to the maximum line length (~61) of the splash message.
650 !print *, getOption(132_IK, width)
651 linewidth = max(maxval(locNLC(2 : lenLocNLC) - locNLC(1 : lenLocNLC - 1)) - lenNLC, getOption(132_IK, width))! + lwsize_def + rwsize_def
652 splashLen = lenNLC + (twsize_def + lenLocNLC + bwsize_def) * (linewidth + lenNLC)
653 allocate(character(splashLen, SK) :: splash)
654 splash(1 : lenNLC) = NLC
655 ibeg = lenNLC + 1_IK
656 do iline = 1, twsize_def
657 iend = ibeg + linewidth - 1_IK
658 splash(ibeg : iend) = repeat(twfill_def, linewidth)
659 ibeg = iend + lenNLC + 1
660 splash(iend + 1 : ibeg - 1) = NLC
661 end do
662 if (lenLocNLC > 0_IK) then
663 sbeg = 1_IK ! splash line beginning.
664 do iline = 1, lenLocNLC
665 iend = ibeg + linewidth - 1_IK
666 call setCentered( splash(ibeg : iend) & ! LCOV_EXCL_LINE
667 , PARAMONTE_SPLASH(sbeg : locNLC(iline) - 1) & ! LCOV_EXCL_LINE
668 , lmsize = lwsize_def & ! LCOV_EXCL_LINE
669 , rmsize = rwsize_def & ! LCOV_EXCL_LINE
670 , lmfill = lwfill_def & ! LCOV_EXCL_LINE
671 , rmfill = rwfill_def & ! LCOV_EXCL_LINE
672 , fill = fill_def & ! LCOV_EXCL_LINE
673 )
674 sbeg = locNLC(iline) + lenNLC
675 ibeg = iend + lenNLC + 1_IK
676 splash(iend + 1 : ibeg - 1) = NLC
677 end do
678 else
679 call setCentered( splash & ! LCOV_EXCL_LINE
680 , PARAMONTE_SPLASH & ! LCOV_EXCL_LINE
681 , lmsize = lwsize_def & ! LCOV_EXCL_LINE
682 , rmsize = rwsize_def & ! LCOV_EXCL_LINE
683 , lmfill = lwfill_def & ! LCOV_EXCL_LINE
684 , rmfill = rwfill_def & ! LCOV_EXCL_LINE
685 , fill = fill_def & ! LCOV_EXCL_LINE
686 ) ! LCOV_EXCL_LINE
687 end if
688 do iline = 1, bwsize_def
689 iend = ibeg + linewidth - 1_IK
690 splash(ibeg : iend) = repeat(bwfill_def, linewidth)
691 ibeg = iend + lenNLC + 1
692 splash(iend + 1 : ibeg - 1) = NLC
693 end do
694 end function
695
696!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
697
698end module pm_paramonte ! LCOV_EXCL_LINE
pm_arrayCenter::setCentered
Center the contents of the input array within the output arrayCentered while filling the newly added ...
Definition: pm_arrayCenter.F90:1119
pm_arrayFind::setLoc
Return an allocatable array containing the indices of the locations within the input array where the ...
Definition: pm_arrayFind.F90:7624
pm_arrayResize::setResized
Allocate or resize (shrink or expand) an input allocatable scalar string or array of rank 1....
Definition: pm_arrayResize.F90:249
pm_option::getOption
Generate and return the value of the optional input argument if it is present, otherwise,...
Definition: pm_option.F90:135
pm_arrayCenter
This module contains procedures and generic interfaces for resizing an input array and centering the ...
Definition: pm_arrayCenter.F90:35
pm_arrayFind
This module contains procedures and generic interfaces for finding locations of a pattern in arrays o...
Definition: pm_arrayFind.F90:96
pm_arrayResize
This module contains procedures and generic interfaces for resizing allocatable arrays of various typ...
Definition: pm_arrayResize.F90:81
pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
pm_kind::IK
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
pm_kind::SK
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
pm_option
This module contains procedures, generic interfaces, and types for generating default values for opti...
Definition: pm_option.F90:34
pm_paramonte
This module contains procedures and data that provide general information about the ParaMonte library...
Definition: pm_paramonte.F90:39
pm_paramonte::PARAMONTE_SPLASH
character(*, SK), parameter PARAMONTE_SPLASH
The public scalar character constant of default kind SK containing the ParaMonte splash information.
Definition: pm_paramonte.F90:507
pm_paramonte::envis
type(envis_type), parameter envis
The scalar constant object of type envis_type whose components are all .false. except the environment...
Definition: pm_paramonte.F90:363
pm_paramonte::getParaMonteSplash
PURE character(:, SK) function, allocatable getParaMonteSplash(width, lwsize, twsize, rwsize, bwsize, fill, lwfill, twfill, rwfill, bwfill)
Generate and return an allocatable scalar character of default kind SK containing the ParaMonte libra...
Definition: pm_paramonte.F90:623
pm_paramonte::PARAMONTE_VERSION
character(*, SK), parameter PARAMONTE_VERSION
The public scalar character constant of default kind SK containing the ParaMonte library version.
Definition: pm_paramonte.F90:453
pm_paramonte::PARAMONTE_BUILD_DATE
character(*, SK), parameter PARAMONTE_BUILD_DATE
The public scalar character constant of default kind SK containing the ParaMonte library build date.
Definition: pm_paramonte.F90:408
pm_paramonte::paramonte
type(paramonte_type), parameter paramonte
The scalar module constant of type paramonte_type that can be used within the ParaMonte library to si...
Definition: pm_paramonte.F90:199
pm_paramonte::PARAMONTE_COMPILER_OPTIONS
character(*, SK), parameter PARAMONTE_COMPILER_OPTIONS
The scalar constant of type character of default kind SK, containing the compiler options used to bui...
Definition: pm_paramonte.F90:154
pm_paramonte::envname
character(*, SK), parameter envname
The scalar constant of type character of default kind SK containing the full generic name of the prog...
Definition: pm_paramonte.F90:312
pm_paramonte::PARAMONTE_WEB_REPOSITORY
character(*, SK), parameter PARAMONTE_WEB_REPOSITORY
The scalar constant of type character of default kind SK, containing the web portal address for the P...
Definition: pm_paramonte.F90:68
pm_paramonte::PARAMONTE_WEB_DOC
character(*, SK), parameter PARAMONTE_WEB_DOC
The scalar constant of type character of default kind SK, containing the web portal address for repor...
Definition: pm_paramonte.F90:110
pm_paramonte::PARAMONTE_WEB_ISSUES
character(*, SK), parameter PARAMONTE_WEB_ISSUES
The scalar constant of type character of default kind SK, containing the web portal address for repor...
Definition: pm_paramonte.F90:89
pm_paramonte::PARAMONTE_COMPILER_VERSION
character(*, SK), parameter PARAMONTE_COMPILER_VERSION
The scalar constant of type character of default kind SK, containing the version of the compiler with...
Definition: pm_paramonte.F90:133
pm_str
This module contains classes and procedures for various string manipulations and inquiries.
Definition: pm_str.F90:49
pm_str::UNDEFINED
character(*, SK), parameter UNDEFINED
The scalar character parameter of default kind SK containing "UNDEFINED".
Definition: pm_str.F90:93
pm_str::NLC
character(*, SK), parameter NLC
The newline character of default kind SK as returned by new_line(SK_"a").
Definition: pm_str.F90:88
pm_paramonte::envis_type
This is the derived type for generating objects containing scalar components of type logical named af...
Definition: pm_paramonte.F90:331
pm_paramonte::paramonte_type
This a derived type devoid of any components or methods whose instantiated objects are used within th...
Definition: pm_paramonte.F90:177