option_t

View page source

The Option Type

Syntax

      # include <cmpad/option_t.hpp>

Source Code

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;
      }
   };
}

n_arg

is the dimension of the domain space for the algorithm.

n_other

is the special range index for the algorithm and must be less than its 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.