Source code for paramonte._SpecMCMC

####################################################################################################################################
####################################################################################################################################
####
####   MIT License
####
####   ParaMonte: plain powerful parallel Monte Carlo library.
####
####   Copyright (C) 2012-present, The Computational Data Science Lab
####
####   This file is part of the ParaMonte library.
####
####   Permission is hereby granted, free of charge, to any person obtaining a 
####   copy of this software and associated documentation files (the "Software"), 
####   to deal in the Software without restriction, including without limitation 
####   the rights to use, copy, modify, merge, publish, distribute, sublicense, 
####   and/or sell copies of the Software, and to permit persons to whom the 
####   Software is furnished to do so, subject to the following conditions:
####
####   The above copyright notice and this permission notice shall be 
####   included in all copies or substantial portions of the Software.
####
####   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
####   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
####   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
####   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
####   DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
####   OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
####   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
####
####   ACKNOWLEDGMENT
####
####   ParaMonte is an honor-ware and its currency is acknowledgment and citations.
####   As per the ParaMonte library license agreement terms, if you use any parts of 
####   this library for any purposes, kindly acknowledge the use of ParaMonte in your 
####   work (education/research/industry/development/...) by citing the ParaMonte 
####   library as described on this page:
####
####       https://github.com/cdslaborg/paramonte/blob/main/ACKNOWLEDGMENT.md
####
####################################################################################################################################
####################################################################################################################################

import numpy as np
from _SpecBase import inputFileDelim

####################################################################################################################################
#### SpecMCMC specification type-checking class
####################################################################################################################################

[docs]def chainSize(chainSize): if isinstance(chainSize,int): return "chainSize=" + str(chainSize) + inputFileDelim else: raise TypeError("The input specification, chainSize, must be of type int.")
####################################################################################################################################
[docs]def scaleFactor(scaleFactor): if isinstance(scaleFactor,str): return "scaleFactor=" + "'" + str(scaleFactor) + "'" + inputFileDelim else: raise TypeError("The input specification, scaleFactor, must be of type str.")
####################################################################################################################################
[docs]def startPointVec(startPointVec): if isinstance(startPointVec,(list,tuple,np.ndarray)): return "startPointVec=" + str(np.array(list(startPointVec)).flatten()).strip('[]') + inputFileDelim else: raise TypeError("The input specification, startPointVec, must be a list, tuple, or numpy vector of ndim or less elements of type float.")
####################################################################################################################################
[docs]def proposalModel(proposalModel): if isinstance(proposalModel,str): return "proposalModel=" + "'" + str(proposalModel) + "'" + inputFileDelim else: raise TypeError("The input specification, proposalModel, must be of type str.")
####################################################################################################################################
[docs]def proposalStartCovMat(proposalStartCovMat): if isinstance(proposalStartCovMat,(list,tuple,np.ndarray)): return "proposalStartCovMat=" + str(np.array(list(proposalStartCovMat)).flatten()).strip('[]') + inputFileDelim else: raise TypeError("The input specification, proposalStartCovMat, must be a symmetric 2-dimensional list, tuple, or numpy matrix of ndim-by-ndim or, " "a list, tuple, or numpy vector of ndim**2 or less elements of type float.")
####################################################################################################################################
[docs]def proposalStartCorMat(proposalStartCorMat): if isinstance(proposalStartCorMat,(list,tuple,np.ndarray)): return "proposalStartCorMat=" + str(np.array(list(proposalStartCorMat)).flatten()).strip('[]') + inputFileDelim else: raise TypeError("The input specification, proposalStartCorMat, must be a symmetric 2-dimensional list, tuple, or numpy matrix of ndim-by-ndim or, " "a list, tuple, or numpy vector of ndim**2 or less elements of type float.")
####################################################################################################################################
[docs]def proposalStartStdVec(proposalStartStdVec): if isinstance(proposalStartStdVec,(list,tuple,np.ndarray)): return "proposalStartStdVec=" + str(np.array(list(proposalStartStdVec)).flatten()).strip('[]') + inputFileDelim else: raise TypeError("The input specification, proposalStartStdVec, must be a list, tuple, or numpy vector of ndim or less elements of type float.")
####################################################################################################################################
[docs]def sampleRefinementCount(sampleRefinementCount): if isinstance(sampleRefinementCount,int): return "sampleRefinementCount=" + str(sampleRefinementCount) + inputFileDelim else: raise TypeError("The input specification, sampleRefinementCount, must be of type int.")
####################################################################################################################################
[docs]def sampleRefinementMethod(sampleRefinementMethod): if isinstance(sampleRefinementMethod,str): return "sampleRefinementMethod=" + "'" + str(sampleRefinementMethod) + "'" + inputFileDelim else: raise TypeError("The input specification, sampleRefinementMethod, must be of type str.")
####################################################################################################################################
[docs]def randomStartPointRequested(randomStartPointRequested): if isinstance(randomStartPointRequested,bool): return "randomStartPointRequested=" + str(randomStartPointRequested) + inputFileDelim else: raise TypeError("The input specification, randomStartPointRequested, must be of type bool (True or False).")
####################################################################################################################################
[docs]def randomStartPointDomainLowerLimitVec(randomStartPointDomainLowerLimitVec): if isinstance(randomStartPointDomainLowerLimitVec,(list,tuple,np.ndarray)): return "randomStartPointDomainLowerLimitVec=" + str(np.array(list(randomStartPointDomainLowerLimitVec)).flatten()).strip('[]') + inputFileDelim else: raise TypeError("The input specification, randomStartPointDomainLowerLimitVec, must be a list, tuple, or numpy vector of ndim or less elements of type float.")
####################################################################################################################################
[docs]def randomStartPointDomainUpperLimitVec(randomStartPointDomainUpperLimitVec): if isinstance(randomStartPointDomainUpperLimitVec,(list,tuple,np.ndarray)): return "randomStartPointDomainUpperLimitVec=" + str(np.array(list(randomStartPointDomainUpperLimitVec)).flatten()).strip('[]') + inputFileDelim else: raise TypeError("The input specification, randomStartPointDomainUpperLimitVec, must be a list, tuple, or numpy vector of ndim or less elements of type float.")
####################################################################################################################################