STL compatible allocator to use with types requiring a non standrad alignment. More...
#include <Memory.h>
Inheritance diagram for Eigen::aligned_allocator< T >:
Classes | |
| struct | rebind |
Public Types | |
| typedef std::ptrdiff_t | difference_type |
| typedef T * | pointer |
| typedef T & | reference |
| typedef std::size_t | size_type |
| typedef T | value_type |
Public Member Functions | |
| aligned_allocator () | |
| aligned_allocator (const aligned_allocator &other) | |
| template<class U > | |
| aligned_allocator (const aligned_allocator< U > &other) | |
| pointer | allocate (size_type num, const void *=0) |
| void | deallocate (pointer p, size_type) |
| ~aligned_allocator () | |
Public Attributes | |
| const typedef T * | const_pointer |
| const typedef T & | const_reference |
Detailed Description
template<class T>
class Eigen::aligned_allocator< T >
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 controlled using the EIGEN_MAX_ALIGN_BYTES macro as documented there .
Example:
// Matrix4f requires 16 bytes alignment:
std::map< int, Matrix4f, std::less<int>,
aligned_allocator<std::pair<const int, Matrix4f> > > my_map_mat4;
// Vector3f does not require 16 bytes alignment, no need to use Eigen's allocator:
std::map< int, Vector3f > my_map_vec3;
- See also
- \blank TopicStlContainers.
Member Typedef Documentation
◆ difference_type
template<class T >
| typedef std::ptrdiff_t Eigen::aligned_allocator< T >::difference_type |
◆ pointer
template<class T >
| typedef T* Eigen::aligned_allocator< T >::pointer |
◆ reference
template<class T >
| typedef T& Eigen::aligned_allocator< T >::reference |
◆ size_type
template<class T >
| typedef std::size_t Eigen::aligned_allocator< T >::size_type |
◆ value_type
template<class T >
| typedef T Eigen::aligned_allocator< T >::value_type |
Constructor & Destructor Documentation
◆ aligned_allocator() [1/3]
template<class T >
|
inline |
◆ aligned_allocator() [2/3]
template<class T >
|
inline |
◆ aligned_allocator() [3/3]
template<class T >
template<class U >
|
inline |
◆ ~aligned_allocator()
template<class T >
|
inline |
Member Function Documentation
◆ allocate()
template<class T >
|
inline |
◆ deallocate()
template<class T >
|
inline |
Member Data Documentation
◆ const_pointer
template<class T >
| const typedef T* Eigen::aligned_allocator< T >::const_pointer |
◆ const_reference
template<class T >
| const typedef T& Eigen::aligned_allocator< T >::const_reference |
The documentation for this class was generated from the following file: