diff options
| -rw-r--r-- | doc/CoeffwiseMathFunctionsTable.dox | 157 | ||||
| -rw-r--r-- | doc/Manual.dox | 3 | ||||
| -rw-r--r-- | doc/eigendoxy.css | 26 |
3 files changed, 178 insertions, 8 deletions
diff --git a/doc/CoeffwiseMathFunctionsTable.dox b/doc/CoeffwiseMathFunctionsTable.dox new file mode 100644 index 000000000..c466c14c8 --- /dev/null +++ b/doc/CoeffwiseMathFunctionsTable.dox @@ -0,0 +1,157 @@ +namespace Eigen { + +/** \eigenManualPage CoeffwiseMathFunctions Catalog of coefficient-wise math functions + + +<span style="font-size:300%; color:red; font-weight: 900;">!WORK IN PROGRESS!</span> + +This table presents a catalog of the coefficient-wise math functions supported by %Eigen. +In this table, \c a, \c b, refer to Array objects or expressions, and \c m refers to a linear algebra Matrix/Vector object. Standard scalar types are abbreviated as follows: + - \c int: \c ui32 + - \c float: \c f + - \c double: \c d + - \c std::complex<float>: \c cf + - \c std::complex<double>: \c cd + +For each row, the first column list the equivalent calls for arrays, and matrices when supported. Of course, all functions are available for matrices by first casting it as an array: \c m.array(). + +The third column gives some hints in the underlying scalar implementation. In most cases, %Eigen does not implement itself the math function but relies on the STL for standard scalar types, or user-provided functions for custom scalar types. +For instance, some simply calls the respective function of the STL while preserving <a href="http://en.cppreference.com/w/cpp/language/adl">argument-dependent lookup</a> for custom types. +The following: +\code +using std::foo; +foo(a[i]); +\endcode +means that the STL's function \c std::foo will be potentially called if it is compatible with the underlying scalar type. If not, then the user must ensure that an overload of the function foo is available for the given scalar type (usually defined in the same namespace as the given scalar type). +This also means that, unless specified, if the function \c std::foo is available only in some recent c++ versions (e.g., c++11), then the respective %Eigen's function/method will be usable on standard types only if the compiler support the required c++ version. + +<table class="manual-hl"> +<tr> +<th>API</th><th>Description</th><th>Default scalar implementation</th><th>SIMD</th> +</tr> +<tr><td colspan="4"></td></tr> +<tr><th colspan="4">Basic operations</th></tr> +<tr> + <td class="code"> + \anchor cwisetable_abs + a.\link ArrayBase::abs abs\endlink(); \n + \link Eigen::abs abs\endlink(a); \n + m.\link MatrixBase::cwiseAbs cwiseAbs\endlink(); + </td> + <td>absolute value (\f$ |a_i| \f$) </td> + <td class="code"> + using <a href="http://en.cppreference.com/w/cpp/numeric/math/fabs">std::abs</a>; \n + abs(a[i]); + </td> + <td>SSE2, AVX (ui32,f,d)</td> +</tr> +<tr> +<th colspan="4">Exponential functions</th> +</tr> +<tr> + <td class="code"> + \anchor cwisetable_exp + a.\link ArrayBase::exp exp\endlink(); \n + \link Eigen::exp exp\endlink(a); + </td> + <td>\f$ e \f$ raised to the given power (\f$ e^{a_i} \f$) </td> + <td class="code"> + using <a href="http://en.cppreference.com/w/cpp/numeric/math/exp">std::exp</a>; \n + exp(a[i]); + </td> + <td>SSE2, AVX (f,d)</td> +</tr> +<tr> + <td class="code"> + \anchor cwisetable_log + a.\link ArrayBase::log log\endlink(); \n + \link Eigen::log log\endlink(a); + </td> + <td>natural (base \f$ e \f$) logarithm (\f$ ln({a_i}) \f$)</td> + <td class="code"> + using <a href="http://en.cppreference.com/w/cpp/numeric/math/log">std::log</a>; \n + log(a[i]); + </td> + <td>SSE2, AVX (f,d)</td> +</tr> +<tr> + <td class="code"> + \anchor cwisetable_log1p + a.\link ArrayBase::log1p log1p\endlink(); \n + \link Eigen::log1p log1p\endlink(a); + </td> + <td>natural (base \f$ e \f$) logarithm of 1 plus \n the given number (\f$ ln({1+a_i}) \f$)</td> + <td>built-in generic implementation based on \c log,\n + plus \c using <a href="http://en.cppreference.com/w/cpp/numeric/math/log1p">\c std::log1p </a>; \cpp11</td> + <td></td> +</tr> +<tr> +<th colspan="4">Power functions</th> +</tr> +<tr> +<th colspan="4">Trigonometric functions</th> +</tr> +<tr> +<th colspan="4">Hyperbolic functions</th> +</tr> +<tr> +<th colspan="4">Error and gamma functions</th> +</tr> +<tr> + <td class="code"> + \anchor cwisetable_erf + a.\link ArrayBase::erf erf\endlink(); \n + \link Eigen::erf erf\endlink(a); + </td> + <td>error function</td> + <td class="code"> + using <a href="http://en.cppreference.com/w/cpp/numeric/math/erf">std::erf</a>; \cpp11 \n + erf(a[i]); + </td> + <td></td> +</tr> +<tr> + <td class="code"> + \anchor cwisetable_erfc + a.\link ArrayBase::erfc erfc\endlink(); \n + \link Eigen::erfc erfc\endlink(a); + </td> + <td>complementary error function</td> + <td class="code"> + using <a href="http://en.cppreference.com/w/cpp/numeric/math/erfc">std::erfc</a>; \cpp11 \n + erfc(a[i]); + </td> + <td></td> +</tr> +<tr> +<th colspan="4">Nearest integer floating point operations</th> +</tr> +<tr> +<th colspan="4">Floating point manipulation functions</th> +</tr> +<tr> +<th colspan="4">Classification and comparison</th> +</tr> +<tr> +<th colspan="4">Miscellaneous</th> +</tr> +<tr> + <td class="code"> + \anchor cwisetable_zeta + a.\link ArrayBase::zeta zeta\endlink(b); \n + \link Eigen::zeta zeta\endlink(a,b); + </td> + <td><a href="https://en.wikipedia.org/wiki/Hurwitz_zeta_function">Hurwitz zeta function</a> \n \f$ \zeta(a_i,b_i)=\sum_{k=0}^{\infty}(b_i+k)^{\text{-}a_i} \f$</td> + <td> + built-in for float and double + </td> + <td></td> +</tr> +<tr><td colspan="4"></td></tr> +</table> + +\n + +*/ + +}
\ No newline at end of file diff --git a/doc/Manual.dox b/doc/Manual.dox index 70aaa9a42..8940b0070 100644 --- a/doc/Manual.dox +++ b/doc/Manual.dox @@ -90,6 +90,9 @@ namespace Eigen { /** \addtogroup Householder_Module \ingroup DenseMatrixManipulation_Reference */ +/** \addtogroup CoeffwiseMathFunctions + \ingroup DenseMatrixManipulation_chapter */ + /** \addtogroup QuickRefPage \ingroup DenseMatrixManipulation_chapter */ diff --git a/doc/eigendoxy.css b/doc/eigendoxy.css index 3dedbd1d8..6274e6c70 100644 --- a/doc/eigendoxy.css +++ b/doc/eigendoxy.css @@ -45,7 +45,7 @@ pre.fragment { /* Common style for all Eigen's tables */ -table.example, table.manual, table.manual-vl { +table.example, table.manual, table.manual-vl, table.manual-hl { max-width:100%; border-collapse: collapse; border-style: solid; @@ -58,7 +58,7 @@ table.example, table.manual, table.manual-vl { -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); } -table.example th, table.manual th, table.manual-vl th { +table.example th, table.manual th, table.manual-vl th, table.manual-hl th { padding: 0.5em 0.5em 0.5em 0.5em; text-align: left; padding-right: 1em; @@ -70,7 +70,7 @@ table.example th, table.manual th, table.manual-vl th { filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFF', endColorstr='#F4F4E5'); } -table.example td, table.manual td, table.manual-vl td { +table.example td, table.manual td, table.manual-vl td, table.manual-hl td { vertical-align:top; border-width: 1px; border-color: #cccccc; @@ -108,15 +108,15 @@ table.example td { /* standard class for the manual */ -table.manual, table.manual-vl { +table.manual, table.manual-vl, table.manual-hl { padding: 0.2em 0em 0.5em 0em; } -table.manual th, table.manual-vl th { +table.manual th, table.manual-vl th, table.manual-hl th { margin: 0em 0em 0.3em 0em; } -table.manual td, table.manual-vl td { +table.manual td, table.manual-vl td, table.manual-hl td { padding: 0.3em 0.5em 0.3em 0.5em; vertical-align:top; border-width: 1px; @@ -136,6 +136,16 @@ table.manual-vl th.inter { border-style: solid solid solid solid; } +table.manual-hl td { + border-color: #cccccc; + border-width: 1px; + border-style: solid none solid none; +} + +table td.code { + font-family: monospace; +} + h2 { margin-top:2em; border-style: none none solid none; @@ -182,8 +192,8 @@ table.tutorial_code td { /* Whenever doxygen meets a '\n' or a '<BR/>', it will put - * the text containing the characted into a <p class="starttd">. - * This little hack togehter with table.tutorial_code td.note + * the text containing the character into a <p class="starttd">. + * This little hack together with table.tutorial_code td.note * aims at fixing this issue. */ table.tutorial_code td.note p.starttd { margin: 0px; |