tpl_dynMapTree.H

Go to the documentation of this file.

 
/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
# ifndef TPL_DYNMAPTREE_H
# define TPL_DYNMAPTREE_H
 
# include <type_traits>
# include <utility>
 
# include <tpl_dynSetTree.H>
 
using namespace Aleph;
 
namespace Aleph {
 
  template <
    typename Key, typename Data,
    template <typename, class> class Tree = Avl_Tree,
    class Compare                         = Aleph::less<Key>>
  class DynMapTree :
    public DynSetTree<std::pair<Key, Data>, Tree,
                      Dft_Pair_Cmp<Key, Data, Compare>>
  {
    using Pair = std::pair<Key, Data>;
 
    using Base =
      DynSetTree<std::pair<Key, Data>, Tree, Dft_Pair_Cmp<Key, Data, Compare>>;
 
  public:
 
    using Base::Base;
 
    DynMapTree(const DynList<Key> & keys)
    {
      keys.for_each([this] (auto & k) { this->insert(std::make_pair(k, Data())); });
    }
 
    DynMapTree() = default;
 
    using Key_Type = Key;
 
    using Item_Type = Pair;
 
    using Value_Type = Data ;
 
    // using Base::Base;  // no more need. But I don't remember why I put it
    using Base::insert;
 
    static Data & get_data(Key & key) noexcept
    {
      return key_to_pair<Key, Data>(&key)->second;
    }
 
    static const Data & get_data(const Key & key) noexcept
    {
      return key_to_pair<Key, Data>(&key)->second;
    }
 
    static const Key & get_key(Data * data_ptr) noexcept
    {
      return data_to_pair<Key, Data>(data_ptr)->first;
    }
 
    static const Key & get_key(const Data * data_ptr) noexcept
    {
      return data_to_pair<Key, Data>(data_ptr)->first;
    }
 
    Pair * insert(const Key & key, const Data & data)
    {
      return this->Base::insert(Pair(key, data));
    }
 
    Pair * insert(const Key & key, Data && data = Data())
    {
      return this->Base::insert(Pair(key, std::forward<Data>(data)));
    }
 
    Pair * insert(Key && key, const Data & data)
    {
      return this->Base::insert(Pair(std::forward<Key>(key), data));
    }
 
    Pair * insert(Key && key, Data && data = Data())
    {
      return this->Base::insert(Pair(std::forward<Key>(key),
                                     std::forward<Data>(data)));
    }
 
    Pair * append(const Key & key, const Data & data)
    {
      return this->Base::insert(Pair(key, data));
    }
 
    Pair * append(const Key & key, Data && data = Data())
    {
      return this->Base::insert(Pair(key, std::forward<Data>(data)));
    }
 
    Pair * append(Key && key, const Data & data)
    {
      return this->Base::insert(Pair(std::forward<Key>(key), data));
    }
 
    Pair * append(Key && key, Data && data = Data())
    {
      return this->Base::insert(Pair(std::forward<Key>(key),
                                     std::forward<Data>(data)));
    }
 
    Pair * put(const Key & key, const Data & data)
    {
      return insert(key, data);
    }
 
    Pair * put(const Key & key, Data && data)
    {
      return insert(key, std::forward<Data>(data));
    }
 
    Pair * put(Key && key, const Data & data)
    {
      return insert(std::forward<Key>(key), data);
    }
 
    Pair * put(Key && key, Data && data)
    {
      return insert(std::forward<Key>(key), std::forward<Data>(data));
    }
 
    Data remove(const Key & key)
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::remove() requires Data to be default-constructible");
      Pair p(key, Data());
      return this->del(p).second;
    }
 
    Data remove(Key && key)
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::remove() requires Data to be default-constructible");
      Pair p(std::forward<Key>(key), Data());
      return this->del(p).second;
    }
 
    void remove_key(const Key & key)
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::remove_key() requires Data to be default-constructible");
      (void) this->del(Pair(key, Data()));
    }
 
    Pair * search(const Key & key) const noexcept
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::search() requires Data to be default-constructible");
      return this->Base::search(Pair(key, Data()));
    }
 
    Pair * search(Key && key) const noexcept
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::search() requires Data to be default-constructible");
      return this->Base::search(Pair(std::move(key), Data()));
    }
 
    bool has(const Key & key) const noexcept { return search(key) != nullptr; }
 
    bool has(Key && key) const noexcept { return search(std::move(key)) != nullptr; }
 
    bool contains(const Key & key) const noexcept { return has(key); }
 
    bool contains(Key && key) const noexcept { return has(std::move(key)); }
 
    Data & find(const Key & key)
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::find() requires Data to be default-constructible");
      return this->Base::find(Pair(key, Data())).second;
    }
 
    const Data & find(const Key & key) const
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::find() requires Data to be default-constructible");
      return this->Base::find(Pair(key, Data())).second;
    }
 
    Data & operator [] (const Key & key)
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::operator[] requires Data to be default-constructible");
      return this->search_or_insert(Pair(key, Data()))->second;
    }
 
    const Data & operator [] (const Key & key) const
    {
      return this->find(key);
    }
 
    Data & operator [] (Key && key)
    {
      static_assert(std::is_default_constructible_v<Data>,
                    "DynMapTree::operator[] requires Data to be default-constructible");
      return this->search_or_insert(Pair(std::move(key), Data()))->second;
    }
 
    const Data & operator [] (Key && key) const
    {
      return this->find(std::move(key));
    }
 
    using Iterator = typename Base::Iterator;
 
    DynList<Key> keys() const
    {
      return this->template maps<Key>([] (auto p) { return p.first; });
    }
 
    DynList<Data> values() const
    {
      return this->template maps<Data>([] (auto p) { return p.second; });
    }
 
    DynList<Data*> values_ptr()
    {
      DynList<Data*> ret;
      for (Iterator it(*this); it.has_curr(); it.next_ne())
        ret.append(&it.get_curr().second);
      return ret;
    }
 
    DynList<Pair*> items_ptr()
    {
      DynList<Pair*> ret;
      for (Iterator it(*this); it.has_curr(); it.next_ne())
        ret.append(&it.get_curr());
      return ret;
    }
  };
} // end namespace Aleph
 
 
# include <tpl_binTree.H>
# include <tpl_avl.H>
# include <tpl_rb_tree.H>
# include <tpl_rand_tree.H>
# include <tpl_treap.H>
# include <tpl_treapRk.H>
# include <tpl_splay_tree.H>
 
namespace Aleph {
  template <typename Key, typename Type, class Compare = Aleph::less<Key> >
  class DynMapBinTree : public DynMapTree<Key, Type, BinTree, Compare> {};
 
  template <typename Key, typename Type, class Compare = Aleph::less<Key> >
  class DynMapAvlTree : public DynMapTree<Key, Type, Avl_Tree, Compare> {};
  template <typename Key, typename Type, class Compare = Aleph::less<Key> >
  class DynMapRbTree : public DynMapTree<Key, Type, Rb_Tree, Compare>
  { /* empty */ };
 
  template <typename Key, typename Type, class Compare = Aleph::less<Key> >
  class DynMapRandTree : public DynMapTree<Key, Type, Rand_Tree, Compare>
  { /* empty */ };
 
  template <typename Key, typename Type, class Compare = Aleph::less<Key> >
  class DynMapTreap : public DynMapTree<Key, Type, Treap, Compare>
  { /* empty */ };
 
  template <typename Key, typename Type, class Compare = Aleph::less<Key> >
  class DynMapTreapRk : public DynMapTree<Key, Type, Treap_Rk, Compare>
  { /* empty */ };
 
  template <typename Key, typename Type, class Compare = Aleph::less<Key> >
  class DynMapSplayTree : public DynMapTree<Key, Type, Splay_Tree, Compare>
  { /* empty */ };
 
  template <typename T, class Op, class C>
  DynMapTree<typename C::Item_Type, T> map_unify(const C & c, Op op)
  {
    DynMapTree<typename C::Item_Type, T> ret;
    for (auto it = c.get_it(); it.has_curr(); it.next_ne())
      {
        const auto & curr = it.get_curr();
        ret.insert(curr, op(curr));
      }
    return ret;
  }
 
} // end namespace Aleph
 
# endif /* TPL_DYNMAPTREE_H */