From ff94eaa4ae26adcf20b7e250688f1c7fd9bc2aac Mon Sep 17 00:00:00 2001 From: Benoit Jacob Date: Sat, 2 Jan 2010 12:55:32 -0500 Subject: [PATCH] clarify docs as requested on forum --- Eigen/src/Core/Coeffs.h | 1 - doc/D01_StlContainers.dox | 2 +- doc/D11_UnalignedArrayAssert.dox | 5 +++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Eigen/src/Core/Coeffs.h b/Eigen/src/Core/Coeffs.h index d2b3237c5..9a954babc 100644 --- a/Eigen/src/Core/Coeffs.h +++ b/Eigen/src/Core/Coeffs.h @@ -379,7 +379,6 @@ EIGEN_STRONG_INLINE void MatrixBase::copyPacket(int index, const Matrix other.derived().template packet(index)); } - template struct ei_first_aligned_impl { diff --git a/doc/D01_StlContainers.dox b/doc/D01_StlContainers.dox index d778e4fa0..db682c996 100644 --- a/doc/D01_StlContainers.dox +++ b/doc/D01_StlContainers.dox @@ -9,7 +9,7 @@ namespace Eigen { \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 If you want to use the std::vector container, you need to \#include . diff --git a/doc/D11_UnalignedArrayAssert.dox b/doc/D11_UnalignedArrayAssert.dox index f4da15236..e9fb2a69f 100644 --- a/doc/D11_UnalignedArrayAssert.dox +++ b/doc/D11_UnalignedArrayAssert.dox @@ -55,11 +55,12 @@ Note that here, Eigen::Vector2d is only used as an example, more generally the i \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 std::vector my_vector; -std::map my_map; +struct my_class { ... Eigen::Matrix2f m; ... }; +std::map my_map; \endcode then you need to read this separate page: \ref StlContainers "Using STL Containers with Eigen".