This is a derived type for constructing objects containing the optional simulation properties of the ParaMonte library explorers and samplers.
More...

Inheritance diagram for pm_sampling::sampler_type:

[legend]

Public Attributes
character(:, SKG), allocatable	description
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#description More...

character(:, SKG), allocatable	domain
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domain More...

character(:, SKG), dimension(:), allocatable	domainAxisName
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainaxisname More...

real(RKH), dimension(:), allocatable	domainBallAvg
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballavg More...

real(RKH), dimension(:,:), allocatable	domainBallCor
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballcor More...

real(RKH), dimension(:,:), allocatable	domainBallCov
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballcov More...

real(RKH), dimension(:), allocatable	domainBallStd
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballstd More...

real(RKH), dimension(:), allocatable	domainCubeLimitLower
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domaincubelimitlower More...

real(RKH), dimension(:), allocatable	domainCubeLimitUpper
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domaincubelimitupper More...

integer(IK), allocatable	domainErrCount
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainerrcount More...

integer(IK), allocatable	domainErrCountMax
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainerrcountmax More...

character(:, SKG), allocatable	inputFile
	The input scalar `character` of default kind SK which be either,. More...

character(:, SKG), allocatable	outputChainFileFormat
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputchainfileformat More...

integer(IK), allocatable	outputColumnWidth
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputcolumnwidth More...

character(:, SKG), allocatable	outputFileName
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputfilename More...

character(:, SKG), allocatable	outputStatus
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputstatus More...

integer(IK), allocatable	outputPrecision
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputprecision More...

integer(IK), allocatable	outputReportPeriod
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputreportperiod More...

character(:, SKG), allocatable	outputRestartFileFormat
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputrestartfileformat More...

integer(IK), allocatable	outputSampleSize
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputsamplesize More...

character(:, SKG), allocatable	outputSeparator
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputseparator More...

character(:, SKG), allocatable	outputSplashMode
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputsplashmode More...

character(:, SKG), allocatable	parallelism
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#parallelism More...

logical(LK), allocatable	parallelismMpiFinalizeEnabled
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#parallelismmpifinalizeenabled More...

integer(IK), allocatable	parallelismNumThread
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#parallelismnumthread More...

integer(IK), allocatable	randomSeed
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#randomseed More...

character(:, SKG), allocatable	sysInfoFilePath
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#sysinfofilepath More...

real(RKH), dimension(:), allocatable	targetAcceptanceRate
	See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#targetacceptancerate More...

Detailed Description

This is a derived type for constructing objects containing the optional simulation properties of the ParaMonte library explorers and samplers.

See the documentation of getErrSampling for example usage.
Objects of this derived type are not meant to be used directly by the end users.
Instead use one of the appropriate derived types:

Note

For more information on any of the components of this derived type, see the output _report.txt files from the corresponding sampler simulations.
Alternatively, see the ParaMonte library cross-language sampler documentation for detailed descriptions of the input simulation specifications at:

ParaDRAM simulation options

See also: paradram_type
paranest_type
paradise_type
getErrSampling

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, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 80 of file pm_sampling.F90.

Member Data Documentation

◆ description

character(:,SKG), allocatable pm_sampling::sampler_type::description

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#description

Definition at line 81 of file pm_sampling.F90.

◆ domain

character(:,SKG), allocatable pm_sampling::sampler_type::domain

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domain

Definition at line 82 of file pm_sampling.F90.

◆ domainAxisName

character(:,SKG), dimension(:), allocatable pm_sampling::sampler_type::domainAxisName

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainaxisname

Definition at line 83 of file pm_sampling.F90.

◆ domainBallAvg

real(RKH), dimension(:), allocatable pm_sampling::sampler_type::domainBallAvg

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballavg

Definition at line 84 of file pm_sampling.F90.

◆ domainBallCor

real(RKH), dimension(:,:), allocatable pm_sampling::sampler_type::domainBallCor

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballcor

Definition at line 85 of file pm_sampling.F90.

◆ domainBallCov

real(RKH), dimension(:,:), allocatable pm_sampling::sampler_type::domainBallCov

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballcov

Definition at line 86 of file pm_sampling.F90.

◆ domainBallStd

real(RKH), dimension(:), allocatable pm_sampling::sampler_type::domainBallStd

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainballstd

Definition at line 87 of file pm_sampling.F90.

◆ domainCubeLimitLower

real(RKH), dimension(:), allocatable pm_sampling::sampler_type::domainCubeLimitLower

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domaincubelimitlower

Definition at line 88 of file pm_sampling.F90.

◆ domainCubeLimitUpper

real(RKH), dimension(:), allocatable pm_sampling::sampler_type::domainCubeLimitUpper

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domaincubelimitupper

Definition at line 89 of file pm_sampling.F90.

◆ domainErrCount

integer(IK), allocatable pm_sampling::sampler_type::domainErrCount

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainerrcount

Definition at line 90 of file pm_sampling.F90.

◆ domainErrCountMax

integer(IK), allocatable pm_sampling::sampler_type::domainErrCountMax

See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#domainerrcountmax

Definition at line 91 of file pm_sampling.F90.

◆ inputFile

character(:,SKG), allocatable pm_sampling::sampler_type::inputFile

The input scalar character of default kind SK which be either,.

The path to an external input namelist file containing the simulation settings.
A string containing the simulation settings in namelist format.
The following rules apply to variable assignments in namelist-style input:
1. Comments must begin with an exclamation mark !.
2. Comments can appear anywhere on an empty line or, after a variable assignment (but not in the middle of a variable assignment whether in single or multiple lines).
3. All variable assignments are optional and can be commented out. In such cases, appropriate default values will be used.
4. All variable assignments must appear within a namelist group which starts with either
  1. the (case-INsensitive) keyword &paradise to be used for specifying paradram_type simulation specifications.
  2. the (case-INsensitive) keyword &paradram to be used for specifying paradram_type simulation specifications.
  3. the (case-INsensitive) keyword &paranest to be used for specifying paradram_type simulation specifications.
  and ends with a forward slash / on the last line of the namelist group.
5. Every time a sampler opens an input file, it will first search for the namelist group with the corresponding sampler name.
6. The order of the input variables in the namelist groups is irrelevant and unimportant.
7. Variables can be defined multiple times, but only the last definition will be considered as input.
8. All variable names are case-insensitive. However, for clarity, this software follows the camelCase code-writing practice for simulation specification names.
9. String values must be enclosed with either single or double quotation marks.
10. Logical values are case-insensitive and can be either
  1. .true., true, or t (all case-insensitive) representing the truth, or,
  2. .false., false, or f (all case-insensitive) representing the falsehood.
11. All vectors and arrays specified within the input file start with a lower-bound of 1 as opposed to 0 in the C family of languages.
  This follows the convention of the majority of science-oriented programming languages: Fortran, Julia, Mathematica, MATLAB, and R.
12. Specifying multiple values is as simple as listing the elements as comma or space -separated values.
13. Individual vector or element values can be specified by an explicit index or index range:
  
  &paranest
  
  domainAxisName(1 : 2) = "sampleVariable1", "sampleVariable2"
  
  domainAxisName(3) = "sampleVariable3"
  
  /
14. If a sequence of elements of a vector or array are equal, the assignment can be succinctly expressed via the following convention:
  
  &paradram
  
  proposalStart = 4 * 0. ! assign value `0.` to the first four elements of proposalStart.
  
  /
15. Matrix assignments follow the column-major storage scheme in memory.
  
  &paradram
  
  proposalCor = 1, 0, 0, 0
  
  , 0, 1, 0, 0
  
  , 0, 0, 1, 0
  
  , 0, 0, 0, 1
  
  /