lean_vector.hpp

Go to the documentation of this file.

// Copyright Take Vos 2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "../utility/utility.hpp"
#include "../macros.hpp"
#include <bit>
#include <new>
#include <cstddef>
#include <memory>
#include <algorithm>
#include <iterator>
#include <stdexcept>
 
hi_export_module(hikogui.container.lean_vector);
 
 
hi_warning_push();
// C26450: You called an STL function '' with raw pointer... (stl.1)
// Using an iterator requires a lot of code which will not make it safer.
hi_warning_ignore_msvc(26459);
 
hi_export namespace hi { inline namespace v1 {
 
template<typename T>
class lean_vector {
public:
    using value_type = T;
    using pointer = value_type *;
    using const_pointer = value_type const *;
    using reference = value_type&;
    using const_reference = value_type const&;
    using iterator = value_type *;
    using const_iterator = value_type const *;
    using reverse_iterator = std::reverse_iterator<iterator>;
    using const_reverse_iterator = std::reverse_iterator<const_iterator>;
    using size_type = std::size_t;
    using difference_type = std::ptrdiff_t;
    using allocator_type = std::allocator<value_type>;
 
    constexpr static size_t value_alignment = alignof(value_type);
 
    constexpr allocator_type get_allocator() const noexcept
    {
        static_assert(std::allocator_traits<allocator_type>::is_always_equal::value);
        return allocator_type{};
    }
 
    constexpr lean_vector() noexcept = default;
 
    ~lean_vector()
    {
        clear();
        shrink_to_fit();
    }
 
    lean_vector(lean_vector const& other)
    {
        auto const other_size = other.size();
        auto const update = _reserve<false>(other_size);
        std::uninitialized_copy_n(other.begin(), other_size, update.ptr);
        _reserve_update(update, other_size);
    }
 
    lean_vector(lean_vector&& other) noexcept(std::is_nothrow_move_constructible_v<value_type>)
    {
        if (other._is_short()) {
            auto const other_size = other._short_size();
            std::uninitialized_move_n(other.begin(), other_size, begin());
            other._set_short_size(0);
            _set_short_size(other_size);
 
        } else {
            _ptr = std::exchange(other._ptr, nullptr);
            _end = std::exchange(other._end, nullptr);
            _cap = std::exchange(other._cap, nullptr);
        }
    }
 
    lean_vector& operator=(lean_vector const& other) noexcept
    {
        hi_return_on_self_assignment(other);
 
        auto const other_size = other.size();
 
        clear();
        auto const update = _reserve<false>(other_size);
        std::uninitialized_copy_n(other.begin(), other_size, update.ptr);
        _reserve_update(update, other_size);
 
        return *this;
    }
 
    lean_vector& operator=(lean_vector&& other) noexcept
    {
        hi_return_on_self_assignment(other);
 
        if (not _is_short() and not other._is_short()) {
            std::swap(_ptr, other._ptr);
            std::swap(_end, other._end);
            std::swap(_cap, other._cap);
 
        } else {
            clear();
            shrink_to_fit();
 
            if (other._is_short()) {
                auto const other_size = other._short_size();
                std::uninitialized_move_n(other.begin(), other_size, _short_data());
                _set_short_size(other_size);
 
            } else {
                _ptr = std::exchange(other._ptr, nullptr);
                _end = std::exchange(other._end, nullptr);
                _cap = std::exchange(other._cap, nullptr);
            }
        }
 
        return *this;
    }
 
    void swap(lean_vector& other) noexcept
    {
        auto const this_is_short = this->_is_short();
        auto const other_is_short = other._is_short();
        if (this_is_short) {
            // By moving other to tmp, we make other short.
            lean_vector tmp = std::move(other);
            other = std::move(*this);
            *this = std::move(tmp);
 
        } else if (other_is_short) {
            // By moving this to tmp, we make this short.
            lean_vector tmp = std::move(*this);
            *this = std::move(other);
            other = std::move(tmp);
 
        } else {
            std::swap(this->_ptr, other._ptr);
            std::swap(this->_end, other._end);
            std::swap(this->_cap, other._cap);
        }
    }
 
    explicit lean_vector(size_type count)
    {
        if (count <= short_capacity()) {
            std::uninitialized_value_construct_n(_short_data(), count);
            _set_short_size(count);
 
        } else {
            auto const update = _reserve<false>(count);
            std::uninitialized_value_construct_n(update.ptr, count);
            _reserve_update(update, count);
        }
    }
 
    lean_vector(size_type count, value_type const& value)
    {
        if (count <= short_capacity()) {
            std::uninitialized_fill_n(_short_data(), count, value);
            _set_short_size(count);
 
        } else {
            auto const update = _reserve<false>(count);
            std::uninitialized_fill_n(update.ptr, count, value);
            _reserve_update(update, count);
        }
    }
 
    lean_vector(std::input_iterator auto first, std::input_iterator auto last)
    {
        insert(_short_data(), first, last);
    }
 
    lean_vector(std::initializer_list<value_type> list)
    {
        insert(_short_data(), list.begin(), list.end());
    }
 
    void assign(size_type count, value_type const& value)
    {
        clear();
        insert(begin(), count, value);
    }
 
    void assign(std::input_iterator auto first, std::input_iterator auto last)
    {
        clear();
        insert(begin(), first, last);
    }
 
    void assign(std::initializer_list<value_type> list)
    {
        clear();
        insert(begin(), list.begin(), list.end());
    }
 
    [[nodiscard]] pointer data() noexcept
    {
        if (_is_short()) {
            if (_short_size() == 0) {
                return nullptr;
            } else {
                return _short_data();
            }
        } else {
            if (_ptr == _end) {
                return nullptr;
            } else {
                return _long_data();
            }
        }
    }
 
    [[nodiscard]] const_pointer data() const noexcept
    {
        return const_cast<lean_vector *>(this)->data();
    }
 
    [[nodiscard]] constexpr bool empty() const noexcept
    {
        if (_is_short()) {
            return _short_size() == 0;
        } else {
            return _ptr == _end;
        }
    }
 
    [[nodiscard]] constexpr size_type size() const noexcept
    {
        if (_is_short()) {
            return _short_size();
        } else {
            hi_axiom(_ptr <= _end);
            return truncate<size_type>(_long_size());
        }
    }
 
    [[nodiscard]] constexpr size_type max_size() const noexcept
    {
        auto a = get_allocator();
        return std::allocator_traits<allocator_type>::max_size(a);
    }
 
    [[nodiscard]] constexpr size_t short_capacity() const noexcept
    {
        if constexpr (std::endian::native == std::endian::little) {
            // The first alignment can not be used.
            return (sizeof(pointer) * 3 - alignof(value_type)) / sizeof(value_type);
        } else {
            // The last byte can not be used to store values.
            return (sizeof(pointer) * 3 - 1) / sizeof(value_type);
        }
    }
 
    [[nodiscard]] size_t capacity() const noexcept
    {
        if (_is_short()) {
            return short_capacity();
        } else {
            return _long_capacity();
        }
    }
 
    [[nodiscard]] reference at(size_type index)
    {
        auto const is_short = _is_short();
        auto const size_ = is_short ? _short_size() : _long_size();
        if (index < size_) {
            return _begin_data(is_short)[index];
        } else {
            throw std::out_of_range("lean_vector::at()");
        }
    }
 
    [[nodiscard]] const_reference at(size_type index) const
    {
        return const_cast<lean_vector *>(this)->at(index);
    }
 
    [[nodiscard]] reference operator[](size_type index) noexcept
    {
        hi_axiom(index < size());
        return _begin_data(_is_short())[index];
    }
 
    [[nodiscard]] const_reference operator[](size_type index) const noexcept
    {
        return const_cast<lean_vector *>(this)->operator[](index);
    }
 
    [[nodiscard]] reference front() noexcept
    {
        hi_axiom(not empty());
        return *_begin_data(_is_short());
    }
 
    [[nodiscard]] const_reference front() const noexcept
    {
        return const_cast<lean_vector *>(this)->front();
    }
 
    [[nodiscard]] reference back() noexcept
    {
        hi_axiom(not empty());
        return *(_end_data(_is_short()) - 1);
    }
 
    [[nodiscard]] const_reference back() const noexcept
    {
        return const_cast<lean_vector *>(this)->back();
    }
 
    [[nodiscard]] iterator begin() noexcept
    {
        return _begin_data(_is_short());
    }
 
    [[nodiscard]] const_iterator begin() const noexcept
    {
        return _begin_data(_is_short());
    }
 
    [[nodiscard]] const_iterator cbegin() const noexcept
    {
        return begin();
    }
 
    [[nodiscard]] iterator end() noexcept
    {
        return _end_data(_is_short());
    }
 
    [[nodiscard]] const_iterator end() const noexcept
    {
        return const_cast<lean_vector *>(this)->end();
    }
 
    [[nodiscard]] const_iterator cend() const noexcept
    {
        return end();
    }
 
    void clear() noexcept
    {
        auto const is_short = _is_short();
        std::destroy(_begin_data(is_short), _end_data(is_short));
        _set_size(0, is_short);
    }
 
    void reserve(size_type new_capacity)
    {
        auto const update = _reserve<false>(new_capacity);
        _reserve_update(update);
    }
 
    void shrink_to_fit()
    {
        if (_is_short()) {
            return;
        }
 
        auto const old_ptr = _ptr;
        auto const old_size = size();
        auto const old_capacity = capacity();
 
        if (old_size <= short_capacity()) {
            _set_short_size(old_size);
        } else {
            auto a = get_allocator();
            _ptr = std::allocator_traits<allocator_type>::allocate(a, old_size);
            _end = _ptr + old_size;
            _cap = _ptr + old_size;
        }
 
        std::uninitialized_move_n(old_ptr, old_size, begin());
        std::destroy_n(old_ptr, old_size);
        auto a = get_allocator();
        std::allocator_traits<allocator_type>::deallocate(a, old_ptr, old_capacity);
    }
 
    template<typename... Args>
    iterator emplace(const_iterator pos, Args&&...args)
    {
        auto const index = pos - begin();
        auto const new_size = size() + 1;
 
        auto const update = _reserve<true>(new_size);
        std::construct_at(update.end, std::forward<Args>(args)...);
        _reserve_update(update, new_size);
 
        auto const new_pos = begin() + index;
        std::rotate(new_pos, end() - 1, end());
        return new_pos;
    }
 
    iterator insert(const_iterator pos, value_type const& value)
    {
        auto const index = pos - begin();
        auto const new_size = size() + 1;
 
        auto const update = _reserve<true>(new_size);
        std::uninitialized_copy_n(std::addressof(value), 1, update.end);
        _reserve_update(update, new_size);
 
        auto const new_pos = begin() + index;
        std::rotate(new_pos, end() - 1, end());
        return new_pos;
    }
 
    iterator insert(const_iterator pos, value_type&& value)
    {
        auto const index = pos - begin();
        auto const new_size = size() + 1;
 
        auto const update = _reserve<true>(new_size);
        std::uninitialized_move_n(std::addressof(value), 1, update.end);
        _reserve_update(update, new_size);
 
        auto const new_pos = begin() + index;
        std::rotate(new_pos, end() - 1, end());
        return new_pos;
    }
 
    iterator insert(const_iterator pos, size_type count, value_type const& value)
    {
        auto const index = pos - begin();
        auto const new_size = size() + count;
 
        auto const update = _reserve<true>(new_size);
        std::uninitialized_fill_n(update.end, count, value);
        _reserve_update(update, new_size);
 
        auto const new_pos = begin() + index;
        std::rotate(new_pos, end() - count, end());
        return new_pos;
    }
 
    template<std::input_iterator First, std::input_iterator Last>
    iterator insert(const_iterator pos, First first, Last last)
    {
        if constexpr (requires { std::distance(first, last); }) {
            auto const n = std::distance(first, last);
 
            auto const index = pos - begin();
            auto const new_size = size() + n;
 
            auto const update = _reserve<true>(new_size);
            std::uninitialized_move_n(first, n, update.end);
            _reserve_update(update, new_size);
 
            auto const new_pos = begin() + index;
            std::rotate(new_pos, end() - n, end());
            return new_pos;
 
        } else {
            for (auto it = first; it != last; ++it) {
                pos = insert(pos, *it) + 1;
            }
        }
    }
 
    iterator insert(const_iterator pos, std::initializer_list<value_type> list)
    {
        return insert(pos, list.begin(), list.end());
    }
 
    iterator erase(const_iterator pos)
    {
        hi_axiom(pos >= begin() and pos <= end());
        auto const new_pos = begin() + std::distance(cbegin(), pos);
        std::move(new_pos + 1, end(), new_pos);
 
        auto const is_short = _is_short();
        _set_size(size() - 1, is_short);
        std::destroy_at(_end_data(is_short));
        return new_pos;
    }
 
    iterator erase(const_iterator first, const_iterator last)
    {
        auto const first_ = begin() + std::distance(cbegin(), first);
        auto const last_ = begin() + std::distance(cbegin(), last);
        auto const n = std::distance(first_, last_);
        std::move(last_, end(), first_);
        std::destroy(end() - n, end());
        _set_size(size() - n, _is_short());
        return first_;
    }
 
    template<typename... Args>
    reference emplace_back(Args&&...args)
    {
        auto const new_size = size() + 1;
 
        auto const update = _reserve<true>(new_size);
        auto const obj = std::construct_at(update.end, std::forward<Args>(args)...);
        _reserve_update(update, new_size);
 
        return *obj;
    }
 
    void push_back(value_type const& value)
    {
        auto const new_size = size() + 1;
 
        auto const update = _reserve<true>(new_size);
        std::uninitialized_copy_n(std::addressof(value), 1, update.end);
        _reserve_update(update, new_size);
    }
 
    void push_back(value_type&& value)
    {
        auto const new_size = size() + 1;
 
        auto const update = _reserve<true>(new_size);
        std::uninitialized_move_n(std::addressof(value), 1, update.end);
        _reserve_update(update, new_size);
    }
 
    void pop_back()
    {
        hi_axiom(not empty());
 
        auto const is_short = _is_short();
        _set_size(size() - 1, is_short);
        std::destroy_at(_end_data(is_short));
    }
 
    void resize(size_type new_size)
    {
        if (auto const old_size = size(); new_size > old_size) {
            auto const n = new_size - old_size;
 
            auto const update = _reserve<true>(new_size);
            std::uninitialized_value_construct_n(update.end, n);
            _reserve_update(update, new_size);
 
        } else {
            auto const is_short = _is_short();
            auto const n = old_size - new_size;
            std::destroy(_end_data(is_short) - n, _end_data(is_short));
            _set_size(new_size, is_short);
        }
    }
 
    void resize(size_type new_size, value_type const& value)
    {
        if (auto const old_size = size(); new_size > old_size) {
            auto const n = new_size - old_size;
 
            auto const update = _reserve<true>(new_size);
            std::uninitialized_fill_n(update.end, n, value);
            _reserve_update(update, new_size);
 
        } else {
            auto const is_short = _is_short();
            auto const n = old_size - new_size;
            std::destroy(end() - n, end());
            _set_size(new_size, is_short);
        }
    }
 
    friend bool operator==(lean_vector const& lhs, lean_vector const& rhs) noexcept
    {
        return std::equal(lhs.begin(), lhs.end(), rhs.begin(), rhs.end());
    }
 
    friend auto operator<=>(lean_vector const& lhs, lean_vector const& rhs) noexcept
    {
        return std::lexicographical_compare_three_way(lhs.begin(), lhs.end(), rhs.begin(), rhs.end());
    }
 
    friend size_type erase(lean_vector& c, value_type const& value)
    {
        auto it = std::remove(c.begin(), c.end(), value);
        auto r = std::distance(it, c.end());
        c.erase(it, c.end());
        return r;
    }
 
    template<typename Pred>
    friend size_type erase(lean_vector& c, Pred pred)
    {
        auto it = std::remove(c.begin(), c.end(), pred);
        auto r = std::distance(it, c.end());
        c.erase(it, c.end());
        return r;
    }
 
    friend void swap(lean_vector& lhs, lean_vector& rhs) noexcept
    {
        lhs.swap(rhs);
    }
 
private:
    pointer _ptr = nullptr;
    pointer _end = nullptr;
    pointer _cap = nullptr;
 
    [[nodiscard]] constexpr bool _is_short() const noexcept
    {
        if constexpr (std::endian::native == std::endian::little) {
            if (_ptr == nullptr) {
                return true;
            } else {
                return to_bool(to_int(_ptr) & 1);
            }
        } else {
            if (_cap == nullptr) {
                return true;
            } else {
                return to_bool(to_int(_cap) & 1);
            }
        }
    }
 
    [[nodiscard]] pointer _short_data() const noexcept
    {
        static_assert(alignof(value_type) <= alignof(pointer));
 
        void *p = const_cast<lean_vector *>(this);
        if constexpr (std::endian::native == std::endian::little) {
            p = ceil(advance_bytes(p, 1), alignof(value_type));
        }
        return std::launder(static_cast<pointer>(p));
    }
 
    [[nodiscard]] pointer _long_data() const noexcept
    {
        return _ptr;
    }
 
    [[nodiscard]] constexpr size_type _short_size() const noexcept
    {
        if constexpr (std::endian::native == std::endian::little) {
            if (_ptr == nullptr) {
                return 0;
            } else {
                return (to_int(_ptr) >> 1) & 0x1f;
            }
        } else {
            if (_cap == nullptr) {
                return 0;
            } else {
                return (to_int(_cap) >> 1) & 0x1f;
            }
        }
    }
 
    [[nodiscard]] constexpr size_type _long_size() const noexcept
    {
        hi_axiom(_ptr <= _end);
        return _end - _ptr;
    }
 
    [[nodiscard]] constexpr size_type _long_capacity() const noexcept
    {
        hi_axiom(_ptr <= _cap);
        return _cap - _ptr;
    }
 
    void _set_short_size(size_t new_size) noexcept
    {
        constexpr auto mask = ~intptr_t{0xff};
 
        new_size <<= 1;
        new_size |= 1;
        if constexpr (std::endian::native == std::endian::little) {
            _ptr = to_ptr<pointer>((to_int(_ptr) & mask) | new_size);
        } else {
            _cap = to_ptr<pointer>((to_int(_cap) & mask) | new_size);
        }
    }
 
    void _set_size(size_t new_size, bool is_short) noexcept
    {
        if (is_short) {
            hi_axiom(new_size <= short_capacity());
            _set_short_size(new_size);
        } else {
            _end = _ptr + new_size;
        }
    }
 
    [[nodiscard]] pointer _begin_data(bool is_short) const noexcept
    {
        if (is_short) {
            return _short_data();
        } else {
            return _long_data();
        }
    }
 
    [[nodiscard]] pointer _end_data(bool is_short) const noexcept
    {
        if (is_short) {
            return _short_data() + _short_size();
        } else {
            return _end;
        }
    }
 
    struct _reserve_type {
        pointer ptr;
        pointer end;
        pointer cap;
        bool resized;
        bool is_short;
    };
 
    template<bool ForInsert>
    [[nodiscard]] _reserve_type _reserve(size_type new_capacity) const
    {
        auto const is_short = _is_short();
        auto const capacity = is_short ? short_capacity() : _long_capacity();
        if (new_capacity <= capacity) {
            [[likely]] return {_begin_data(is_short), _end_data(is_short), nullptr, false, is_short};
        }
 
        if constexpr (ForInsert) {
            auto next_capacity = capacity + capacity / 2;
            if (new_capacity > next_capacity) {
                next_capacity = new_capacity + new_capacity / 2;
            }
            new_capacity = next_capacity;
        }
 
        auto a = get_allocator();
        auto const new_ptr = std::allocator_traits<allocator_type>::allocate(a, new_capacity);
 
        auto const size_ = is_short ? _short_size() : _long_size();
        return {new_ptr, new_ptr + size_, new_ptr + new_capacity, true, false};
    }
 
    void _reserve_update(_reserve_type update)
    {
        if (not update.resized) {
            return;
        }
 
        auto const is_short = _is_short();
        auto const old_size = is_short ? _short_size() : _long_size();
        auto const old_ptr = is_short ? _short_data() : _long_data();
 
        std::uninitialized_move_n(old_ptr, old_size, update.ptr);
        std::destroy_n(old_ptr, old_size);
 
        if (not is_short) {
            auto a = get_allocator();
            std::allocator_traits<allocator_type>::deallocate(a, _long_data(), _long_capacity());
        }
 
        _ptr = update.ptr;
        _end = update.end;
        _cap = update.cap;
    }
 
    void _reserve_update(_reserve_type update, size_type new_size)
    {
        _reserve_update(update);
        _set_size(new_size, update.is_short);
    }
};
 
template<std::input_iterator It, std::input_iterator ItEnd>
lean_vector(It first, ItEnd last) -> lean_vector<typename std::iterator_traits<It>::value_type>;
 
 
template<typename T, std::convertible_to<T>... Args>
lean_vector<T> make_lean_vector(Args &&...args) noexcept
{
    return lean_vector<T>{std::forward<Args>(args)...};
}
 
 
}} // namespace hi::v1
 
hi_warning_pop();