Prev

Next

Index-> contents reference index search external

Up-> CppAD library Poly

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

library-> ErrorHandler NearEqual speed_test SpeedTest time_test NumericType CheckNumericType SimpleVector CheckSimpleVector nan pow_int Poly LuDetAndSolve RombergOne RombergMul Runge45 Rosen34 OdeErrControl OdeGear OdeGearControl BenderQuad opt_val_hes LuRatio CppAD_vector thread_alloc memory_leak

Poly-> Poly.cpp poly.hpp

Headings-> Syntax Description Include k a z p Type ---..Operations Vector Operation Sequence Example Source

Evaluate a Polynomial or its Derivative
Syntax
# include <cppad/poly.hpp>
p = Poly(k, a, z)

Description
Computes the k-th derivative of the polynomial $$\mathit{P}(\mathit{z})={\mathit{a}}_0+{\mathit{a}}_1{\mathit{z}}^1+\cdots +{\mathit{a}}_{\mathit{d}}{\mathit{z}}^{\mathit{d}}$$ If k is equal to zero, the return value is $\mathit{P}(\mathit{z})$ .

Include
The file cppad/poly.hpp is included by cppad/cppad.hpp but it can also be included separately with out the rest of the CppAD routines. Including this file defines Poly within the CppAD namespace.

k
The argument k has prototype
     size_t k
It specifies the order of the derivative to calculate.

a
The argument a has prototype
     const Vector &a
(see Vector below). It specifies the vector corresponding to the polynomial $\mathit{P}(\mathit{z})$ .

z
The argument z has prototype
     const Type &z
(see Type below). It specifies the point at which to evaluate the polynomial

p
The result p has prototype
     Type p
(see Type below) and it is equal to the k-th derivative of $\mathit{P}(\mathit{z})$ ; i.e., $$\mathit{p}=\frac{\mathit{k}!}{0!}{\mathit{a}}_{\mathit{k}}+\frac{(\mathit{k}+1)!}{1!}{\mathit{a}}_{\mathit{k}+1}{\mathit{z}}^1+\dots +\frac{\mathit{d}!}{(\mathit{d}-\mathit{k})!}{\mathit{a}}_{\mathit{d}}{\mathit{z}}^{\mathit{d}-\mathit{k}}$$ If $\mathit{k}>\mathit{d}$ , p = Type(0).

Type
The type Type is determined by the argument z. It is assumed that multiplication and addition of Type objects are commutative.

Operations
The following operations must be supported where x and y are objects of type Type and i is an int:

x  = i	assignment
x  = y	assignment
x *= y	multiplication computed assignment
x += y	addition computed assignment

Vector
The type Vector must be a SimpleVector class with elements of type Type. The routine CheckSimpleVector will generate an error message if this is not the case.

Operation Sequence
The Type operation sequence used to calculate p is independent of z and the elements of a (it does depend on the size of the vector a).

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

Source
The file poly.hpp contains the current source code that implements these specifications.

---

Input File: cppad/poly.hpp