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

Inheritance diagram for pm_sampling::paranest_type:

[legend]

Collaboration diagram for pm_sampling::paranest_type:

[legend]

Public Attributes
integer(IK), allocatable	domainPartitionAdaptationCount

integer(IK), allocatable	domainPartitionAdaptationPeriod

logical(LK), allocatable	domainPartitionBiasCorrectionEnabled

integer(IK), allocatable	domainPartitionCountMax

real(RKH), allocatable	domainPartitionFactorExpansion

real(RKH), allocatable	domainPartitionFactorShrinkage

integer(IK), allocatable	domainPartitionKmeansClusterCountMax

integer(IK), allocatable	domainPartitionKmeansClusterSizeMin

logical(LK), allocatable	domainPartitionKmeansNormalizationEnabled

integer(IK), allocatable	domainPartitionKmeansNumFailMax

integer(IK), allocatable	domainPartitionKmeansNumRecursionMax

integer(IK), allocatable	domainPartitionKmeansNumTry

integer(IK), allocatable	domainPartitionKvolumeNumRecursionMax

real(RKH), allocatable	domainPartitionKvolumeWeightExponent

character(:, SKG), allocatable	domainPartitionMethod

character(:, SKG), allocatable	domainPartitionObject

logical(LK), allocatable	domainPartitionOptimizationScaleEnabled

logical(LK), allocatable	domainPartitionOptimizationShapeEnabled

logical(LK), allocatable	domainPartitionOptimizationShapeScaleEnabled

real(RKH), allocatable	domainPartitionScaleFactor

character(:, SKG), allocatable	domainSampler

integer(IK), allocatable	liveSampleSize

real(RKH), allocatable	tolerance

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 Nested explorers and samplers.

Note

See the documentation of getErrSampling for example usage.
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
ParaDISE simulation options (work in progress)
ParaNest simulation options (work in progress)

See also: paradram_type
paranest_type
paradise_type
getErrSampling
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 315 of file pm_sampling.F90.

Member Data Documentation

◆ domainPartitionAdaptationCount

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionAdaptationCount

Definition at line 316 of file pm_sampling.F90.

◆ domainPartitionAdaptationPeriod

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionAdaptationPeriod

Definition at line 317 of file pm_sampling.F90.

◆ domainPartitionBiasCorrectionEnabled

logical(LK), allocatable pm_sampling::paranest_type::domainPartitionBiasCorrectionEnabled

Definition at line 318 of file pm_sampling.F90.

◆ domainPartitionCountMax

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionCountMax

Definition at line 319 of file pm_sampling.F90.

◆ domainPartitionFactorExpansion

real(RKH), allocatable pm_sampling::paranest_type::domainPartitionFactorExpansion

Definition at line 320 of file pm_sampling.F90.

◆ domainPartitionFactorShrinkage

real(RKH), allocatable pm_sampling::paranest_type::domainPartitionFactorShrinkage

Definition at line 321 of file pm_sampling.F90.

◆ domainPartitionKmeansClusterCountMax

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionKmeansClusterCountMax

Definition at line 322 of file pm_sampling.F90.

◆ domainPartitionKmeansClusterSizeMin

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionKmeansClusterSizeMin

Definition at line 323 of file pm_sampling.F90.

◆ domainPartitionKmeansNormalizationEnabled

logical(LK), allocatable pm_sampling::paranest_type::domainPartitionKmeansNormalizationEnabled

Definition at line 324 of file pm_sampling.F90.

◆ domainPartitionKmeansNumFailMax

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionKmeansNumFailMax

Definition at line 325 of file pm_sampling.F90.

◆ domainPartitionKmeansNumRecursionMax

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionKmeansNumRecursionMax

Definition at line 326 of file pm_sampling.F90.

◆ domainPartitionKmeansNumTry

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionKmeansNumTry

Definition at line 327 of file pm_sampling.F90.

◆ domainPartitionKvolumeNumRecursionMax

integer(IK), allocatable pm_sampling::paranest_type::domainPartitionKvolumeNumRecursionMax

Definition at line 328 of file pm_sampling.F90.

◆ domainPartitionKvolumeWeightExponent

real(RKH), allocatable pm_sampling::paranest_type::domainPartitionKvolumeWeightExponent

Definition at line 329 of file pm_sampling.F90.

◆ domainPartitionMethod

character(:,SKG), allocatable pm_sampling::paranest_type::domainPartitionMethod

Definition at line 330 of file pm_sampling.F90.

◆ domainPartitionObject

character(:,SKG), allocatable pm_sampling::paranest_type::domainPartitionObject

Definition at line 331 of file pm_sampling.F90.

◆ domainPartitionOptimizationScaleEnabled

logical(LK), allocatable pm_sampling::paranest_type::domainPartitionOptimizationScaleEnabled

Definition at line 332 of file pm_sampling.F90.

◆ domainPartitionOptimizationShapeEnabled

logical(LK), allocatable pm_sampling::paranest_type::domainPartitionOptimizationShapeEnabled

Definition at line 333 of file pm_sampling.F90.

◆ domainPartitionOptimizationShapeScaleEnabled

logical(LK), allocatable pm_sampling::paranest_type::domainPartitionOptimizationShapeScaleEnabled

Definition at line 334 of file pm_sampling.F90.

◆ domainPartitionScaleFactor

real(RKH), allocatable pm_sampling::paranest_type::domainPartitionScaleFactor

Definition at line 335 of file pm_sampling.F90.

◆ domainSampler

character(:,SKG), allocatable pm_sampling::paranest_type::domainSampler

Definition at line 336 of file pm_sampling.F90.

◆ liveSampleSize

integer(IK), allocatable pm_sampling::paranest_type::liveSampleSize

Definition at line 337 of file pm_sampling.F90.

◆ tolerance

real(RKH), allocatable pm_sampling::paranest_type::tolerance

Definition at line 338 of file pm_sampling.F90.

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

src/fortran/main/pm_sampling.F90

Public Attributes