lines 11-59 of file: cpp/include/cmpad/option_t.hpp

{xrst_begin option_t}
{xrst_spell
   max
   std
   struct
}

The Option Type
###############

Syntax
******
| |tab| ``# include <cmpad/option_t.hpp>``

Source Code
***********
{xrst_code cpp} */
namespace cmpad {
   struct option_t {
      size_t n_arg;
      size_t n_other;
      bool   time_setup;
      option_t(void)
      {  n_arg      = std::numeric_limits<size_t>::max();
         n_other    = std::numeric_limits<size_t>::max();
         time_setup = false;
      }
   };
}
/* {xrst_code}

n_arg
*****
is the dimension of the :ref:`cpp_fun_obj@domain` space for the algorithm.

n_other
*******
is the special range index for the algorithm and must be less than its
:ref:`cpp_fun_obj@range` .
For example, if we are computing gradients or Hessians,
it is the index in the algorithm range space that the gradient or Hessian
corresponds to.

time_setup
**********
if true (false) the setup time is included (is not included) in the execution
speed timing.

{xrst_end option_t}