ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_bench::timing_type Type Reference

This is the base class for creating objects that hold the timing information of a benchmark and the timing statistics. More...

Public Attributes

real(RKD) overhead = 0._RKD
 The average timing overhead in units of seconds. More...
 
real(RKD) min = -huge(0._RKD)
 The minimum of the timing vector of the benchmark (in seconds). More...
 
real(RKD) max = -huge(0._RKD)
 The maximum of the timing vector of the benchmark (in seconds). More...
 
real(RKD) std = -huge(0._RKD)
 The standard deviation of the timing vector of the benchmark (in seconds). More...
 
real(RKD) mean = -huge(0._RKD)
 The mean of the timing vector of the benchmark (in seconds). More...
 
real(RKD), dimension(:), allocatable values
 The vector of timing results in units of seconds, corrected by the average overhead time. More...
 

Detailed Description

This is the base class for creating objects that hold the timing information of a benchmark and the timing statistics.

Remarks
This type should generally not be explicitly used outside the pm_bench.
It merely serves to create the timing component of the benchBase_type class below.
See also
bench_type
timer_type
timerDAT_type
timerMPI_type
timerOMP_type
timerSYS_type
Test:
test_pm_bench


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.

Author:
Amir Shahmoradi, Wednesday 4:13 AM, August 13, 2016, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 127 of file pm_bench.F90.

Member Data Documentation

◆ max

real(RKD) pm_bench::timing_type::max = -huge(0._RKD)

The maximum of the timing vector of the benchmark (in seconds).

Definition at line 131 of file pm_bench.F90.

◆ mean

real(RKD) pm_bench::timing_type::mean = -huge(0._RKD)

The mean of the timing vector of the benchmark (in seconds).

Definition at line 133 of file pm_bench.F90.

◆ min

real(RKD) pm_bench::timing_type::min = -huge(0._RKD)

The minimum of the timing vector of the benchmark (in seconds).

Definition at line 130 of file pm_bench.F90.

◆ overhead

real(RKD) pm_bench::timing_type::overhead = 0._RKD

The average timing overhead in units of seconds.

Definition at line 129 of file pm_bench.F90.

◆ std

real(RKD) pm_bench::timing_type::std = -huge(0._RKD)

The standard deviation of the timing vector of the benchmark (in seconds).

Definition at line 132 of file pm_bench.F90.

◆ values

real(RKD), dimension(:), allocatable pm_bench::timing_type::values

The vector of timing results in units of seconds, corrected by the average overhead time.

Definition at line 137 of file pm_bench.F90.


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