Prev

Next

Index-> contents reference index search external

Up-> CppAD AD BoolValued EqualOpSeq

CppAD-> Install Introduction AD ADFun multi_thread library cppad_ipopt_nlp Example preprocessor Appendix

AD-> ad_ctor ad_assign Convert ADValued BoolValued VecAD base_require

BoolValued-> Compare NearEqualExt BoolFun ParVar EqualOpSeq

EqualOpSeq-> EqualOpSeq.cpp

Headings-> Syntax Purpose Motivation x y b Example

Check if Two Value are Identically Equal
Syntax
b = EqualOpSeq(x, y)

Purpose
Determine if two x and y are identically equal; i.e., not only is x == y true, but if they are variables , they correspond have the same operation sequence .

Motivation
Sometimes it is useful to cache information and only recalculate when a function's arguments change. In the case of AD variables, it may be important not only when the argument values are equal, but when they are related to the independent variables by the same operation sequence. After the assignment
     y = x
these two AD objects would not only have equal values, but would also correspond to the same operation sequence.

x
The argument x has prototype
     const AD<Base> &x

y
The argument y has prototype
     const AD<Base> &y

b
The result b has prototype
     bool b
The result is true if and only if one of the following cases holds:

1. Both x and y are variables and correspond to the same operation sequence.
2. Both x and y are parameters, Base is an AD type, and EqualOpSeq( Value(x) , Value(y) ) is true.
3. Both x and y are parameters, Base is not an AD type, and x == y is true.

Example
The file EqualOpSeq.cpp contains an example and test of EqualOpSeq. It returns true if it succeeds and false otherwise.

---

Input File: cppad/local/equal_op_seq.hpp