mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-01-24 14:45:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

improved a bit the list of API changes

Browse Source
This commit is contained in:
Gael Guennebaud 2010-01-06 17:35:22 +01:00
parent 7d3fe69eff
commit 2fbe8da7a1
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/A05_PortingFrom2To3.dox
View File

@ -6,30 +6,38 @@ The goals of this page is to enumerate the API changes between Eigen2 and Eigen3
and to help porting an application from Eigen2 to Eigen3. and to help porting an application from Eigen2 to Eigen3.
\b Table \b of \b contents \b Table \b of \b contents
- \ref summary - \ref CompatibilitySupport
- \ref modules - \ref ChangeList
- \ref core - \ref CoefficientWiseOperations
- \ref LazyVsNoalias
\section CompatibilitySupport Eigen2 compatibility support \section CompatibilitySupport Eigen2 compatibility support
In order to ease th switch from Eigen2 to Eigen3, Eigen3 features a compatibility mode which can be enabled by defining the EIGEN2_SUPPORT preprocessor token \b before including any Eigen's header (typically it should be set in your project options). In order to ease th switch from Eigen2 to Eigen3, Eigen3 features a compatibility mode which can be enabled by defining the EIGEN2_SUPPORT preprocessor token \b before including any Eigen's header (typically it should be set in your project options).
\section ChangeList List of changes \section ChangeList List of changes in the API
<table> <table>
<tr><td>Eigen 2</td><td>Eigen 3</td></tr> <tr><td>Eigen 2</td><td>Eigen 3</td><td>Comments</td></tr>
<tr><td>vec.start(length)</td><td>vec.head(length)</td></tr> <tr><td>\code
<tr><td>vec.start<length>()</td><td>vec.head<length>()</td></tr> vec.start(length)
<tr><td>vec.end(length)</td><td>vec.tail(length)</td></tr> vec.start<length>()
<tr><td>vec.end<length>()</td><td>vec.tail<length>()</td></tr> vec.end(length)
<tr></tr> vec.end<length>()
<tr><td>mat.cwise().XXX()</td><td>mat.array().XXX() \redstar</td></tr> \endcode</td><td>\code
<tr></tr> vec.head(length)
<tr><td>\code c = (a * b).lazy();\endcode</td><td>\code c.noalias() = a * b;\endcode</td></tr> vec.head<length>()
vec.tail(length)
vec.tail<length>()
\endcode</td><td>This is a simple search and replace change.</td></tr>
<tr><td colspan="3"></td></tr>
<tr><td>\code mat.cwise().XXX()\endcode</td><td>\code mat.array().XXX()\endcode</td><td>See \ref CoefficientWiseOperations. </td></tr>
<tr><td colspan="3"></td></tr>
<tr><td>\code c = (a * b).lazy();\endcode</td><td>\code c.noalias() = a * b;\endcode</td><td>See \ref LazyVsNoalias. </td></tr>
<tr><td colspan="3"></td></tr>
<tr><td>\code A.triangularSolveInPlace<XXX>(X);\endcode</td><td>\code A.triangularView<XXX>().solveInPlace(X);\endcode</td><td></td></tr>
</table> </table>
\redstar See \ref CoefficientWiseOperations for details.
\section CoefficientWiseOperations Coefficient wise operations \section CoefficientWiseOperations Coefficient wise operations
In Eigen2, coefficient wise operations which have no proper mathematical definiton (as a coeff wise product) In Eigen2, coefficient wise operations which have no proper mathematical definiton (as a coeff wise product)