pm_bench.F90

Go to the documentation of this file.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!                                                                                                                            !!!!
!!!!    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_bench
 
    use pm_kind, only: SK, IK, LK, RKD
    use pm_timer, only: TimerCPU_type
    use pm_timer, only: TimerDAT_type
#if MPI_ENABLED
    use pm_timer, only: timerMPI_type
#endif
#if OMP_ENABLED
    use pm_timer, only: timerOMP_type
#endif
    use pm_timer, only: timerSYS_type
    use pm_timer, only: timer_type
 
    implicit none
 
    character(*, SK), parameter :: MODULE_NAME = SK_"@pm_bench"
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    abstract interface
        subroutine exec_proc()
        end subroutine exec_proc
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    !!>  \brief
    !!>  This is the base class for creating objects that hold the statistics of the timing information of a benchmark.
    !!>
    !!>  \remark
    !!>  This type should generally not be explicitly used outside the [pm_bench](@ref pm_bench).
    !!>  It merely serves to create the `stat` component of the [timing_type](@ref timing_type) class below.
    !!>
    !!>  \see
    !!>  [timing_type](@ref timing_type)<br>
    !!>
    !!>  \test
    !!>  [test_pm_bench](@ref test_pm_bench)
    !!>
    !!>  \final{Stat_type}
    !!>
    !!>  \author
    !!>  Amir Shahmoradi, Wednesday 4:13 AM, August 13, 2016, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin
    !type                :: Stat_type
    !    real(RKD)       :: min      = -huge(0._RKD) !<  @public The minimum of the timing vector of the benchmark (in seconds).
    !    real(RKD)       :: max      = -huge(0._RKD) !<  @public The maximum of the timing vector of the benchmark (in seconds).
    !    real(RKD)       :: std      = -huge(0._RKD) !<  @public The standard deviation of the timing vector of the benchmark (in seconds).
    !    real(RKD)       :: mean     = -huge(0._RKD) !<  @public The mean of the timing vector of the benchmark (in seconds).
    !   !real(RKD)       :: median   = -huge(0._RKD) !<  @public The median of the timing vector of the benchmark (in seconds).
    !   !real(RKD)       :: skewness = -huge(0._RKD) !<  @public The skewness of the timing vector of the benchmark.
    !   !real(RKD)       :: kurtosis = -huge(0._RKD) !<  @public The kurtosis of the timing vector of the benchmark.
    !end type Stat_type
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    type                                :: timing_type
       !type(Stat_type)                 :: stat                     !<  @public The object of type [Stat_type](@ref Stat_type) containing the statistics of the `values` component.
        real(RKD)                       :: overhead = 0._RKD
        real(RKD)                       :: min      = -huge(0._RKD)
        real(RKD)                       :: max      = -huge(0._RKD)
        real(RKD)                       :: std      = -huge(0._RKD)
        real(RKD)                       :: mean     = -huge(0._RKD)
       !real(RKD)                       :: median   = -huge(0._RKD) !<  @public The median of the timing vector of the benchmark (in seconds).
       !real(RKD)                       :: skewness = -huge(0._RKD) !<  @public The skewness of the timing vector of the benchmark.
       !real(RKD)                       :: kurtosis = -huge(0._RKD) !<  @public The kurtosis of the timing vector of the benchmark.
        real(RKD)       , allocatable   :: values(:)
    end type
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    type                                        :: benchBase_type
        real(RKD)                               :: minsec = 0.05_RKD
        integer(IK)                             :: miniter = 1_IK
        type(timing_type)                       :: timing
        character(:, SK)    , allocatable       :: name
        class(timer_type)   , allocatable       :: timer
    end type
 
    interface benchBase_type
        module procedure :: benchBase_typer
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    interface benchBase_typer
    module function benchBase_typer(name, minsec, miniter, timer) result(benchBase)
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: benchBase_typer
#endif
        use pm_kind, only: SK, IK, RKD
        use pm_timer, only: timer_type
        character(*, SK)    , intent(in)                :: name
        real(RKD)           , intent(in)    , optional  :: minsec
        integer(IK)         , intent(in)    , optional  :: miniter
        class(timer_type)   , intent(in)    , optional  :: timer
        type(benchBase_type)                            :: benchBase
    end function
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    type, extends(benchBase_type)                       :: bench_type
       !logical(LK)                          , private  :: isdone = .false._LK          !<  \private    The scalar `logical` of default kind \LK that is set to `.true.` once the benchmark is over (used internally to finalize the pointer components of the type).
        procedure(exec_proc), pointer, nopass, private  :: exec => null()               
        procedure(exec_proc), pointer, nopass, private  :: overhead => null()           
    contains
        final                                           :: finalizeBench                
        procedure, pass                                 :: getTiming => getTimingMethod 
        procedure, pass                                 :: setTiming => setTimingMethod 
    end type
 
    interface bench_type
        module procedure :: bench_typer  
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    interface bench_typer
    module function bench_typer(name, exec, overhead, minsec, miniter, timer) result(bench)
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: bench_typer
#endif
        use pm_timer, only: timer_type
        character(*, SK)    , intent(in)            :: name
        procedure(exec_proc)                        :: exec
        procedure(exec_proc)            , optional  :: overhead
        real(RKD)           , intent(in), optional  :: minsec
        integer(IK)         , intent(in), optional  :: miniter
        class(timer_type)   , intent(in), optional  :: timer
        type(bench_type)                            :: bench
    end function
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    interface getTiming
    module function getTimingMethod(self, minsec, miniter) result(timing)
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: getTimingMethod
#endif
        use pm_kind, only: IK, RKD
        class(bench_type)   , intent(inout)             :: self
        integer(IK)         , intent(in)    , optional  :: miniter
        real(RKD)           , intent(in)    , optional  :: minsec
        type(timing_type)                               :: timing
    end function
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    interface setTiming
    module subroutine setTimingMethod(self, minsec, miniter)
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: setTimingMethod
#endif
        use pm_kind, only: IK, RKD
        class(bench_type)   , intent(inout)             :: self
        integer(IK)         , intent(in)    , optional  :: miniter
        real(RKD)           , intent(in)    , optional  :: minsec
        !RUN_TIMING(self%timing)
    end subroutine
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    !!>  \brief
    !!>  This is the base class for creating objects that hold the timing information of multiple benchmark objects and the timing statistics.
    !!>
    !!>  \remark
    !!>  This type should generally not be explicitly used outside the [pm_bench](@ref pm_bench).<br>
    !!>  It merely serves to create the `timing` component of the [benchMulti_type](@ref benchMulti_type) class below.<br>
    !!>
    !!>  \see
    !!>  [benchMulti_type](@ref pm_bench::benchMulti_type)<br>
    !!>  [timerDAT_type](@ref pm_timer::timerDAT_type)<br>
    !!>  [timerMPI_type](@ref pm_timer::timerMPI_type)<br>
    !!>  [timerOMP_type](@ref pm_timer::timerOMP_type)<br>
    !!>  [timerSYS_type](@ref pm_timer::timerSYS_type)<br>
    !!>  [timer_type](@ref pm_timer::timer_type)<br>
    !!>
    !!>  \test
    !!>  [test_pm_bench](@ref test_pm_bench)
    !!>
    !!>  \final{timing_type}
    !!>
    !!>  \author
    !!>  Amir Shahmoradi, Wednesday 4:13 AM, August 13, 2016, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin
    !type                                :: timing_type
    !    real(RKD)                       :: overhead = 0._RKD        !<  \public The average timing overhead in units of seconds.
    !    real(RKD)                       :: min      = -huge(0._RKD) !<  \public The minimum of the timing vector of the benchmark (in seconds).
    !    real(RKD)                       :: max      = -huge(0._RKD) !<  \public The maximum of the timing vector of the benchmark (in seconds).
    !    real(RKD)                       :: std      = -huge(0._RKD) !<  \public The standard deviation of the timing vector of the benchmark (in seconds).
    !    real(RKD)                       :: mean     = -huge(0._RKD) !<  \public The mean of the timing vector of the benchmark (in seconds).
    !   !real(RKD)                       :: median   = -huge(0._RKD) !<  \public The median of the timing vector of the benchmark (in seconds).
    !   !real(RKD)                       :: skewness = -huge(0._RKD) !<  \public The skewness of the timing vector of the benchmark.
    !   !real(RKD)                       :: kurtosis = -huge(0._RKD) !<  \public The kurtosis of the timing vector of the benchmark.
    !    type(container) , allocatable   :: case(:)                  !<  \public The matrix of timing results in units of seconds, corrected by the average overhead time.
    !end type
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    type                                    :: benchMulti_type
        integer(IK)                         :: ncase
        character(:, SK)    , allocatable   :: name
        type(bench_type)    , allocatable   :: case(:)
       !type(timing_type)                   :: timing                       !<  The object of type [timing_type](@ref pm_bench::timing_type) containing
       !                                                                    !!  the timing information and statistics of the benchmark.
    contains
        procedure, pass                     :: showsum => showsum_          
    end type
 
    interface benchMulti_type
        module procedure :: benchMulti_typer
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    interface benchMulti_typer
    module function benchMulti_typer(case, sorted, repeat) result(self)
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: benchMulti_typer
#endif
        use pm_kind, only: IK, LK
        type(benchMulti_type)                           :: self
        type(bench_type)    , intent(in), contiguous    :: case(:)
        logical(LK)         , intent(in), optional      :: sorted
        integer(IK)         , intent(in), optional      :: repeat
    end function
    end interface
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    interface showsum
    module subroutine showsum_(self, unit, tabular)
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: showsum_
#endif
        class(benchMulti_type)  , intent(in)            :: self
        integer(IK)             , intent(in), optional  :: unit
        logical(LK)             , intent(in), optional  :: tabular
    end subroutine
    end interface
 
contains
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    subroutine finalizeBench(self)
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: finalizeBench
#endif
        type(bench_type), intent(inout) :: self
        !if (self%isdone) then
        nullify(self%overhead)
        nullify(self%exec)
        !end if
    end subroutine
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
    impure subroutine doNothing()
#if __INTEL_COMPILER && DLL_ENABLED && (_WIN32 || _WIN64)
        !DEC$ ATTRIBUTES DLLEXPORT :: doNothing
#endif
    end subroutine
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
end module pm_bench ! LCOV_EXCL_LINE