hxdeque.hpp

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2025 Adrian Johnston.
// SPDX-License-Identifier: MIT
// This file is licensed under the MIT license found in the LICENSE.md file.

 
#include "libhatchet.h"
 
// HX_USE_MACROS_WITH_MODULE allows including macros alongside the module.
#if HX_USE_MACROS_WITH_MODULE
#error Header does not provide macros alone.
#endif
 
#include "hxallocator.hpp"
#include "hxutility.h"
 
HX_NS_BEGIN_

template<typename T_, hxsize_t capacity_=hxallocator_dynamic_capacity>
class hxdeque : private hxallocator<T_, capacity_> {
public:
    explicit hxdeque(hxsize_t dynamic_capacity_=0);

    ~hxdeque(void);

    hxattr_nodiscard T_& operator[](hxsize_t index_);

    hxattr_nodiscard const T_& operator[](hxsize_t index_) const;

    hxattr_nodiscard T_& at(hxsize_t index_);

    hxattr_nodiscard const T_& at(hxsize_t index_) const;

    hxattr_nodiscard T_& back(void);

    hxattr_nodiscard const T_& back(void) const;

    hxattr_nodiscard hxsize_t capacity(void) const;

    void clear(void) noexcept;

    template<typename... args_t_>
    void emplace_back(args_t_&&... args_) noexcept;

    template<typename... args_t_>
    void emplace_front(args_t_&&... args_) noexcept;

    hxattr_nodiscard bool empty(void) const;

    hxattr_nodiscard T_& front(void);

    hxattr_nodiscard const T_& front(void) const;

    hxattr_nodiscard bool full(void) const;

    hxattr_nodiscard hxsize_t max_size(void) const { return this->capacity(); }

    void pop_back(void) noexcept;

    void pop_front(void) noexcept;

    template<typename... args_t_>
    void push_back(args_t_&&... args_) noexcept;

    template<typename... args_t_>
    void push_front(args_t_&&... args_) noexcept;

    void reserve(hxsize_t dynamic_capacity_);

    hxattr_nodiscard hxsize_t size(void) const;
 
private:
    // This is raw underlying data and would not be what was expected.
    using hxallocator<T_, capacity_>::data;
 
    hxdeque(const hxdeque&) = delete;
    void operator=(const hxdeque&) = delete;
 
    size_t m_head_;
    size_t m_tail_;
};
 
#include "detail/hxdeque.inl"
HX_NS_END_