GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-07-24 13:54:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

clarify docs as requested on the forum

Browse Source
This commit is contained in:
Benoit Jacob 2010-01-02 12:54:55 -05:00
parent 74207a31fa
commit e4c88c14ec
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/StlContainers.dox
View File

@ -11,7 +11,7 @@ namespace Eigen {
\section summary Executive summary \section summary Executive summary
Using STL containers on \ref FixedSizeVectorizable "fixed-size vectorizable Eigen types" requires taking the following two steps: Using STL containers on \ref FixedSizeVectorizable "fixed-size vectorizable Eigen types", or classes having members of such types, requires taking the following two steps:
\li A 16-byte-aligned allocator must be used. Eigen does provide one ready for use: aligned_allocator. \li A 16-byte-aligned allocator must be used. Eigen does provide one ready for use: aligned_allocator.
\li If you want to use the std::vector container, you need to \#include <Eigen/StdVector>. \li If you want to use the std::vector container, you need to \#include <Eigen/StdVector>.

7
doc/UnalignedArrayAssert.dox
View File

@ -55,16 +55,17 @@ Note that here, Eigen::Vector2d is only used as an example, more generally the i
\section c2 Cause 2: STL Containers \section c2 Cause 2: STL Containers
If you use STL Containers such as std::vector, std::map, ..., with Eigen objects, like this, If you use STL Containers such as std::vector, std::map, ..., with Eigen objects, or with classes containing Eigen objects, like this,
\code \code
std::vector<Eigen::Matrix2f> my_vector; std::vector<Eigen::Matrix2f> my_vector;
std::map<int, Eigen::Matrix2f> my_map; struct my_class { ... Eigen::Matrix2f m; ... };
std::map<int, my_class> my_map;
\endcode \endcode
then you need to read this separate page: \ref StlContainers "Using STL Containers with Eigen". then you need to read this separate page: \ref StlContainers "Using STL Containers with Eigen".
Note that here, Eigen::Matrix2f is only used as an example, more generally the issue arises for all \ref FixedSizeVectorizable "fixed-size vectorizable Eigen types". Note that here, Eigen::Matrix2f is only used as an example, more generally the issue arises for all \ref FixedSizeVectorizable "fixed-size vectorizable Eigen types" and \ref StructHavingEigenMembers "structures having such Eigen objects as member".
\section c3 Cause 3: Passing Eigen objects by value \section c3 Cause 3: Passing Eigen objects by value