open3d::core::SmallVectorBase< Size_T > Class Template Reference

#include <SmallVector.h>

Public Member Functions
size_t	size () const
size_t	capacity () const
LLVM_NODISCARD bool	empty () const

Protected Member Functions
	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 constexpr size_t	SizeTypeMax ()
	The maximum value of the Size_T used. More...

Protected Attributes
void *	BeginX
Size_T	Size = 0
Size_T	Capacity

Detailed Description

template<class Size_T>
class open3d::core::SmallVectorBase< Size_T >

This is all the stuff common to all SmallVectors.

The template parameter specifies the type which should be used to hold the Size and Capacity of the SmallVector, so it can be adjusted. Using 32 bit size is desirable to shrink the size of the SmallVector. Using 64 bit size is desirable for cases like SmallVector<char>, where a 32 bit size would limit the vector to ~4GB. SmallVectors are used for buffering bitcode output - which can exceed 4GB.

Constructor & Destructor Documentation

SmallVectorBase() [1/2]

template<class Size_T >

open3d::core::SmallVectorBase< Size_T >::SmallVectorBase ( )

protecteddelete

SmallVectorBase() [2/2]

template<class Size_T >

open3d::core::SmallVectorBase< Size_T >::SmallVectorBase ( void *  FirstEl, size_t  TotalCapacity  )

inlineprotected

Member Function Documentation

capacity()

template<class Size_T >

size_t open3d::core::SmallVectorBase< Size_T >::capacity ( ) const

inline

empty()

template<class Size_T >

LLVM_NODISCARD bool open3d::core::SmallVectorBase< Size_T >::empty ( ) const

inline

grow_pod()

template<class Size_T >

void open3d::core::SmallVectorBase< Size_T >::grow_pod ( void *  FirstEl, size_t  MinSize, size_t  TSize  )

protected

This is an implementation of the grow() method which only works on POD-like data types and is out of line to reduce code duplication. This function will report a fatal error if it cannot increase capacity.

mallocForGrow()

template<class Size_T >

void * open3d::core::SmallVectorBase< Size_T >::mallocForGrow ( size_t  MinSize, size_t  TSize, size_t &  NewCapacity  )

protected

This is a helper for grow() that's out of line to reduce code duplication. This function will report a fatal error if it can't grow at least to MinSize.

set_size()

template<class Size_T >

void open3d::core::SmallVectorBase< Size_T >::set_size ( size_t  N )

inlineprotected

Set the array size to N, which the current array must have enough capacity for.

This does not construct or destroy any elements in the vector.

size()

template<class Size_T >

size_t open3d::core::SmallVectorBase< Size_T >::size ( ) const

inline

SizeTypeMax()

template<class Size_T >

static constexpr size_t open3d::core::SmallVectorBase< Size_T >::SizeTypeMax ( )

inlinestaticconstexprprotected

The maximum value of the Size_T used.

Field Documentation

BeginX

template<class Size_T >

void* open3d::core::SmallVectorBase< Size_T >::BeginX

protected

Capacity

template<class Size_T >

Size_T open3d::core::SmallVectorBase< Size_T >::Capacity

protected

Size

template<class Size_T >

Size_T open3d::core::SmallVectorBase< Size_T >::Size = 0

protected

---

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

• /home/runner/work/Open3D/Open3D/cpp/open3d/core/SmallVector.h (6e910d9 (Wed Dec 4 14:14:29 2024 -0800))
• /home/runner/work/Open3D/Open3D/cpp/open3d/core/SmallVector.cpp (6e910d9 (Wed Dec 4 14:14:29 2024 -0800))