Line data    Source code

       1             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
       2             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
       3             : !!!!
       4             : !!!!   MIT License
       5             : !!!!
       6             : !!!!   ParaMonte: plain powerful parallel Monte Carlo library.
       7             : !!!!
       8             : !!!!   Copyright (C) 2012-present, The Computational Data Science Lab
       9             : !!!!
      10             : !!!!   This file is part of the ParaMonte library.
      11             : !!!!
      12             : !!!!   Permission is hereby granted, free of charge, to any person obtaining a 
      13             : !!!!   copy of this software and associated documentation files (the "Software"), 
      14             : !!!!   to deal in the Software without restriction, including without limitation 
      15             : !!!!   the rights to use, copy, modify, merge, publish, distribute, sublicense, 
      16             : !!!!   and/or sell copies of the Software, and to permit persons to whom the 
      17             : !!!!   Software is furnished to do so, subject to the following conditions:
      18             : !!!!
      19             : !!!!   The above copyright notice and this permission notice shall be 
      20             : !!!!   included in all copies or substantial portions of the Software.
      21             : !!!!
      22             : !!!!   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
      23             : !!!!   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
      24             : !!!!   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
      25             : !!!!   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
      26             : !!!!   DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
      27             : !!!!   OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
      28             : !!!!   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
      29             : !!!!
      30             : !!!!   ACKNOWLEDGMENT
      31             : !!!!
      32             : !!!!   ParaMonte is an honor-ware and its currency is acknowledgment and citations.
      33             : !!!!   As per the ParaMonte library license agreement terms, if you use any parts of 
      34             : !!!!   this library for any purposes, kindly acknowledge the use of ParaMonte in your 
      35             : !!!!   work (education/research/industry/development/...) by citing the ParaMonte 
      36             : !!!!   library as described on this page:
      37             : !!!!
      38             : !!!!       https://github.com/cdslaborg/paramonte/blob/main/ACKNOWLEDGMENT.md
      39             : !!!!
      40             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
      41             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
      42             : 
      43             : !> \brief
      44             : !> This module contains the classes and procedures for setting up the `randomStartPointRequested` attribute of samplers of class [ParaMCMC_type](@ref paramcmc_mod::paramcmc_type).
      45             : !> For more information, see the description of this attribute in the body of the module.
      46             : !> \author Amir Shahmoradi
      47             : 
      48             : module SpecMCMC_RandomStartPointRequested_mod
      49             : 
      50             :     implicit none
      51             : 
      52             :     character(*), parameter         :: MODULE_NAME = "@SpecMCMC_RandomStartPointRequested_mod"
      53             : 
      54             :     logical                         :: randomStartPointRequested ! namelist input
      55             : 
      56             :     type                            :: RandomStartPointRequested_type
      57             :         logical                     :: val
      58             :         logical                     :: def
      59             :         character(:), allocatable   :: desc
      60             :     contains
      61             :         procedure, pass             :: set, nullifyNameListVar
      62             :     end type RandomStartPointRequested_type
      63             : 
      64             :     interface RandomStartPointRequested_type
      65             :         module procedure            :: construct
      66             :     end interface RandomStartPointRequested_type
      67             : 
      68             :     private :: construct, set, nullifyNameListVar
      69             : 
      70             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      71             : 
      72             : contains
      73             : 
      74             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      75             : 
      76        1047 :     function construct(methodName) result(self)
      77             : #if INTEL_COMPILER_ENABLED && defined DLL_ENABLED && (OS_IS_WINDOWS || defined OS_IS_DARWIN)
      78             :         !DEC$ ATTRIBUTES DLLEXPORT :: construct
      79             : #endif
      80             :         use String_mod, only: log2str
      81             :         implicit none
      82             :         character(*), intent(in)                :: methodName
      83             :         type(RandomStartPointRequested_type)    :: self
      84        1047 :         self%def = .false.
      85             :         self%desc = &
      86             :         "A logical (boolean) variable. If true (or .true. or TRUE or .t. from within an input file), then the variable startPointVec &
      87             :         &will be initialized randomly for each MCMC chain that is to be generated by " // methodName // ". The random values will be &
      88             :         &drawn from the specified or the default domain of startPointVec, given by RandomStartPointDomain variable. Note that the &
      89             :         &value of startPointVec, if provided, has precedence over random initialization. In other words, for every element of &
      90             :         &startPointVec that is not provided as input only that element will initialized randomly if randomStartPointRequested=TRUE. &
      91             :         &Also, note that even if startPointVec is randomly initialized, its random value will be deterministic between different &
      92             :         &independent runs of " // methodName // " if the input variable randomSeed is provided by the user. &
      93        1047 :         &The default value is " // log2str(self%def) // "."
      94        1047 :     end function construct
      95             : 
      96             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      97             : 
      98        1047 :     subroutine nullifyNameListVar(self)
      99             : #if INTEL_COMPILER_ENABLED && defined DLL_ENABLED && (OS_IS_WINDOWS || defined OS_IS_DARWIN)
     100             :         !DEC$ ATTRIBUTES DLLEXPORT :: nullifyNameListVar
     101             : #endif
     102             :         implicit none
     103             :         class(RandomStartPointRequested_type), intent(in)    :: self
     104        1047 :         randomStartPointRequested = self%def
     105        1047 :     end subroutine nullifyNameListVar
     106             : 
     107             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     108             : 
     109        1053 :     subroutine set(self,randomStartPointRequested)
     110             : #if INTEL_COMPILER_ENABLED && defined DLL_ENABLED && (OS_IS_WINDOWS || defined OS_IS_DARWIN)
     111             :         !DEC$ ATTRIBUTES DLLEXPORT :: set
     112             : #endif
     113             :         implicit none
     114             :         class(RandomStartPointRequested_type), intent(inout)    :: self
     115             :         logical, intent(in)                                     :: randomStartPointRequested
     116        1053 :         self%val = randomStartPointRequested
     117        2100 :     end subroutine set
     118             : 
     119             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     120             : 
     121             : end module SpecMCMC_RandomStartPointRequested_mod ! LCOV_EXCL_LINE