lines 6-77 of file: python/cmpad/csv_speed.py

{xrst_begin py_csv_speed}

Record a Python Speed Result in a Csv File
##########################################

Prototype
*********
{xrst_literal
   # BEGIN DEF
   # END DEF
}

file_name
*********
This is the name of the file were the results will be recorded.
This file uses the :ref:`csv_column-name` format.

#. If the file is empty on input, the following csv header line
   is written as the first line of the file; i.e.,
   {xrst_literal
      xrst/csv_column.xrst
      BEGIN HEADER_LINE
      END HEADER_LINE
   }

#. A line is added to this file corresponding to
   this call to csv_speed.

rate
****
see :ref:`csv_column@rate`

min_time
********
see :ref:`csv_column@min_time`

package
*******
see :ref:`csv_column@package`

algorithm
*********
see :ref:`csv_column@algorithm`

special
*******
see :ref:`csv_column@special`

option
******

n_arg
=====
see :ref:`csv_column@n_arg`

n_other
=======
see :ref:`csv_column@n_other`

time_setup
==========
see :ref:`csv_column@time_setup`


{xrst_toc_hidden
   python/xam/csv_speed.py
}
Example
*******
:ref:`xam_csv_speed.py-name` contains an example and test of this routine.

{xrst_end py_csv_speed}