fortran/2/pm__ziggurat_8F90_source.html

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!                                                                                                                            !!!!

!!!!    ParaMonte: Parallel Monte Carlo and Machine Learning Library.                                                           !!!!

!!!!                                                                                                                            !!!!

!!!!    Copyright (C) 2012-present, The Computational Data Science Lab                                                          !!!!

!!!!                                                                                                                            !!!!

!!!!    This file is part of the ParaMonte library.                                                                             !!!!

!!!!                                                                                                                            !!!!

!!!!    LICENSE                                                                                                                 !!!!

!!!!                                                                                                                            !!!!

!!!!       https://github.com/cdslaborg/paramonte/blob/main/LICENSE.md                                                          !!!!

!!!!                                                                                                                            !!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!


!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


module pm_ziggurat


    use pm_kind, only: SK, IK, LK


    implicit none


    character(*, SK), parameter :: MODULE_NAME = "@pm_ziggurat"


!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


    !   \example{getZig}

    !   \include{lineno} example/pm_ziggurat/getZig/main.F90

    !   \compile{getZig}

    !   \output{getZig}

    !   \include{lineno} example/pm_ziggurat/getZig/main.out.F90

    !   \postproc{getZig}

    !   \include{lineno} example/pm_ziggurat/getZig/main.py

    !   \vis{getZig}

    !   \image html pm_ziggurat/getZig/getZig.RK.png width=700

    interface getZig


    !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


#if RK5_ENABLED

    impure module function getZig_RK5(nlay, getFunc, getFuncInv, getZigArea, abserr, abstol) result(zig)

#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

        !DEC$ ATTRIBUTES DLLEXPORT :: getZig_RK5

#endif

        use pm_kind, only: RKG => RK5

        procedure(real(RKG))                            :: getFunc, getFuncInv, getZigArea

        integer(IK)         , intent(in)                :: nlay

        real(RKG)           , intent(out)               :: abserr

        real(RKG)           , intent(in)    , optional  :: abstol

        real(RKG)                                       :: zig(2, 0 : nlay)

    end function

#endif


#if RK4_ENABLED

    impure module function getZig_RK4(nlay, getFunc, getFuncInv, getZigArea, abserr, abstol) result(zig)

#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

        !DEC$ ATTRIBUTES DLLEXPORT :: getZig_RK4

#endif

        use pm_kind, only: RKG => RK4

        procedure(real(RKG))                            :: getFunc, getFuncInv, getZigArea

        integer(IK)         , intent(in)                :: nlay

        real(RKG)           , intent(out)               :: abserr

        real(RKG)           , intent(in)    , optional  :: abstol

        real(RKG)                                       :: zig(2, 0 : nlay)

    end function

#endif


#if RK3_ENABLED

    impure module function getZig_RK3(nlay, getFunc, getFuncInv, getZigArea, abserr, abstol) result(zig)

#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

        !DEC$ ATTRIBUTES DLLEXPORT :: getZig_RK3

#endif

        use pm_kind, only: RKG => RK3

        procedure(real(RKG))                            :: getFunc, getFuncInv, getZigArea

        integer(IK)         , intent(in)                :: nlay

        real(RKG)           , intent(out)               :: abserr

        real(RKG)           , intent(in)    , optional  :: abstol

        real(RKG)                                       :: zig(2, 0 : nlay)

    end function

#endif


#if RK2_ENABLED

    impure module function getZig_RK2(nlay, getFunc, getFuncInv, getZigArea, abserr, abstol) result(zig)

#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

        !DEC$ ATTRIBUTES DLLEXPORT :: getZig_RK2

#endif

        use pm_kind, only: RKG => RK2

        procedure(real(RKG))                            :: getFunc, getFuncInv, getZigArea

        integer(IK)         , intent(in)                :: nlay

        real(RKG)           , intent(out)               :: abserr

        real(RKG)           , intent(in)    , optional  :: abstol

        real(RKG)                                       :: zig(2, 0 : nlay)

    end function

#endif


#if RK1_ENABLED

    impure module function getZig_RK1(nlay, getFunc, getFuncInv, getZigArea, abserr, abstol) result(zig)

#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

        !DEC$ ATTRIBUTES DLLEXPORT :: getZig_RK1

#endif

        use pm_kind, only: RKG => RK1

        procedure(real(RKG))                            :: getFunc, getFuncInv, getZigArea

        integer(IK)         , intent(in)                :: nlay

        real(RKG)           , intent(out)               :: abserr

        real(RKG)           , intent(in)    , optional  :: abstol

        real(RKG)                                       :: zig(2, 0 : nlay)

    end function

#endif


    !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


    end interface


!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


!    !>  \brief

!    !>  Generate and return an array of coordinates of the lower rightmost corners of rectangles corresponding to an input Ziggurat set,

!    !>  including the highest point of the target density function.

!    !>

!    !>  \brief

!    !>  This is merely a convenience generic interface.<br>

!    !>  The functionality of this interface can be identically generated via the expression

!    !>  \code{.F90}

!    !>      crd = transpose(reshape(zig(1:), [size(zig) / 2, 2]))

!    !>  \endcode

!    !>  assuming the starting index of `zig` is `0`.<br>

!    !>

!    !>  \param[in]  zig :   The input vector of size `(0 : nlay * 2)` of type `real` of kind \RKALL,

!    !>                      that is the direct output of [getZig](@ref pm_ziggurat::getZig) or similar generic interfaces.<br>

!    !>

!    !>  \return

!    !>  `crd`           :   The output vector of shape `(2, nlay)` of the same type and kind as `zig`,

!    !>                      containing the Ziggurat rectangle lower-corner coordinates.<br>

!    !>

!    !>  \interface{getZigCRD}

!    !>  \code{.F90}

!    !>

!    !>      use pm_ziggurat, only: getZigCRD

!    !>

!    !>      crd(1:2, 1:size(zig)/2) = getZigCRD(zig)

!    !>

!    !>  \endcode

!    !>

!    !>  \warning

!    !>  The condition `mod(size(zig), 2) == 1` must hold for the corresponding input arguments.<br>

!    !>  \vericon

!    !>

!    !>  \impure

!    !>

!    !>  \see

!    !>  [getZig](@ref pm_ziggurat::getZig)<br>

!    !>  [getZigNorm](@ref pm_distNorm::getZigNorm)<br>

!    !>

!    !   \example{getZigCRD}

!    !   \include{lineno} example/pm_ziggurat/getZigCRD/main.F90

!    !   \compile{getZigCRD}

!    !   \output{getZigCRD}

!    !   \include{lineno} example/pm_ziggurat/getZigCRD/main.out.F90

!    !   \postproc{getZigCRD}

!    !   \include{lineno} example/pm_ziggurat/getZigCRD/main.py

!    !   \vis{getZigCRD}

!    !   \image html pm_ziggurat/getZigCRD/getZigCRD.RK.png width=700

!    !>

!    !>  \test

!    !>  [test_pm_ziggurat](@ref test_pm_ziggurat)<br>

!    !>

!    !>  \todo

!    !>  \pmed

!    !>  Examples should be added to the documentation of this generic interface in future.<br>

!    !>

!    !>  \final{getZigCRD}

!    !>

!    !>  \author

!    !>  \AmirShahmoradi, April 25, 2015, 2:21 PM, National Institute for Fusion Studies, The University of Texas Austin<br>

!    interface getZigCRD

!

!    !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

!

!#if RK5_ENABLED

!    impure module function getZigCRD_RK5(zig) result(crd)

!#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

!        !DEC$ ATTRIBUTES DLLEXPORT :: getZigCRD_RK5

!#endif

!        use pm_kind, only: RKG => RK5

!        real(RKG)   , intent(in)                        :: zig(0:)

!        real(RKG)                                       :: crd(2, size(zig, 1, IK) / 2_IK)

!    end function

!#endif

!

!#if RK4_ENABLED

!    impure module function getZigCRD_RK4(zig) result(crd)

!#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

!        !DEC$ ATTRIBUTES DLLEXPORT :: getZigCRD_RK4

!#endif

!        use pm_kind, only: RKG => RK4

!        real(RKG)   , intent(in)                        :: zig(0:)

!        real(RKG)                                       :: crd(2, size(zig, 1, IK) / 2_IK)

!    end function

!#endif

!

!#if RK3_ENABLED

!    impure module function getZigCRD_RK3(zig) result(crd)

!#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

!        !DEC$ ATTRIBUTES DLLEXPORT :: getZigCRD_RK3

!#endif

!        use pm_kind, only: RKG => RK3

!        real(RKG)   , intent(in)                        :: zig(0:)

!        real(RKG)                                       :: crd(2, size(zig, 1, IK) / 2_IK)

!    end function

!#endif

!

!#if RK2_ENABLED

!    impure module function getZigCRD_RK2(zig) result(crd)

!#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

!        !DEC$ ATTRIBUTES DLLEXPORT :: getZigCRD_RK2

!#endif

!        use pm_kind, only: RKG => RK2

!        real(RKG)   , intent(in)                        :: zig(0:)

!        real(RKG)                                       :: crd(2, size(zig, 1, IK) / 2_IK)

!    end function

!#endif

!

!#if RK1_ENABLED

!    impure module function getZigCRD_RK1(zig) result(crd)

!#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)

!        !DEC$ ATTRIBUTES DLLEXPORT :: getZigCRD_RK1

!#endif

!        use pm_kind, only: RKG => RK1

!        real(RKG)   , intent(in)                        :: zig(0:)

!        real(RKG)                                       :: crd(2, size(zig, 1, IK) / 2_IK)

!    end function

!#endif

!

!    !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

!

!    end interface


!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


end module pm_ziggurat ! LCOV_EXCL_LINE

pm_ziggurat::getZig
Generate and return a Ziggurat set for the specified distribution that can be subsequently used for r...
Definition: pm_ziggurat.F90:177

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::RK5
integer, parameter RK5
Definition: pm_kind.F90:478

pm_kind::RK4
integer, parameter RK4
Definition: pm_kind.F90:489

pm_kind::RK2
integer, parameter RK2
Definition: pm_kind.F90:511

pm_kind::RK3
integer, parameter RK3
Definition: pm_kind.F90:500

pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541

pm_kind::IK
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540

pm_kind::SK
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539

pm_kind::RK1
integer, parameter RK1
Definition: pm_kind.F90:522

pm_ziggurat
This module contains procedures and generic interfaces for computing the Ziggurat set for for pseudo-...
Definition: pm_ziggurat.F90:43

pm_ziggurat::MODULE_NAME
character(*, SK), parameter MODULE_NAME
Definition: pm_ziggurat.F90:49