ESPHome 2026.1.0-dev
Loading...
Searching...
No Matches
esphome::FixedVector< T > Class Template Reference

Fixed-capacity vector - allocates once at runtime, never reallocates This avoids std::vector template overhead (_M_realloc_insert, _M_default_append) when size is known at initialization but not at compile time. More...

#include <helpers.h>

Public Member Functions

 FixedVector ()=default
 
 FixedVector (std::initializer_list< T > init_list)
 Constructor from initializer list - allocates exact size needed This enables brace initialization: FixedVector<int> v = {1, 2, 3};.
 
 ~FixedVector ()
 
 FixedVector (const FixedVector &)=delete
 
FixedVectoroperator= (const FixedVector &)=delete
 
 FixedVector (FixedVector &&other) noexcept
 
 operator std::vector< T > () const
 
FixedVectoroperator= (FixedVector &&other) noexcept
 
FixedVectoroperator= (std::initializer_list< T > init_list)
 Assignment from initializer list - avoids temporary and move overhead This enables: FixedVector<int> v; v = {1, 2, 3};.
 
void init (size_t n)
 
void clear ()
 
void shrink_to_fit ()
 
void push_back (const T &value)
 Add element without bounds checking Caller must ensure sufficient capacity was allocated via init() Silently ignores pushes beyond capacity (no exception or assertion)
 
void push_back (T &&value)
 Add element by move without bounds checking Caller must ensure sufficient capacity was allocated via init() Silently ignores pushes beyond capacity (no exception or assertion)
 
template<typename... Args>
T & emplace_back (Args &&...args)
 Emplace element without bounds checking - constructs in-place with arguments Caller must ensure sufficient capacity was allocated via init() Returns reference to the newly constructed element NOTE: Caller MUST ensure size_ < capacity_ before calling.
 
T & front ()
 Access first element (no bounds checking - matches std::vector behavior) Caller must ensure vector is not empty (size() > 0)
 
const T & front () const
 
T & back ()
 Access last element (no bounds checking - matches std::vector behavior) Caller must ensure vector is not empty (size() > 0)
 
const T & back () const
 
size_t size () const
 
bool empty () const
 
T & operator[] (size_t i)
 Access element without bounds checking (matches std::vector behavior) Caller must ensure index is valid (i < size())
 
const T & operator[] (size_t i) const
 
T & at (size_t i)
 Access element with bounds checking (matches std::vector behavior) Note: No exception thrown on out of bounds - caller must ensure index is valid.
 
const T & at (size_t i) const
 
T * begin ()
 
T * end ()
 
const T * begin () const
 
const T * end () const
 

Detailed Description

template<typename T>
class esphome::FixedVector< T >

Fixed-capacity vector - allocates once at runtime, never reallocates This avoids std::vector template overhead (_M_realloc_insert, _M_default_append) when size is known at initialization but not at compile time.

Definition at line 184 of file helpers.h.

Constructor & Destructor Documentation

◆ FixedVector() [1/4]

template<typename T >
esphome::FixedVector< T >::FixedVector ( )
default

◆ FixedVector() [2/4]

template<typename T >
esphome::FixedVector< T >::FixedVector ( std::initializer_list< T > init_list)
inline

Constructor from initializer list - allocates exact size needed This enables brace initialization: FixedVector<int> v = {1, 2, 3};.

Definition at line 232 of file helpers.h.

◆ ~FixedVector()

template<typename T >
esphome::FixedVector< T >::~FixedVector ( )
inline

Definition at line 234 of file helpers.h.

◆ FixedVector() [3/4]

template<typename T >
esphome::FixedVector< T >::FixedVector ( const FixedVector< T > & )
delete

◆ FixedVector() [4/4]

template<typename T >
esphome::FixedVector< T >::FixedVector ( FixedVector< T > && other)
inlinenoexcept

Definition at line 241 of file helpers.h.

Member Function Documentation

◆ at() [1/2]

template<typename T >
T & esphome::FixedVector< T >::at ( size_t i)
inline

Access element with bounds checking (matches std::vector behavior) Note: No exception thrown on out of bounds - caller must ensure index is valid.

Definition at line 351 of file helpers.h.

◆ at() [2/2]

template<typename T >
const T & esphome::FixedVector< T >::at ( size_t i) const
inline

Definition at line 352 of file helpers.h.

◆ back() [1/2]

template<typename T >
T & esphome::FixedVector< T >::back ( )
inline

Access last element (no bounds checking - matches std::vector behavior) Caller must ensure vector is not empty (size() > 0)

Definition at line 338 of file helpers.h.

◆ back() [2/2]

template<typename T >
const T & esphome::FixedVector< T >::back ( ) const
inline

Definition at line 339 of file helpers.h.

◆ begin() [1/2]

template<typename T >
T * esphome::FixedVector< T >::begin ( )
inline

Definition at line 355 of file helpers.h.

◆ begin() [2/2]

template<typename T >
const T * esphome::FixedVector< T >::begin ( ) const
inline

Definition at line 357 of file helpers.h.

◆ clear()

template<typename T >
void esphome::FixedVector< T >::clear ( )
inline

Definition at line 287 of file helpers.h.

◆ emplace_back()

template<typename T >
template<typename... Args>
T & esphome::FixedVector< T >::emplace_back ( Args &&... args)
inline

Emplace element without bounds checking - constructs in-place with arguments Caller must ensure sufficient capacity was allocated via init() Returns reference to the newly constructed element NOTE: Caller MUST ensure size_ < capacity_ before calling.

Definition at line 324 of file helpers.h.

◆ empty()

template<typename T >
bool esphome::FixedVector< T >::empty ( ) const
inline

Definition at line 342 of file helpers.h.

◆ end() [1/2]

template<typename T >
T * esphome::FixedVector< T >::end ( )
inline

Definition at line 356 of file helpers.h.

◆ end() [2/2]

template<typename T >
const T * esphome::FixedVector< T >::end ( ) const
inline

Definition at line 358 of file helpers.h.

◆ front() [1/2]

template<typename T >
T & esphome::FixedVector< T >::front ( )
inline

Access first element (no bounds checking - matches std::vector behavior) Caller must ensure vector is not empty (size() > 0)

Definition at line 333 of file helpers.h.

◆ front() [2/2]

template<typename T >
const T & esphome::FixedVector< T >::front ( ) const
inline

Definition at line 334 of file helpers.h.

◆ init()

template<typename T >
void esphome::FixedVector< T >::init ( size_t n)
inline

Definition at line 274 of file helpers.h.

◆ operator std::vector< T >()

template<typename T >
esphome::FixedVector< T >::operator std::vector< T > ( ) const
inline

Definition at line 246 of file helpers.h.

◆ operator=() [1/3]

template<typename T >
FixedVector & esphome::FixedVector< T >::operator= ( const FixedVector< T > & )
delete

◆ operator=() [2/3]

template<typename T >
FixedVector & esphome::FixedVector< T >::operator= ( FixedVector< T > && other)
inlinenoexcept

Definition at line 248 of file helpers.h.

◆ operator=() [3/3]

template<typename T >
FixedVector & esphome::FixedVector< T >::operator= ( std::initializer_list< T > init_list)
inline

Assignment from initializer list - avoids temporary and move overhead This enables: FixedVector<int> v; v = {1, 2, 3};.

Definition at line 264 of file helpers.h.

◆ operator[]() [1/2]

template<typename T >
T & esphome::FixedVector< T >::operator[] ( size_t i)
inline

Access element without bounds checking (matches std::vector behavior) Caller must ensure index is valid (i < size())

Definition at line 346 of file helpers.h.

◆ operator[]() [2/2]

template<typename T >
const T & esphome::FixedVector< T >::operator[] ( size_t i) const
inline

Definition at line 347 of file helpers.h.

◆ push_back() [1/2]

template<typename T >
void esphome::FixedVector< T >::push_back ( const T & value)
inline

Add element without bounds checking Caller must ensure sufficient capacity was allocated via init() Silently ignores pushes beyond capacity (no exception or assertion)

Definition at line 301 of file helpers.h.

◆ push_back() [2/2]

template<typename T >
void esphome::FixedVector< T >::push_back ( T && value)
inline

Add element by move without bounds checking Caller must ensure sufficient capacity was allocated via init() Silently ignores pushes beyond capacity (no exception or assertion)

Definition at line 312 of file helpers.h.

◆ shrink_to_fit()

template<typename T >
void esphome::FixedVector< T >::shrink_to_fit ( )
inline

Definition at line 293 of file helpers.h.

◆ size()

template<typename T >
size_t esphome::FixedVector< T >::size ( ) const
inline

Definition at line 341 of file helpers.h.


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