Eigen::aligned_allocator< T > Class Template Reference

STL compatible allocator to use with types requiring a non standrad alignment. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/util/Memory.h>

Inheritance diagram for Eigen::aligned_allocator< T >:

Classes
struct	rebind

Public Types
typedef std::size_t	size_type
typedef std::ptrdiff_t	difference_type
typedef T *	pointer
typedef const T *	const_pointer
typedef T &	reference
typedef const T &	const_reference
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)
	~aligned_allocator ()
pointer	allocate (size_type num, const void *=0)
void	deallocate (pointer p, size_type)

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

const_pointer

template<class T >

typedef const T* Eigen::aligned_allocator< T >::const_pointer

const_reference

template<class T >

typedef const T& Eigen::aligned_allocator< T >::const_reference

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 >

Eigen::aligned_allocator< T >::aligned_allocator ( )

inline

aligned_allocator() [2/3]

template<class T >

Eigen::aligned_allocator< T >::aligned_allocator ( const aligned_allocator< T > &  other )

inline

aligned_allocator() [3/3]

template<class T >

template<class U >

Eigen::aligned_allocator< T >::aligned_allocator ( const aligned_allocator< U > &  other )

inline

~aligned_allocator()

template<class T >

Eigen::aligned_allocator< T >::~aligned_allocator ( )

inline

Member Function Documentation

allocate()

template<class T >

pointer Eigen::aligned_allocator< T >::allocate ( size_type  num, const void *  = 0  )

inline

deallocate()

template<class T >

void Eigen::aligned_allocator< T >::deallocate ( pointer  p, size_type    )

inline

---

The documentation for this class was generated from the following file:

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/util/Memory.h