lines 8-76 of file: cpp/include/cmpad/fun_speed.hpp

{xrst_begin cpp_fun_speed}
{xrst_spell
   obj
}

Determine C++ Execution Speed
#############################

Syntax
******
| |tab| ``# include <cmpad/fun_speed.hpp>``
| |tab| *y* = *fun_obj* ( *x* )
| |tab| *rate* = ``cmpad::fun_speed`` ( *fun_obj*, *option*, *min_time* )

Prototype
*********
{xrst_literal
   // BEGIN PROTOTYPE
   // END PROTOTYPE
}

fun_obj
*******
We are testing the speed of the evaluation of *y* by this function object.

x
*
This is a ``cmpad::vector<double>`` object with size equal to the
dimension of the :ref:`cpp_fun_obj@domain` space for the function object.

y
*
This is a ``cmpad::vector<double>`` object with size equal to the
dimension of the :ref:`cpp_fun_obj@range` space for the function object.

option
******
This is the :ref:`option_t-name` object used to setup the function object
with the call
{xrst_code cpp}
   fun_obj.setup(option)
{xrst_code}

time_setup
==========
If option.time_setup is true (false) the setup function is (is not)
included in the time for each function evaluation.
If the setup time is not included, the only thing that changes
between function evaluations is the argument vector *x* .

min_time
********
This is the minimum time in seconds for the timing of the computation.
The computation of the function object will be repeated enough times
so that this minimum time is reached.

rate
****
This is the speed of one computation of the function object; i.e.,
the number of times per second that the function object gets computed.

{xrst_toc_hidden
   cpp/xam/fun_speed.cpp
}
Example
*******
:ref:`xam_fun_speed.cpp-name` is an example and test that uses this function.

{xrst_end cpp_fun_speed}