
<!-- I release these notes into the public domain -->

# Containers Library (`containers`)

## Table of Contents

<!-- TOC -->
* [Home](./CONTENTS.md#planning-documentation-for-fennec)
* [Containers Library](#containers-library-containers)
  * [Table of Contents](#table-of-contents)
  * [Introduction](#introduction)
  * [Implementation](#implementation)
    * [C++ Standard Template Library](#c-standard-template-library)
    * [fennec](#fennec)
<!-- TOC -->


## Introduction

&ensp; This library contains headers and classes that implement common data
structures. The contents include the Containers Library of the C++ Standard
Library and Template Library.


## Implementation


### C++ Standard Template Library

| Symbol                               | Implemented | Passed |
|:-------------------------------------|:-----------:|:------:|
| map (`std::unordered_map`)           |      ✅      |   ✅    |
| map_sequence (`std::map`)            |      ⛔      |   ⛔    |
| multiset (`std::unordered_multiset`) |      ⛔      |   ⛔    |
| multisequence (`std::multiset`)      |      ⛔      |   ⛔    |
| multimap (`std::unordered_multimap`) |      ⛔      |   ⛔    |
| multimap_sequence (`std::multimap`)  |      ⛔      |   ⛔    |
| pair                                 |      ✅      |   ✅    |
| tuple                                |     🚧      |   🚧   |
| optional                             |      ✅      |   ✅    |
| variant                              |      ⛔      |   ⛔    |
| generic (`std::any`)                 |      ⛔      |   ⛔    |
| bitset                               |      ⛔      |   ⛔    |
| array                                |      ✅      |   ✅    |
| dynarray (`std::vector`)             |     🚧      |   🚧   |
| deque                                |      ⛔      |   ⛔    |
| list                                 |      ✅      |   ✅    |
| set (`std::unordered_set`)           |      ✅      |   ✅    |
| sequence (`std::set`)                |      ⛔      |   ⛔    |


### fennec

| Symbol      | Implemented | Passed |
|:------------|:-----------:|:------:|
| graph       |     🚧      |   🚧   |
| object_pool |     🚧      |   🚧   |
| rd_tree     |      ✅      |   ✅    |
