pm_bench::setTiming Interface Reference

Time the user-specified procedure wrapper in the parent object of type bench_type and store the output benchmark timing information and statistics implicitly in the timing component of the input/output bench_type object.
More...

Detailed Description

Time the user-specified procedure wrapper in the parent object of type bench_type and store the output benchmark timing information and statistics implicitly in the timing component of the input/output bench_type object.

This procedure is a method of the class bench_type.

Parameters

[in,out]	self	: The parent object of class bench_type (passed implicitly to the method).
[in]	miniter	: The input scalar integer of default kind IK representing the minimum number of iterations (repetitions) of the timing to perform. (optional. The default is set by the constructor of the superclass benchBase_type.)
[in]	minsec	: The input scalar real of kind double precision RKD representing the minimum time in seconds to spend on timing repeatedly. (optional. The default is set by the constructor of the superclass benchBase_type.)

Possible calling interfaces ⛓

use pm_kind, only: RKD
type(bench_type) :: bench
real(RKD) :: minsec
 
bench = bench_type(name, exec, overhead = overhead, minsec = minsec, timer = timer)
call bench%setTiming(minsec = minsec, miniter = miniter)

Remarks

This subroutine method of type bench_type has the same functionality as the function interface getTiming with the only difference that the result output is implicit and potentially slightly faster.

Note

If the specified benchmark routine is to be called certain number of times, set minsec = 0. and miniter to desired number of times the routine must be timed.

See also

getTiming
bench_type

Remarks

See bench_type for example usage.

Todo:

High Priority: The computation of the median, skewness, and kurtosis of the timing vector in the stat component must be implemented.

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.

Copyright

Computational Data Science Lab

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 643 of file pm_bench.F90.

---

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

• src/fortran/main/pm_bench.F90