diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2017-09-20 10:22:00 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2017-09-20 10:22:00 +0200 |
| commit | 7ad07fc6f2e1dd74554ba576367883c4236c6b98 (patch) | |
| tree | 812fea354161ab4bdb531273f71220f087e7b8f1 /Eigen/src/Core/util/Memory.h | |
| parent | 23f8b00bc884fe94e94ea273538e5546a4160e4f (diff) | |
Update documentation for aligned_allocator
Diffstat (limited to 'Eigen/src/Core/util/Memory.h')
| -rw-r--r-- | Eigen/src/Core/util/Memory.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Eigen/src/Core/util/Memory.h b/Eigen/src/Core/util/Memory.h index 7d9053496..f48d115f4 100644 --- a/Eigen/src/Core/util/Memory.h +++ b/Eigen/src/Core/util/Memory.h @@ -696,7 +696,15 @@ template<typename T> void swap(scoped_array<T> &a,scoped_array<T> &b) /** \class aligned_allocator * \ingroup Core_Module * -* \brief STL compatible allocator to use with with 16 byte aligned types +* \brief STL compatible allocator to use with types requiring a non standrad alignment. +* +* The memory is aligned as for dynamically aligned matrix/array types such as MatrixXd. +* By default, it will thus provide at least 16 bytes alignment and more in following cases: +* - 32 bytes alignment if AVX is enabled. +* - 64 bytes alignment if AVX512 is enabled. +* +* This can be controled using the \c EIGEN_MAX_ALIGN_BYTES macro as documented +* \link TopicPreprocessorDirectivesPerformance there \endlink. * * Example: * \code |