Public Member Functions | Private Attributes | Static Private Attributes | List of all members
Eigen::MaxSizeVector< T > Class Template Reference

The MaxSizeVector class. More...

#include <MaxSizeVector.h>

Public Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MaxSizeVector (size_t n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MaxSizeVector (size_t n, const T &init)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ~MaxSizeVector ()
 
void resize (size_t n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void push_back (const T &t)
 
template<class X >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void emplace_back (const X &x)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const T & operator[] (size_t i) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE T & operator[] (size_t i)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE T & back ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const T & back () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void pop_back ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE size_t size () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE bool empty () const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE T * data ()
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const T * data () const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE T * begin ()
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE T * end ()
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const T * begin () const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const T * end () const
 

Private Attributes

size_t reserve_
 
size_t size_
 
T * data_
 

Static Private Attributes

static const size_t alignment = internal::plain_enum_max(EIGEN_ALIGNOF(T), sizeof(void*))
 

Detailed Description

template<typename T>
class Eigen::MaxSizeVector< T >

The MaxSizeVector class.

The MaxSizeVector provides a subset of std::vector functionality.

The goal is to provide basic std::vector operations when using std::vector is not an option (e.g. on GPU or when compiling using FMA/AVX, as this can cause either compilation failures or illegal instruction failures).

Beware: The constructors are not API compatible with these of std::vector.

Constructor & Destructor Documentation

◆ MaxSizeVector() [1/2]

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::MaxSizeVector< T >::MaxSizeVector ( size_t  n)
inlineexplicit
37  : reserve_(n), size_(0), data_(static_cast<T*>(internal::handmade_aligned_malloc(n * sizeof(T), alignment))) {}
n
const unsigned n
Definition: CG3DPackingUnitTest.cpp:11
Eigen::MaxSizeVector::alignment
static const size_t alignment
Definition: MaxSizeVector.h:32
Eigen::MaxSizeVector::size_
size_t size_
Definition: MaxSizeVector.h:133
Eigen::MaxSizeVector::reserve_
size_t reserve_
Definition: MaxSizeVector.h:132
Eigen::MaxSizeVector::data_
T * data_
Definition: MaxSizeVector.h:134
Eigen::internal::handmade_aligned_malloc
EIGEN_DEVICE_FUNC void * handmade_aligned_malloc(std::size_t size, std::size_t alignment=EIGEN_DEFAULT_ALIGN_BYTES)
Definition: Memory.h:142

◆ MaxSizeVector() [2/2]

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::MaxSizeVector< T >::MaxSizeVector ( size_t  n,
const T &  init 
)
inline
42  : reserve_(n), size_(n), data_(static_cast<T*>(internal::handmade_aligned_malloc(n * sizeof(T), alignment))) {
43  size_t i = 0;
44  EIGEN_TRY {
45  for (; i < size_; ++i) {
46  new (&data_[i]) T(init);
47  }
48  }
49  EIGEN_CATCH(...) {
50  // Construction failed, destruct in reverse order:
51  for (; (i + 1) > 0; --i) {
52  data_[i - 1].~T();
53  }
54  internal::handmade_aligned_free(data_);
55  EIGEN_THROW;
56  }
57  }
i
int i
Definition: BiCGSTAB_step_by_step.cpp:9
T
Eigen::Triplet< double > T
Definition: EigenUnitTest.cpp:11
EIGEN_CATCH
#define EIGEN_CATCH(X)
Definition: Macros.h:1264
EIGEN_THROW
#define EIGEN_THROW
Definition: Macros.h:1261
EIGEN_TRY
#define EIGEN_TRY
Definition: Macros.h:1263
Eigen::internal::handmade_aligned_free
EIGEN_DEVICE_FUNC void handmade_aligned_free(void *ptr)
Definition: Memory.h:158
init
Definition: TutorialInplaceLU.cpp:2

References Eigen::MaxSizeVector< T >::data_, EIGEN_CATCH, EIGEN_THROW, EIGEN_TRY, Eigen::internal::handmade_aligned_free(), i, and Eigen::MaxSizeVector< T >::size_.

◆ ~MaxSizeVector()

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::MaxSizeVector< T >::~MaxSizeVector ( )
inline
59  {
60  for (size_t i = size_; i > 0; --i) {
61  data_[i - 1].~T();
62  }
63  internal::handmade_aligned_free(data_);
64  }

References Eigen::MaxSizeVector< T >::data_, Eigen::internal::handmade_aligned_free(), i, and Eigen::MaxSizeVector< T >::size_.

Member Function Documentation

◆ back() [1/2]

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE T& Eigen::MaxSizeVector< T >::back ( )
inline
100  {
101  eigen_assert(size_ > 0);
102  return data_[size_ - 1];
103  }
eigen_assert
#define eigen_assert(x)
Definition: Macros.h:910

References Eigen::MaxSizeVector< T >::data_, eigen_assert, and Eigen::MaxSizeVector< T >::size_.

◆ back() [2/2]

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const T& Eigen::MaxSizeVector< T >::back ( ) const
inline
105  {
106  eigen_assert(size_ > 0);
107  return data_[size_ - 1];
108  }

References Eigen::MaxSizeVector< T >::data_, eigen_assert, and Eigen::MaxSizeVector< T >::size_.

◆ begin() [1/2]

template<typename T >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE T* Eigen::MaxSizeVector< T >::begin ( )
inlineconstexpr
123 { return data_; }

References Eigen::MaxSizeVector< T >::data_.

◆ begin() [2/2]

template<typename T >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const T* Eigen::MaxSizeVector< T >::begin ( ) const
inlineconstexpr
127 { return data_; }

References Eigen::MaxSizeVector< T >::data_.

◆ data() [1/2]

template<typename T >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE T* Eigen::MaxSizeVector< T >::data ( )
inlineconstexpr
119 { return data_; }

References Eigen::MaxSizeVector< T >::data_.

Referenced by gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenQuaternionPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), gdb.printers.EigenSparseMatrixPrinter::to_string(), and gdb.printers.EigenQuaternionPrinter::to_string().

◆ data() [2/2]

template<typename T >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const T* Eigen::MaxSizeVector< T >::data ( ) const
inlineconstexpr
121 { return data_; }

References Eigen::MaxSizeVector< T >::data_.

Referenced by gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenQuaternionPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), gdb.printers.EigenSparseMatrixPrinter::to_string(), and gdb.printers.EigenQuaternionPrinter::to_string().

◆ emplace_back()

template<typename T >
template<class X >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::MaxSizeVector< T >::emplace_back ( const X &  x)
inline
85  {
86  eigen_assert(size_ < reserve_);
87  new (&data_[size_++]) T(x);
88  }
plotDoE.x
list x
Definition: plotDoE.py:28

References Eigen::MaxSizeVector< T >::data_, eigen_assert, Eigen::MaxSizeVector< T >::reserve_, Eigen::MaxSizeVector< T >::size_, and plotDoE::x.

◆ empty()

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE bool Eigen::MaxSizeVector< T >::empty ( ) const
inline
117 { return size_ == 0; }

References Eigen::MaxSizeVector< T >::size_.

◆ end() [1/2]

template<typename T >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE T* Eigen::MaxSizeVector< T >::end ( )
inlineconstexpr
125 { return data_ + size_; }

References Eigen::MaxSizeVector< T >::data_, and Eigen::MaxSizeVector< T >::size_.

◆ end() [2/2]

template<typename T >
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const T* Eigen::MaxSizeVector< T >::end ( ) const
inlineconstexpr
129 { return data_ + size_; }

References Eigen::MaxSizeVector< T >::data_, and Eigen::MaxSizeVector< T >::size_.

◆ operator[]() [1/2]

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE T& Eigen::MaxSizeVector< T >::operator[] ( size_t  i)
inline
95  {
96  eigen_assert(i < size_);
97  return data_[i];
98  }

References Eigen::MaxSizeVector< T >::data_, eigen_assert, i, and Eigen::MaxSizeVector< T >::size_.

◆ operator[]() [2/2]

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const T& Eigen::MaxSizeVector< T >::operator[] ( size_t  i) const
inline
90  {
91  eigen_assert(i < size_);
92  return data_[i];
93  }

References Eigen::MaxSizeVector< T >::data_, eigen_assert, i, and Eigen::MaxSizeVector< T >::size_.

◆ pop_back()

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::MaxSizeVector< T >::pop_back ( )
inline
110  {
111  eigen_assert(size_ > 0);
112  data_[--size_].~T();
113  }

References Eigen::MaxSizeVector< T >::data_, eigen_assert, and Eigen::MaxSizeVector< T >::size_.

◆ push_back()

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::MaxSizeVector< T >::push_back ( const T &  t)
inline
78  {
79  eigen_assert(size_ < reserve_);
80  new (&data_[size_++]) T(t);
81  }
plotPSD.t
t
Definition: plotPSD.py:36

References Eigen::MaxSizeVector< T >::data_, eigen_assert, Eigen::MaxSizeVector< T >::reserve_, Eigen::MaxSizeVector< T >::size_, and plotPSD::t.

Referenced by Eigen::ThreadPoolTempl< Environment >::ComputeCoprimes().

◆ resize()

template<typename T >
void Eigen::MaxSizeVector< T >::resize ( size_t  n)
inline
66  {
67  eigen_assert(n <= reserve_);
68  for (; size_ < n; ++size_) {
69  new (&data_[size_]) T;
70  }
71  for (; size_ > n; --size_) {
72  data_[size_ - 1].~T();
73  }
74  eigen_assert(size_ == n);
75  }

References Eigen::MaxSizeVector< T >::data_, eigen_assert, n, Eigen::MaxSizeVector< T >::reserve_, and Eigen::MaxSizeVector< T >::size_.

Referenced by test_basic_eventcount(), and test_stress_eventcount().

◆ size()

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE size_t Eigen::MaxSizeVector< T >::size ( ) const
inline
115 { return size_; }

References Eigen::MaxSizeVector< T >::size_.

Referenced by Eigen::EventCount::EventCount().

Member Data Documentation

◆ alignment

template<typename T >
const size_t Eigen::MaxSizeVector< T >::alignment = internal::plain_enum_max(EIGEN_ALIGNOF(T), sizeof(void*))
staticprivate

◆ data_

template<typename T >
T* Eigen::MaxSizeVector< T >::data_
private

Referenced by Eigen::MaxSizeVector< T >::back(), Eigen::MaxSizeVector< T >::begin(), Eigen::MaxSizeVector< T >::data(), Eigen::MaxSizeVector< T >::emplace_back(), Eigen::MaxSizeVector< T >::end(), Eigen::MaxSizeVector< T >::MaxSizeVector(), Eigen::MaxSizeVector< T >::operator[](), Eigen::MaxSizeVector< T >::pop_back(), Eigen::MaxSizeVector< T >::push_back(), Eigen::MaxSizeVector< T >::resize(), and Eigen::MaxSizeVector< T >::~MaxSizeVector().

◆ reserve_

template<typename T >
size_t Eigen::MaxSizeVector< T >::reserve_
private

Referenced by Eigen::MaxSizeVector< T >::emplace_back(), Eigen::MaxSizeVector< T >::push_back(), and Eigen::MaxSizeVector< T >::resize().

◆ size_

template<typename T >
size_t Eigen::MaxSizeVector< T >::size_
private

Referenced by Eigen::MaxSizeVector< T >::back(), Eigen::MaxSizeVector< T >::emplace_back(), Eigen::MaxSizeVector< T >::empty(), Eigen::MaxSizeVector< T >::end(), Eigen::MaxSizeVector< T >::MaxSizeVector(), Eigen::MaxSizeVector< T >::operator[](), Eigen::MaxSizeVector< T >::pop_back(), Eigen::MaxSizeVector< T >::push_back(), Eigen::MaxSizeVector< T >::resize(), Eigen::MaxSizeVector< T >::size(), and Eigen::MaxSizeVector< T >::~MaxSizeVector().

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