ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_sampling::paramcmc_type Type Reference

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

Inheritance diagram for pm_sampling::paramcmc_type:
Collaboration diagram for pm_sampling::paramcmc_type:

Public Attributes

integer(IK), allocatable outputChainSize
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputchainsize More...
 
integer(IK), allocatable outputSampleRefinementCount
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputsamplerefinementcount More...
 
character(:, SKG), allocatable outputSampleRefinementMethod
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#outputsamplerefinementmethod More...
 
character(:, SKG), allocatable proposal
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposal More...
 
real(RKH), dimension(:,:), allocatable proposalCor
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalcor More...
 
real(RKH), dimension(:,:), allocatable proposalCov
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalcov More...
 
character(:, SKG), allocatable proposalScale
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalscale More...
 
real(RKH), dimension(:), allocatable proposalStart
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalstart More...
 
real(RKH), dimension(:), allocatable proposalStartDomainCubeLimitLower
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalstartdomaincubelimitlower More...
 
real(RKH), dimension(:), allocatable proposalStartDomainCubeLimitUpper
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalstartdomaincubelimitupper More...
 
logical(LK), allocatable proposalStartRandomized
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalstartrandomized More...
 
real(RKH), dimension(:), allocatable proposalStd
 See the generic documentation at: https://www.cdslab.org/paramonte/generic/2/usage/sampling/paradram/specifications/#proposalstd More...
 
- Public Attributes inherited from pm_sampling::sampler_type
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 MCMC 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:

  1. paradram_type
  2. paranest_type
  3. paradise_type
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:
  1. ParaDRAM simulation options
  2. ParaDISE simulation options
  3. ParaNest 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.

  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.

Author:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 209 of file pm_sampling.F90.

Member Data Documentation

◆ outputChainSize

integer(IK), allocatable pm_sampling::paramcmc_type::outputChainSize

◆ outputSampleRefinementCount

integer(IK), allocatable pm_sampling::paramcmc_type::outputSampleRefinementCount

◆ outputSampleRefinementMethod

character(:,SKG), allocatable pm_sampling::paramcmc_type::outputSampleRefinementMethod

◆ proposal

character(:,SKG), allocatable pm_sampling::paramcmc_type::proposal

◆ proposalCor

real(RKH), dimension(:,:), allocatable pm_sampling::paramcmc_type::proposalCor

◆ proposalCov

real(RKH), dimension(:,:), allocatable pm_sampling::paramcmc_type::proposalCov

◆ proposalScale

character(:,SKG), allocatable pm_sampling::paramcmc_type::proposalScale

◆ proposalStart

real(RKH), dimension(:), allocatable pm_sampling::paramcmc_type::proposalStart

◆ proposalStartDomainCubeLimitLower

real(RKH), dimension(:), allocatable pm_sampling::paramcmc_type::proposalStartDomainCubeLimitLower

◆ proposalStartDomainCubeLimitUpper

real(RKH), dimension(:), allocatable pm_sampling::paramcmc_type::proposalStartDomainCubeLimitUpper

◆ proposalStartRandomized

logical(LK), allocatable pm_sampling::paramcmc_type::proposalStartRandomized

◆ proposalStd

real(RKH), dimension(:), allocatable pm_sampling::paramcmc_type::proposalStd

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