Prev

Next

Index-> contents reference index search external

Up-> CppAD AD BoolValued ParVar

CppAD-> Install Introduction AD ADFun preprocessor multi_thread utility ipopt_solve Example speed Appendix

AD-> ad_ctor ad_assign Convert ADValued BoolValued VecAD base_require

BoolValued-> Compare NearEqualExt BoolFun ParVar EqualOpSeq

ParVar-> par_var.cpp

Headings-> Syntax Purpose x b Operation Sequence Example

@(@\newcommand{\W}[1]{ \; #1 \; } \newcommand{\R}[1]{ {\rm #1} } \newcommand{\B}[1]{ {\bf #1} } \newcommand{\D}[2]{ \frac{\partial #1}{\partial #2} } \newcommand{\DD}[3]{ \frac{\partial^2 #1}{\partial #2 \partial #3} } \newcommand{\Dpow}[2]{ \frac{\partial^{#1}}{\partial {#2}^{#1}} } \newcommand{\dpow}[2]{ \frac{ {\rm d}^{#1}}{{\rm d}\, {#2}^{#1}} }@)@Is an AD Object a Parameter or Variable
Syntax
b = Parameter(x)
b = Variable(x)

Purpose
Determine if x is a parameter or variable .

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

b
The return value b has prototype
     bool b
The return value for Parameter (Variable) is true if and only if x is a parameter (variable). Note that a VecAD<Base> object is a variable if any element of the vector depends on the independent variables.

Operation Sequence
The result of this operation is not an AD of Base object. Thus it will not be recorded as part of an AD of Base operation sequence .

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

---

Input File: cppad/core/par_var.hpp