ExternalRedBlackTreeMap.hpp

Go to the documentation of this file.

// ======================================================================
// \file   ExternalRedBlackTreeMap.hpp
// \author bocchino
// \brief  A map based on a red-black tree with external storage
// ======================================================================

#ifndef Fw_ExternalRedBlackTreeMap_HPP
#define Fw_ExternalRedBlackTreeMap_HPP

#include "Fw/DataStructures/MapBase.hpp"
#include "Fw/DataStructures/RedBlackTreeSetOrMapImpl.hpp"
#include "Fw/Types/Assert.hpp"

namespace Fw {

template <typename K, typename V>
class ExternalRedBlackTreeMap final : public MapBase<K, V> {
    // ----------------------------------------------------------------------
    // Friend class for testing
    // ----------------------------------------------------------------------

    template <typename KK, typename VV>
    friend class ExternalRedBlackTreeMapTester;

  public:
    // ----------------------------------------------------------------------
    // Public types
    // ----------------------------------------------------------------------

    using ConstIterator = MapConstIterator<K, V>;

    using Node = typename RedBlackTreeSetOrMapImpl<K, V>::Node;

    using Index = typename RedBlackTreeSetOrMapImpl<K, V>::Index;

  public:
    // ----------------------------------------------------------------------
    // Public constructors and destructors
    // ----------------------------------------------------------------------

    ExternalRedBlackTreeMap() = default;

    ExternalRedBlackTreeMap(Node* nodes,         
                            Index* freeNodes,    
                            FwSizeType capacity  
                            )
        : MapBase<K, V>() {
        this->setStorage(nodes, freeNodes, capacity);
    }

    ExternalRedBlackTreeMap(ByteArray data,      
                            FwSizeType capacity  
                            )
        : MapBase<K, V>() {
        this->setStorage(data, capacity);
    }

    ExternalRedBlackTreeMap(const ExternalRedBlackTreeMap<K, V>& map) : MapBase<K, V>() { *this = map; }

    ~ExternalRedBlackTreeMap() override = default;

  public:
    // ----------------------------------------------------------------------
    // Public member functions
    // ----------------------------------------------------------------------

    ExternalRedBlackTreeMap<K, V>& operator=(const ExternalRedBlackTreeMap<K, V>& map) {
        if (&map != this) {
            this->m_impl = map.m_impl;
        }
        return *this;
    }

    ConstIterator begin() const override { return ConstIterator(this->m_impl.begin()); }

    void clear() override { this->m_impl.clear(); }

    ConstIterator end() const override { return ConstIterator(this->m_impl.end()); }

    Success find(const K& key,  
                 V& value       
    ) const override {
        return this->m_impl.find(key, value);
    }

    FwSizeType getCapacity() const override { return this->m_impl.getCapacity(); }

    FwSizeType getSize() const override { return this->m_impl.getSize(); }

    Success insert(const K& key,   
                   const V& value  
                   ) override {
        return this->m_impl.insert(key, value);
    }

    Success remove(const K& key,  
                   V& value       
                   ) override {
        return this->m_impl.remove(key, value);
    }

    void setStorage(Node* nodes,         
                    Index* freeNodes,    
                    FwSizeType capacity  
    ) {
        this->m_impl.setStorage(nodes, freeNodes, capacity);
    }

    void setStorage(ByteArray data,      
                    FwSizeType capacity  
    ) {
        this->m_impl.setStorage(data, capacity);
    }

  public:
    // ----------------------------------------------------------------------
    // Public static functions
    // ----------------------------------------------------------------------

    static constexpr U8 getByteArrayAlignment() { return RedBlackTreeSetOrMapImpl<K, V>::getByteArrayAlignment(); }

    static constexpr FwSizeType getByteArraySize(FwSizeType capacity  
    ) {
        return RedBlackTreeSetOrMapImpl<K, V>::getByteArraySize(capacity);
    }

  private:
    // ----------------------------------------------------------------------
    // Private member variables
    // ----------------------------------------------------------------------

    RedBlackTreeSetOrMapImpl<K, V> m_impl = {};
};

}  // namespace Fw

#endif