// =====================================================================================================================
//  fennec, a free and open source game engine
//  Copyright © 2025 - 2026  Medusa Slockbower
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <https://www.gnu.org/licenses/>.
// =====================================================================================================================

///
/// \file fennec/containers/containers.h
/// \brief fennec containers library main header
///
///
/// \details
/// \author Medusa Slockbower
///
/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
///
///

#ifndef FENNEC_CONTAINERS_CONTAINERS_H
#define FENNEC_CONTAINERS_CONTAINERS_H

///
/// \page fennec_containers Containers Library
///
/// \brief The fennec Containers Library.
///        Includes various data structures, those specified in the C++ Standard Library, and custom data structures
///        that fennec uses.
///
/// \code #include <fennec/containers/containers.h> \endcode
///
/// \section fennec_containers_container_section_properties Container Properties
///
/// | Property        | Meaning                                                                                                            |
/// |:----------------|:-------------------------------------------------------------------------------------------------------------------|
/// | **stable**      | Any pointer reference to an element remains constant for the lifetime of the container.                            |
/// | **dynamic**     | Memory for this container is allocated on the heap.                                                                |
/// | **homogeneous** | The types of all elements are either identical, or inherit the same base type.                                     |
/// | **distinct**    | Elements are guaranteed to be unique in their value.                                                               |
/// | **ordered**     | Elements are guaranteed to be in order, such that for any index \math{i}, \math{\textbf{E}_i < \textbf{E}_{i + 1}} |
/// | **space**       | The amount of memory allocated with respect to the number of elements, in big-O notation.                          |
/// | **linear**      | Each element is sequential in terms of access.                                                                     |
/// | **access**      | The runtime of the access operators and functions, in big-O notation.                                              |
/// | **find**        | The runtime of finding an element in the container, in big-O notation.                                             |
/// | **insertion**   | The runtime of inserting an element in the container, in big-O notation.                                           |
/// | **deletion**    | The runtime of erasing an element in the container, in big-O notation.                                             |
///
///
/// \section fennec_containers_section_cppstdlib C++ Standard Template Library
///
/// | Symbol                                                                      | Implemented | Passed |
/// |:----------------------------------------------------------------------------|:-----------:|:------:|
/// | \ref fennec::generic           "fennec::generic" `std::any`                 |      🚧     |   🚧   |
/// | \ref fennec::array             "fennec::array"                              |      ✅     |   ✅   |
/// | \ref fennec::bitfield          "fennec::bitfield" `std::bitset`             |      🚧     |   🚧   |
/// | \ref fennec::deque             "fennec::deque"                              |      🚧     |   🚧   |
/// | \ref fennec::dynarray          "fennec::dynarray" `std::vector`             |      🚧     |   🚧   |
/// | \ref fennec::list              "fennec::list"                               |      ✅     |   ✅   |
/// | \ref fennec::map               "fennec::map" `std::unordered_map`           |      ✅     |   ✅   |
/// | \ref fennec::map_sequence      "fennec::map_sequence" `std::map`            |      ⛔     |   ⛔   |
/// | \ref fennec::multiset          "fennec::multiset" `std::unordered_multiset` |      ⛔     |   ⛔   |
/// | \ref fennec::multisequence     "fennec::multisequence" `std::multiset`      |      ⛔     |   ⛔   |
/// | \ref fennec::multimap          "fennec::multimap" `std::unordered_multimap` |      ⛔     |   ⛔   |
/// | \ref fennec::multimap_sequence "fennec::multimap_sequence" `std::multimap`  |      ⛔     |   ⛔   |
/// | \ref fennec::optional          "fennec::optional"                           |      ✅     |   ✅   |
/// | \ref fennec::pair              "fennec::pair"                               |      ✅     |   ✅   |
/// | \ref fennec::sequence          "fennec::sequence" `std::set`                |      🚧     |   🚧   |
/// | \ref fennec::set               "fennec::set" `std::unordered_set`           |      ✅     |   ✅   |
/// | \ref fennec::tuple             "fennec::tuple"                              |      🚧     |   🚧   |
/// | \ref fennec::variant           "fennec::variant"                            |      🚧     |   🚧   |
///
///
/// \section fennec_containers_section_fennec fennec
///
/// | Symbol                   | Implemented | Passed |
/// |:-------------------------|:-----------:|:------:|
/// | \ref fennec::graph       |      🚧     |   🚧   |
/// | \ref fennec::object_pool |      🚧     |   🚧   |
/// | \ref fennec::rdtree      |      ✅     |   ✅   |
///
///
/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
///

#include <fennec/containers/traversal.h>

#include <fennec/containers/array.h>
#include <fennec/containers/deque.h>
#include <fennec/containers/dynarray.h>
#include <fennec/containers/graph.h>
#include <fennec/containers/list.h>
#include <fennec/containers/map.h>
#include <fennec/containers/object_pool.h>
#include <fennec/containers/optional.h>
#include <fennec/containers/pair.h>
#include <fennec/containers/rdtree.h>
#include <fennec/containers/set.h>
#include <fennec/containers/tuple.h>

#endif // FENNEC_CONTAINERS_CONTAINERS_H