# 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 |
|:-------------------------------------|:-----------:|:------:|
| pair                                 |      ✔      |   ✔    |
| tuple                                |      ⭕      |   ❌    |
| optional                             |      ✔      |   ✔    |
| variant                              |      ❌      |   ❌    |
| any                                  |      ❌      |   ❌    |
| bitset                               |      ❌      |   ❌    |
| array                                |      ✔      |   ✔    |
| dynarray (`std::vector`)             |      ✔      |   ✔    |
| list                                 |      ✔      |   ✔    |
| set (`std::unordered_set`)           |      ✔      |   ✔    |
| ordered_set (`std::set`)             |      ✔      |   ✔    |
| map (`std::unordered_map`)           |      ✔      |   ✔    |
| ordered_map (`std::map`)             |      ✔      |   ✔    |
| multiset (`std::unordered_multiset`) |      ✔      |   ✔    |
| ordered_multiset (`std::multiset`)   |      ✔      |   ✔    |
| multimap (`std::unordered_multimap`) |      ✔      |   ✔    |
| ordered_multimap (`std::multimap`)   |      ✔      |   ✔    |


### fennec

| Symbol  | Implemented | Passed |
|:--------|:-----------:|:------:|
| graph   |      ✔      |   ✔    |
| rd_tree |      ✔      |   ✔    |