CppAD: A C++ Algorithmic Differentiation Package  20171217
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
template<class Vector_set >
void CppAD::local::sparse_conditional_exp_op ( size_t  i_z,
const addr_t *  arg,
size_t  num_par 
)
inline

Shared documentation for conditional expression sparse operations (not called).

The C++ source code coresponding to this operation is 

     z = CondExpRel(y_0, y_1, y_2, y_3)

where Rel is one of the following: Lt, Le, Eq, Ge, Gt.

Template Parameters
Vector_setis the type used for vectors of sets. It can be either sparse_pack or sparse_list.
Parameters
i_zis the AD variable index corresponding to the variable z.
arg
arg[0] is static cast to size_t from the enum type 
     enum CompareOp {
          CompareLt,
          CompareLe,
          CompareEq,
          CompareGe,
          CompareGt,
          CompareNe
     }
for this operation. Note that arg[0] cannot be equal to CompareNe.

arg[1] & 1
If this is zero, y_0 is a parameter. Otherwise it is a variable.

arg[1] & 2
If this is zero, y_1 is a parameter. Otherwise it is a variable.

arg[1] & 4
If this is zero, y_2 is a parameter. Otherwise it is a variable.

arg[1] & 8
If this is zero, y_3 is a parameter. Otherwise it is a variable.

arg[2 + j ] for j = 0, 1, 2, 3
is the index corresponding to y_j.
num_paris the total number of values in the vector parameter.
Checked Assertions
  • NumArg(CExpOp) == 6
  • NumRes(CExpOp) == 1
  • arg[0] < static_cast<size_t> ( CompareNe )
  • arg[1] != 0; i.e., not all of y_0, y_1, y_2, y_3 are parameters.
  • For j = 0, 1, 2, 3 if y_j is a parameter, arg[2+j] < num_par.

Definition at line 181 of file cond_op.hpp.