StackVector.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 nfx
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 
#pragma once
 
#include <algorithm>
#include <cstddef>
#include <cstring>
#include <initializer_list>
#include <iterator>
#include <memory>
#include <stdexcept>
#include <type_traits>
#include <vector>
 
namespace nfx::containers
{
    template <typename T, std::size_t N = 8>
    class StackVector final
    {
    public:
        //----------------------------------------------
        // Type aliases
        //----------------------------------------------

        using value_type = T;

        using size_type = std::size_t;

        using difference_type = std::ptrdiff_t;

        using reference = T&;

        using const_reference = const T&;

        using pointer = T*;

        using const_pointer = const T*;
 
        //----------------------------------------------
        // Construction
        //----------------------------------------------

        inline StackVector() noexcept;

        inline StackVector( std::initializer_list<T> init );

        inline StackVector( const StackVector& other );

        inline StackVector( StackVector&& other ) noexcept;

        inline ~StackVector() noexcept;

        inline StackVector& operator=( const StackVector& other );

        inline StackVector& operator=( StackVector&& other ) noexcept;

        inline bool operator==( const StackVector& other ) const noexcept;

        inline bool operator!=( const StackVector& other ) const noexcept;

        inline void push_back( const T& value );

        inline void push_back( T&& value );

        template <typename... Args>
        inline void emplace_back( Args&&... args );

        inline reference operator[]( size_type pos ) noexcept;

        inline const_reference operator[]( size_type pos ) const noexcept;

        inline reference at( size_type pos );

        inline const_reference at( size_type pos ) const;

        inline reference back() noexcept;

        inline const_reference back() const noexcept;

        inline reference front() noexcept;

        inline const_reference front() const noexcept;

        inline typename StackVector<T, N>::size_type size() const noexcept;

        inline bool isEmpty() const noexcept;

        inline size_type capacity() const noexcept;

        inline void resize( size_type count );

        inline void resize( size_type count, const T& value );

        inline void reserve( size_type newCapacity );

        inline pointer data() noexcept;

        inline const_pointer data() const noexcept;

        inline pointer begin() noexcept;

        inline const_pointer begin() const noexcept;

        inline pointer end() noexcept;

        inline const_pointer end() const noexcept;

        inline const_pointer cbegin() const noexcept;

        inline const_pointer cend() const noexcept;

        inline void clear() noexcept;

        inline void pop_back() noexcept;
 
    private:
        inline void transitionToHeap();

        inline T* stackData() noexcept;

        inline const T* stackData() const noexcept;

        inline std::vector<T>& heapData() noexcept;

        inline const std::vector<T>& heapData() const noexcept;
 
        union alignas( alignof( T ) > alignof( std::vector<T> ) ? alignof( T ) : alignof( std::vector<T> ) )
        {
            unsigned char m_stackStorage[N * sizeof( T )];         
            unsigned char m_heapStorage[sizeof( std::vector<T> )]; 
        };
 
        size_type m_size;  
        bool m_usingStack; 
    };
} // namespace nfx::containers
 
#include "nfx/detail/containers/StackVector.inl"