fix Matrix::Map/MapAligned documentation, and rephrase the tutorial on Map

This commit is contained in:
Benoit Jacob
2009-10-31 14:45:50 -04:00
parent c64ca6870e
commit e158cdd61d
2 changed files with 19 additions and 11 deletions

View File

@@ -402,9 +402,10 @@ class Matrix
void swap(const MatrixBase<OtherDerived>& other);
/** \name Map
* These are convenience functions returning Map objects. The Map() static functions return unaligned Map objects,
* while the AlignedMap() functions return aligned Map objects and thus should be called only with 16-byte-aligned
* \a data pointers.
* These are convenience functions returning Map objects.
*
* \warning Do not use MapAligned in the Eigen 2.0. Mapping aligned arrays will be fully
* supported in Eigen 3.0 (already implemented in the development branch)
*
* \see class Map
*/