Syntax # include <cppad/time_test.hpp> time = time_test(test, time_min)
Purpose
The time_test function executes a timing test
and reports the amount of wall clock time for execution.
Motivation
It is important to separate small calculation units
and test them individually.
This way individual changes can be tested in the context of the
routine that they are in.
On many machines, accurate timing of a very short execution
sequences is not possible.
In addition,
there may be set up and tear down time for a test that
we do not really want included in the timing.
For this reason time_test
automatically determines how many times to
repeat the section of the test that we wish to time.
Include
The file cppad/time_test.hpp defines the
time_test function.
This file is included by cppad/cppad.hpp
and it can also be included separately with out the rest of
the CppAD routines.
test
The time_test argument
test
is a function,
or function object, that supports the syntax
test(repeat)
and its return value is void.
repeat
The
test
argument
repeat
has prototype
size_t repeat
It specifies the number of times to repeat the test.
time_min
The argument
time_min
has prototype
double time_min
It specifies the minimum amount of time in seconds
that the
test
routine should take.
The
repeat
argument to
test
is increased
until this amount of execution time (or more) is reached.
time
The return value
time
has prototype
double time
and is the number of wall clock seconds that it took
to execute
test
divided by the value used for
repeat
.
Timing
The routine elapsed_seconds
will be used to determine the
amount of time it took to execute the test.
Example
The routine time_test.cpp
is an example and test
of time_test.
Input File: cppad/time_test.hpp
