CppAD: A C++ Algorithmic Differentiation Package  20171217
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
standard_math.hpp
Go to the documentation of this file.
1 // $Id$
2 # ifndef CPPAD_CORE_STANDARD_MATH_HPP
3 # define CPPAD_CORE_STANDARD_MATH_HPP
4 
5 /* --------------------------------------------------------------------------
6 CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-16 Bradley M. Bell
7 
8 CppAD is distributed under multiple licenses. This distribution is under
9 the terms of the
10  Eclipse Public License Version 1.0.
11 
12 A copy of this license is included in the COPYING file of this distribution.
13 Please visit http://www.coin-or.org/CppAD/ for information on other licenses.
14 -------------------------------------------------------------------------- */
15 
16 /*
17 $begin unary_standard_math$$
18 $spell
19  const
20  VecAD
21  fabs
22 $$
23 
24 $section The Unary Standard Math Functions$$
25 
26 $head Syntax$$
27 $icode%y% = %fun%(%x%)%$$
28 
29 $head Purpose$$
30 Evaluates the standard math function $icode fun$$.
31 
32 $head Possible Types$$
33 
34 $subhead Base$$
35 If $icode Base$$ satisfies the
36 $cref/base type requirements/base_require/$$
37 and argument $icode x$$ has prototype
38 $codei%
39  const %Base%& %x%
40 %$$
41 then the result $icode y$$ has prototype
42 $codei%
43  %Base% %y%
44 %$$
45 
46 $subhead AD<Base>$$
47 If the argument $icode x$$ has prototype
48 $codei%
49  const AD<%Base%>& %x%
50 %$$
51 then the result $icode y$$ has prototype
52 $codei%
53  AD<%Base%> %y%
54 %$$
55 
56 $subhead VecAD<Base>$$
57 If the argument $icode x$$ has prototype
58 $codei%
59  const VecAD<%Base%>::reference& %x%
60 %$$
61 then the result $icode y$$ has prototype
62 $codei%
63  AD<%Base%> %y%
64 %$$
65 
66 $children%cppad/core/std_math_98.hpp
67  %cppad/core/abs.hpp
68  %cppad/core/acosh.hpp
69  %cppad/core/asinh.hpp
70  %cppad/core/atanh.hpp
71  %cppad/core/erf.hpp
72  %cppad/core/expm1.hpp
73  %cppad/core/log1p.hpp
74  %cppad/core/sign.hpp
75 %$$
76 
77 $head fun$$
78 The possible values for $icode fun$$ are
79 $table
80 $icode fun$$ $pre $$ $cnext Description $rnext
81 $cref abs$$ $cnext $title abs$$ $rnext
82 $cref acos$$ $cnext $title acos$$ $rnext
83 $cref acosh$$ $cnext $title acosh$$ $rnext
84 $cref asin$$ $cnext $title asin$$ $rnext
85 $cref asinh$$ $cnext $title asinh$$ $rnext
86 $cref atan$$ $cnext $title atan$$ $rnext
87 $cref atanh$$ $cnext $title atanh$$ $rnext
88 $cref cos$$ $cnext $title cos$$ $rnext
89 $cref cosh$$ $cnext $title cosh$$ $rnext
90 $cref erf$$ $cnext $title erf$$ $rnext
91 $cref exp$$ $cnext $title exp$$ $rnext
92 $cref expm1$$ $cnext $title expm1$$ $rnext
93 $cref/fabs/abs/$$ $cnext $title abs$$ $rnext
94 $cref log10$$ $cnext $title log10$$ $rnext
95 $cref log1p$$ $cnext $title log1p$$ $rnext
96 $cref log$$ $cnext $title log$$ $rnext
97 $cref sign$$ $cnext $title sign$$ $rnext
98 $cref sin$$ $cnext $title sin$$ $rnext
99 $cref sinh$$ $cnext $title sinh$$ $rnext
100 $cref sqrt$$ $cnext $title sqrt$$ $rnext
101 $cref tan$$ $cnext $title tan$$ $rnext
102 $cref tanh$$ $cnext $title tanh$$
103 $tend
104 
105 $end
106 */
107 # include <cppad/core/abs.hpp>
108 # include <cppad/core/acosh.hpp>
109 # include <cppad/core/asinh.hpp>
110 # include <cppad/core/atanh.hpp>
111 # include <cppad/core/erf.hpp>
112 # include <cppad/core/expm1.hpp>
113 # include <cppad/core/log1p.hpp>
114 # include <cppad/core/sign.hpp>
115 # include <cppad/core/sign.hpp>
116 
117 /*
118 $begin binary_math$$
119 
120 $section The Binary Math Functions$$
121 
122 $childtable%cppad/core/atan2.hpp
123  %cppad/core/pow.hpp
124  %cppad/core/azmul.hpp
125 %$$
126 
127 $end
128 */
129 # include <cppad/core/atan2.hpp>
130 # include <cppad/core/pow.hpp>
131 
132 # endif