pm_timer::timer_type Interface Reference

This is the abstract base derived type that serves as a simple container template for other timer classes in the ParaMonte library. More...

Inheritance diagram for pm_timer::timer_type:

Public Member Functions
procedure(getTime_proc), deferred, nopass	time
	See getTime_proc. More...
procedure(setIdle_proc), deferred, nopass	wait
	See setIdle_proc. More...
type(timerMPI_type) type(timerOMP_type) type(timerSYS_type) function	timer_typer ()
	This is the constructor of the timer_type class. More...

Public Attributes
real(RKD)	start
	The protected scalar real of kind double precision RKD provided as a convenience for the user to contain the start time of the timer since the processor epoch (a processor-dependent past time) in seconds. More...
real(RKD)	clock
	The scalar real of kind double precision RKD provided as a convenience for the user to contain the total time in seconds elapsed since the start of the timer. The clock time can be readily can be computed as timer%clock = timer%time(since = timer%start). More...
real(RKD)	delta
	The scalar real of kind double precision RKD provided as a convenience for the user to contain the delta time in seconds since the last timing (last timer call). The delta time can be readily can be computed as timer%delta = timer%time(since = timer%start) - timer%clock where timer%clock is the last clock read as timer%clock = timer%time(since = timer%start). More...
real(RKD)	resol
	The protected scalar real of kind double precision RKD provided as a convenience for the user to contain the time in seconds between the timer clock tics. More...

Detailed Description

This is the abstract base derived type that serves as a simple container template for other timer classes in the ParaMonte library.

Timer classes derived from based on this abstract type minimally contain components to store,

1. the start time of a timer in seconds (since the processor-dependent epoch).
2. the clock in seconds (optionally computed since the start of the timer).
3. the delta elapsed time (optionally computed since the last call to the timer in seconds).
4. the resolution of the timer in seconds.

See the documentation of timer_typer for the non-default class constructor interface for this type.
See also the documentation details of pm_timer.

Possible calling interfaces ⛓

use pm_timer, only: timer_type
class(timer_type), allocatable :: timer
 
timer = timer_type()

See also

timer_type
timerDAT_type
timerMPI_type
timerOMP_type
timerSYS_type

Example usage ⛓

program example
 
    use pm_kind, only: IK, LK, SK, RKD
    use pm_io, only: display_type
    use pm_timer, only: timer_type
 
    implicit none
 
    class(timer_type), allocatable :: timer
    logical(LK) :: failed
    integer :: i
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("timer = timer_type()")
                    timer = timer_type()
    call showtimerComponents()
    call disp%skip()
 
    call disp%skip()
    call disp%show("timer%clock = timer%time()")
                    timer%clock = timer%time()
    call showtimerComponents()
    call disp%skip()
 
    call disp%skip()
    call disp%show("timer%delta = timer%time(since = timer%start)")
                    timer%delta = timer%time(since = timer%start)
    call showtimerComponents()
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("!Idle for a certain number of seconds.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("timer = timer_type()")
                    timer = timer_type()
    call disp%show("call timer%wait(seconds = 0.1_RKD)")
                    call timer%wait(seconds = 0.1_RKD)
    call disp%show("timer%delta = timer%time() - timer%start")
                    timer%delta = timer%time() - timer%start
    call showtimerComponents()
    call disp%skip()
 
contains
 
    impure subroutine showtimerComponents()
        call disp%show("timer%start")
        call disp%show( timer%start )
        call disp%show("timer%clock")
        call disp%show( timer%clock )
        call disp%show("timer%delta")
        call disp%show( timer%delta )
        call disp%show("timer%resol")
        call disp%show( timer%resol )
    end subroutine
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
timer = timer_type()
timer%start
+2447035.7986874138
timer%clock
+0.0000000000000000
timer%delta
+0.0000000000000000
timer%resol
+0.10000000000000001E-8
 
 
timer%clock = timer%time()
timer%start
+2447035.7986874138
timer%clock
+2447035.7987159160
timer%delta
+0.0000000000000000
timer%resol
+0.10000000000000001E-8
 
 
timer%delta = timer%time(since = timer%start)
timer%start
+2447035.7986874138
timer%clock
+2447035.7987159160
timer%delta
+0.39528124034404755E-4
timer%resol
+0.10000000000000001E-8
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!Idle for a certain number of seconds.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
timer = timer_type()
call timer%wait(seconds = 0.1_RKD)
timer%delta = timer%time() - timer%start
timer%start
+2447035.7987408568
timer%clock
+0.0000000000000000
timer%delta
+0.10002901032567024
timer%resol
+0.10000000000000001E-8
 
 

Test:

test_pm_timer

Todo:

Critical Priority: The start component of this derived type must become protected as soon as Fortran 2023 is supported by the compilers.

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.

1. 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.
   
2. 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, March 22, 2012, 2:21 PM, National Institute for Fusion Studies, The University of Texas at Austin

Definition at line 212 of file pm_timer.F90.

Member Function/Subroutine Documentation

time()

procedure(getTime_proc), deferred, nopass pm_timer::timer_type::time

See getTime_proc.

Implemented in pm_timer::timerCPU_type, pm_timer::timerDAT_type, pm_timer::timerMPI_type, pm_timer::timerOMP_type, and pm_timer::timerSYS_type.

Definition at line 222 of file pm_timer.F90.

timer_typer()

type(timerMPI_type) type(timerOMP_type) type(timerSYS_type) function pm_timer::timer_type::timer_typer

This is the constructor of the timer_type class.

Upon return, the constructor initializes all components of the timer object.
See also the documentation details of pm_timer.

Returns

timer : The output scalar object of class timer_type.
Specifically, the output of type,

1. timerMPI_type if the ParaMonte library is built with preprocessor macro MPI_ENABLED defined.
2. timerOMP_type if the ParaMonte library is built with preprocessor macro OMP_ENABLED defined.
3. timerSYS_type if the ParaMonte library is built is serial mode.

Possible calling interfaces ⛓

use pm_timer, only: timer_type
class(timer_type), allocatable :: timer
 
timer = timer_type()

Remarks

See the documentation of timer_type for example usage.

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.

1. 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.
   
2. 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, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas at Austin

Definition at line 556 of file pm_timer.F90.

wait()

procedure(setIdle_proc), deferred, nopass pm_timer::timer_type::wait

See setIdle_proc.

Implemented in pm_timer::timerCPU_type, pm_timer::timerDAT_type, pm_timer::timerMPI_type, pm_timer::timerOMP_type, and pm_timer::timerSYS_type.

Definition at line 223 of file pm_timer.F90.

Member Data Documentation

clock

real(RKD) pm_timer::timer_type::clock

The scalar real of kind double precision RKD provided as a convenience for the user to contain the total time in seconds elapsed since the start of the timer.
The clock time can be readily can be computed as timer%clock = timer%time(since = timer%start).

Definition at line 215 of file pm_timer.F90.

delta

real(RKD) pm_timer::timer_type::delta

The scalar real of kind double precision RKD provided as a convenience for the user to contain the delta time in seconds since the last timing (last timer call).
The delta time can be readily can be computed as timer%delta = timer%time(since = timer%start) - timer%clock where timer%clock is the last clock read as timer%clock = timer%time(since = timer%start).

Definition at line 217 of file pm_timer.F90.

resol

real(RKD) pm_timer::timer_type::resol

The protected scalar real of kind double precision RKD provided as a convenience for the user to contain the time in seconds between the timer clock tics.

Warning

The object of class timer_type must be initialized with the constructor (e.g., timer = timer_type()) to appropriately set the object resol component to the clock time resolution.

Definition at line 219 of file pm_timer.F90.

start

real(RKD) pm_timer::timer_type::start

The protected scalar real of kind double precision RKD provided as a convenience for the user to contain the start time of the timer since the processor epoch (a processor-dependent past time) in seconds.

Warning

The object of class timer_type must be initialized with the constructor (e.g., timer = timer_type()) to appropriately set the object start component to the processor epoch.

Definition at line 213 of file pm_timer.F90.

---

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

• src/fortran/main/pm_timer.F90