Open3D (C++ API)  0.17.0+b7f9f3a
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Static Protected Attributes | Friends
open3d::core::SmallVectorTemplateBase< T, bool > Class Template Reference

#include <SmallVector.h>

Inheritance diagram for open3d::core::SmallVectorTemplateBase< T, bool >:
open3d::core::SmallVectorTemplateCommon< T, typename > open3d::core::SmallVectorBase< SmallVectorSizeType< T > > open3d::core::SmallVectorImpl< T > open3d::core::SmallVector< int64_t, 4 > open3d::core::SmallVector< utility::optional< int64_t >, 4 > open3d::core::SmallVector< T, N > open3d::core::SizeVector open3d::core::DynamicSizeVector

Public Member Functions

void push_back (const T &Elt)
 
void push_back (T &&Elt)
 
void pop_back ()
 
- Public Member Functions inherited from open3d::core::SmallVectorTemplateCommon< T, typename >
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
size_type size_in_bytes () const
 
size_type max_size () const
 
size_t capacity_in_bytes () const
 
pointer data ()
 Return a pointer to the vector's buffer, even if empty(). More...
 
const_pointer data () const
 Return a pointer to the vector's buffer, even if empty(). More...
 
reference operator[] (size_type idx)
 
const_reference operator[] (size_type idx) const
 
reference front ()
 
const_reference front () const
 
reference back ()
 
const_reference back () const
 
- Public Member Functions inherited from open3d::core::SmallVectorBase< SmallVectorSizeType< T > >
size_t size () const
 
size_t capacity () const
 
LLVM_NODISCARD bool empty () const
 

Protected Types

using ValueParamT = const T &
 

Protected Member Functions

 SmallVectorTemplateBase (size_t Size)
 
void grow (size_t MinSize=0)
 
T * mallocForGrow (size_t MinSize, size_t &NewCapacity)
 
void moveElementsForGrow (T *NewElts)
 
void takeAllocationForGrow (T *NewElts, size_t NewCapacity)
 Transfer ownership of the allocation, finishing up grow(). More...
 
const T * reserveForParamAndGetAddress (const T &Elt, size_t N=1)
 
T * reserveForParamAndGetAddress (T &Elt, size_t N=1)
 
void growAndAssign (size_t NumElts, const T &Elt)
 
template<typename... ArgTypes>
T & growAndEmplaceBack (ArgTypes &&... Args)
 
- Protected Member Functions inherited from open3d::core::SmallVectorTemplateCommon< T, typename >
 SmallVectorTemplateCommon (size_t Size)
 
void grow_pod (size_t MinSize, size_t TSize)
 
bool isSmall () const
 
void resetToSmall ()
 Put this vector in a state of being small. More...
 
bool isReferenceToRange (const void *V, const void *First, const void *Last) const
 Return true if V is an internal reference to the given range. More...
 
bool isReferenceToStorage (const void *V) const
 Return true if V is an internal reference to this vector. More...
 
bool isRangeInStorage (const void *First, const void *Last) const
 
bool isSafeToReferenceAfterResize (const void *Elt, size_t NewSize)
 
void assertSafeToReferenceAfterResize (const void *Elt, size_t NewSize)
 Check whether Elt will be invalidated by resizing the vector to NewSize. More...
 
void assertSafeToAdd (const void *Elt, size_t N=1)
 
void assertSafeToReferenceAfterClear (const T *From, const T *To)
 Check whether any part of the range will be invalidated by clearing. More...
 
template<class ItTy , std::enable_if_t< !std::is_same< std::remove_const_t< ItTy >, T * >::value, bool > = false>
void assertSafeToReferenceAfterClear (ItTy, ItTy)
 
void assertSafeToAddRange (const T *From, const T *To)
 Check whether any part of the range will be invalidated by growing. More...
 
template<class ItTy , std::enable_if_t< !std::is_same< std::remove_const_t< ItTy >, T * >::value, bool > = false>
void assertSafeToAddRange (ItTy, ItTy)
 
- Protected Member Functions inherited from open3d::core::SmallVectorBase< SmallVectorSizeType< T > >
 SmallVectorBase ()=delete
 
 SmallVectorBase (void *FirstEl, size_t TotalCapacity)
 
void * mallocForGrow (size_t MinSize, size_t TSize, size_t &NewCapacity)
 
void grow_pod (void *FirstEl, size_t MinSize, size_t TSize)
 
void set_size (size_t N)
 

Static Protected Member Functions

static void destroy_range (T *S, T *E)
 
template<typename It1 , typename It2 >
static void uninitialized_move (It1 I, It1 E, It2 Dest)
 
template<typename It1 , typename It2 >
static void uninitialized_copy (It1 I, It1 E, It2 Dest)
 
static T && forward_value_param (T &&V)
 
static const T & forward_value_param (const T &V)
 
- Static Protected Member Functions inherited from open3d::core::SmallVectorTemplateCommon< T, typename >
template<class U >
static const T * reserveForParamAndGetAddressImpl (U *This, const T &Elt, size_t N)
 
- Static Protected Member Functions inherited from open3d::core::SmallVectorBase< SmallVectorSizeType< T > >
static constexpr size_t SizeTypeMax ()
 The maximum value of the Size_T used. More...
 

Static Protected Attributes

static constexpr bool TakesParamByValue = false
 

Friends

class SmallVectorTemplateCommon< T >
 

Additional Inherited Members

- Public Types inherited from open3d::core::SmallVectorTemplateCommon< T, typename >
using size_type = size_t
 
using difference_type = ptrdiff_t
 
using value_type = T
 
using iterator = T *
 
using const_iterator = const T *
 
using const_reverse_iterator = std::reverse_iterator< const_iterator >
 
using reverse_iterator = std::reverse_iterator< iterator >
 
using reference = T &
 
using const_reference = const T &
 
using pointer = T *
 
using const_pointer = const T *
 
- Protected Attributes inherited from open3d::core::SmallVectorBase< SmallVectorSizeType< T > >
void * BeginX
 
SmallVectorSizeType< T > Size
 
SmallVectorSizeType< T > Capacity
 

Detailed Description

template<typename T, bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
class open3d::core::SmallVectorTemplateBase< T, bool >

SmallVectorTemplateBase<TriviallyCopyable = false> - This is where we put method implementations that are designed to work with non-trivial T's.

We approximate is_trivially_copyable with trivial move/copy construction and trivial destruction. While the standard doesn't specify that you're allowed copy these types with memcpy, there is no way for the type to observe this. This catches the important case of std::pair<POD, POD>, which is not trivially assignable.

Member Typedef Documentation

◆ ValueParamT

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
using open3d::core::SmallVectorTemplateBase< T, bool >::ValueParamT = const T &
protected

Constructor & Destructor Documentation

◆ SmallVectorTemplateBase()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
open3d::core::SmallVectorTemplateBase< T, bool >::SmallVectorTemplateBase ( size_t  Size)
inlineprotected

Member Function Documentation

◆ destroy_range()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
static void open3d::core::SmallVectorTemplateBase< T, bool >::destroy_range ( T *  S,
T *  E 
)
inlinestaticprotected

◆ forward_value_param() [1/2]

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
static const T& open3d::core::SmallVectorTemplateBase< T, bool >::forward_value_param ( const T &  V)
inlinestaticprotected

◆ forward_value_param() [2/2]

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
static T&& open3d::core::SmallVectorTemplateBase< T, bool >::forward_value_param ( T &&  V)
inlinestaticprotected

◆ grow()

template<typename T , bool TriviallyCopyable>
void open3d::core::SmallVectorTemplateBase< T, TriviallyCopyable >::grow ( size_t  MinSize = 0)
protected

Grow the allocated memory (without initializing new elements), doubling the size of the allocated memory. Guarantees space for at least one more element, or MinSize more elements if specified.

◆ growAndAssign()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void open3d::core::SmallVectorTemplateBase< T, bool >::growAndAssign ( size_t  NumElts,
const T &  Elt 
)
inlineprotected

◆ growAndEmplaceBack()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
template<typename... ArgTypes>
T& open3d::core::SmallVectorTemplateBase< T, bool >::growAndEmplaceBack ( ArgTypes &&...  Args)
inlineprotected

◆ mallocForGrow()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
T* open3d::core::SmallVectorTemplateBase< T, bool >::mallocForGrow ( size_t  MinSize,
size_t &  NewCapacity 
)
inlineprotected

Create a new allocation big enough for MinSize and pass back its size in NewCapacity. This is the first section of grow().

◆ moveElementsForGrow()

template<typename T , bool TriviallyCopyable>
void open3d::core::SmallVectorTemplateBase< T, TriviallyCopyable >::moveElementsForGrow ( T *  NewElts)
protected

Move existing elements over to the new allocation NewElts, the middle section of grow().

◆ pop_back()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void open3d::core::SmallVectorTemplateBase< T, bool >::pop_back ( )
inline

◆ push_back() [1/2]

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void open3d::core::SmallVectorTemplateBase< T, bool >::push_back ( const T &  Elt)
inline

◆ push_back() [2/2]

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
void open3d::core::SmallVectorTemplateBase< T, bool >::push_back ( T &&  Elt)
inline

◆ reserveForParamAndGetAddress() [1/2]

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
const T* open3d::core::SmallVectorTemplateBase< T, bool >::reserveForParamAndGetAddress ( const T &  Elt,
size_t  N = 1 
)
inlineprotected

Reserve enough space to add one element, and return the updated element pointer in case it was a reference to the storage.

◆ reserveForParamAndGetAddress() [2/2]

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
T* open3d::core::SmallVectorTemplateBase< T, bool >::reserveForParamAndGetAddress ( T &  Elt,
size_t  N = 1 
)
inlineprotected

Reserve enough space to add one element, and return the updated element pointer in case it was a reference to the storage.

◆ takeAllocationForGrow()

template<typename T , bool TriviallyCopyable>
void open3d::core::SmallVectorTemplateBase< T, TriviallyCopyable >::takeAllocationForGrow ( T *  NewElts,
size_t  NewCapacity 
)
protected

Transfer ownership of the allocation, finishing up grow().

◆ uninitialized_copy()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
template<typename It1 , typename It2 >
static void open3d::core::SmallVectorTemplateBase< T, bool >::uninitialized_copy ( It1  I,
It1  E,
It2  Dest 
)
inlinestaticprotected

Copy the range [I, E) onto the uninitialized memory starting with "Dest", constructing elements as needed.

◆ uninitialized_move()

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
template<typename It1 , typename It2 >
static void open3d::core::SmallVectorTemplateBase< T, bool >::uninitialized_move ( It1  I,
It1  E,
It2  Dest 
)
inlinestaticprotected

Move the range [I, E) into the uninitialized memory starting with "Dest", constructing elements as needed.

Friends And Related Function Documentation

◆ SmallVectorTemplateCommon< T >

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
friend class SmallVectorTemplateCommon< T >
friend

Field Documentation

◆ TakesParamByValue

template<typename T , bool = (std::is_trivially_copy_constructible<T>::value) && (std::is_trivially_move_constructible<T>::value) && std::is_trivially_destructible<T>::value>
constexpr bool open3d::core::SmallVectorTemplateBase< T, bool >::TakesParamByValue = false
staticconstexprprotected

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