Eigen::aligned_allocator< T > Class Template Reference

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

Inherits std::allocator< T >.

Classes
struct	rebind

Public Types
typedef const T *	const_pointer
typedef const T &	const_reference
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 ()

Detailed Description

template<class T>
class Eigen::aligned_allocator< T >

STL compatible allocator to use with types requiring a non-standard 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

Using STL Containers with Eigen.

Definition at line 957 of file Memory.h.

Member Typedef Documentation

const_pointer

template<class T >

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

Definition at line 963 of file Memory.h.

const_reference

template<class T >

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

Definition at line 965 of file Memory.h.

difference_type

template<class T >

typedef std::ptrdiff_t Eigen::aligned_allocator< T >::difference_type

Definition at line 961 of file Memory.h.

pointer

template<class T >

typedef T* Eigen::aligned_allocator< T >::pointer

Definition at line 962 of file Memory.h.

reference

template<class T >

typedef T& Eigen::aligned_allocator< T >::reference

Definition at line 964 of file Memory.h.

size_type

template<class T >

typedef std::size_t Eigen::aligned_allocator< T >::size_type

Definition at line 960 of file Memory.h.

value_type

template<class T >

typedef T Eigen::aligned_allocator< T >::value_type

Definition at line 966 of file Memory.h.

Constructor & Destructor Documentation

aligned_allocator() [1/3]

template<class T >

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

inline

Definition at line 974 of file Memory.h.

: std::allocator<T>() {}

aligned_allocator() [2/3]

template<class T >

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

inline

Definition at line 976 of file Memory.h.

: std::allocator<T>(other) {}

aligned_allocator() [3/3]

template<class T >

template<class U >

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

inline

Definition at line 979 of file Memory.h.

: std::allocator<T>(other) {}

~aligned_allocator()

template<class T >

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

inline

Definition at line 981 of file Memory.h.

{}

Member Function Documentation

allocate()

template<class T >

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

inline

Definition at line 992 of file Memory.h.

  {
    internal::check_size_for_overflow<T>(num);
    return static_cast<pointer>( internal::aligned_malloc(num * sizeof(T)) );
  }

deallocate()

template<class T >

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

inline

Definition at line 998 of file Memory.h.

  {
    internal::aligned_free(p);
  }

---

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

• Memory.h