tpl_dynMapOhash.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_DYNMAPOHASH_H
#define TPL_DYNMAPOHASH_H
 
#include <cstddef>
#include <functional>
#include <type_traits>
#include <utility>
 
#include <tpl_olhash.H>
#include <tpl_odhash.H>
#include <ah-concepts.H>
 
namespace Aleph {
 
template <typename Key,
          typename Data,
          class Cmp = Aleph::equal_to<Key>,
          template <typename, class> class HashTable = ODhashTable>
  requires EqualityComparator<Cmp, Key>
struct MapOpenHash : public HashTable<std::pair<Key, Data>, Dft_Pair_Cmp<Key, Data, Cmp>>
{
  using Pair = std::pair<Key, Data>;
 
  using Base = HashTable<std::pair<Key, Data>, Dft_Pair_Cmp<Key, Data, Cmp>>;
 
  // MSVC: 'using Base::Base' imports ODhashTable(size_t) which collides
  // with the explicitly defined MapOpenHash(size_t, ...) below (C2668).
#if !defined(_MSC_VER) || defined(__clang__)
  using Base::Base;
#endif
  using Base::insert;
 
  using Hash_Fct = std::function<size_t(const Key &)>;
 
  using Hash_Fct_Ptr = size_t (*)(const Key &);
 
  using Key_Type = Key;
 
  using Data_Type = Data;
 
  using Value_Type = Data;
 
  using Item_Type = Pair;
 
  using Set_Type = MapOpenHash;
 
  MapOpenHash(size_t len = Primes::DefaultPrime,
              Hash_Fct_Ptr first_hash_fct = dft_hash_ptr_fct<Key>,
              Hash_Fct_Ptr second_hash_fct = snd_hash_ptr_fct<Key>,
              Cmp cmp = Cmp(),
              float lower_alpha = hash_default_lower_alpha,
              float upper_alpha = hash_default_upper_alpha,
              bool with_resize = true)
    : Base(len,
           std::bind(map_hash_fct<Key, Data, Hash_Fct>, first_hash_fct, std::placeholders::_1),
           std::bind(map_hash_fct<Key, Data, Hash_Fct>, second_hash_fct, std::placeholders::_1),
           Dft_Pair_Cmp<Key, Data, Cmp>(cmp),
           lower_alpha,
           upper_alpha,
           with_resize)
  {}
 
  [[nodiscard]] static Pair *key_to_pair(Key *ptr) noexcept
  {
    return reinterpret_cast<Pair *>(ptr);
  }
 
  [[nodiscard]] static const Pair *key_to_pair(const Key *ptr) noexcept
  {
    return reinterpret_cast<const Pair *>(ptr);
  }
 
  [[nodiscard]] static Pair *data_to_pair(Data *ptr) noexcept
  {
    return reinterpret_cast<Pair *>(reinterpret_cast<char *>(ptr) - offsetof(Pair, second));
  }
 
  [[nodiscard]] static const Pair *data_to_pair(const Data *ptr) noexcept
  {
    return reinterpret_cast<const Pair *>(reinterpret_cast<const char *>(ptr) -
                                          offsetof(Pair, second));
  }
 
  [[nodiscard]] static Data &get_data(Key &key) noexcept
  {
    return key_to_pair(&key)->second;
  }
 
  [[nodiscard]] static const Data &get_data(const Key &key) noexcept
  {
    return key_to_pair(&key)->second;
  }
 
  [[nodiscard]] static const Key &get_key(Data *data_ptr) noexcept
  {
    return data_to_pair(data_ptr)->first;
  }
 
  [[nodiscard]] static const Key &get_key(const Data *data_ptr) noexcept
  {
    return data_to_pair(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)
  {
    return this->Base::insert(Pair(key, std::forward<Data>(data)));
  }
 
  Pair *insert(Key &&key, Data &&data)
  {
    return this->Base::insert(Pair(std::forward<Key>(key), std::forward<Data>(data)));
  }
 
  Pair *insert(Key &&key, const Data &data)
  {
    return this->Base::insert(Pair(std::forward<Key>(key), data));
  }
 
  [[nodiscard]] Pair *search(const Key &key) const noexcept
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::search() requires Data to be default-constructible");
    return this->Base::search(Pair(key, Data()));
  }
 
  [[nodiscard]] Pair *search(Key &&key) const noexcept
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::search() requires Data to be default-constructible");
    return this->Base::search(Pair(std::move(key), Data()));
  }
 
  [[nodiscard]] bool has(const Key &key) const noexcept
  {
    return search(key) != nullptr;
  }
 
  [[nodiscard]] bool has(Key &&key) const noexcept
  {
    return search(std::move(key)) != nullptr;
  }
 
  [[nodiscard]] bool contains(const Key &key) const noexcept
  {
    return has(key);
  }
 
  [[nodiscard]] bool contains(Key &&key) const noexcept
  {
    return has(std::move(key));
  }
 
  [[nodiscard]] Data &find(const Key &key)
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::find() requires Data to be default-constructible");
    return Base::find(Pair(key, Data())).second;
  }
 
  [[nodiscard]] Data &find(Key &&key)
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::find() requires Data to be default-constructible");
    return Base::find(Pair(std::move(key), Data())).second;
  }
 
  [[nodiscard]] const Data &find(const Key &key) const
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::find() requires Data to be default-constructible");
    return Base::find(Pair(key, Data())).second;
  }
 
  [[nodiscard]] const Data &find(Key &&key) const
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::find() requires Data to be default-constructible");
    return Base::find(Pair(std::move(key), Data())).second;
  }
 
  [[nodiscard]] Data &operator [] (const Key &key)
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::operator[] requires Data to be default-constructible");
    return this->search_or_insert(Pair(key, Data()))->second;
  }
 
  [[nodiscard]] const Data &operator [] (const Key &key) const
  {
    return this->find(key);
  }
 
  [[nodiscard]] Data &operator [] (Key &&key)
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::operator[] requires Data to be default-constructible");
    return this->search_or_insert(Pair(std::move(key), Data()))->second;
  }
 
  [[nodiscard]] const Data &operator [] (Key &&key) const
  {
    return this->find(std::move(key));
  }
 
  void remove_by_data(Data &data)
  {
    Base::remove_ptr(data_to_pair(&data));
  }
 
  void remove(const Key &key)
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::remove() requires Data to be default-constructible");
    Base::remove(Pair(key, Data()));
  }
 
  void remove(Key &&key)
  {
    static_assert(std::is_default_constructible<Data>::value,
                  "MapOpenHash::remove() requires Data to be default-constructible");
    Base::remove(Pair(std::move(key), Data()));
  }
 
  using Iterator = typename Base::Iterator;
 
  [[nodiscard]] DynList<Key> keys() const
  {
    return this->template maps<Key>([](auto p)
      {
        return p.first;
      });
  }
 
  [[nodiscard]] DynList<Data> values() const
  {
    return this->template maps<Data>([](auto p)
      {
        return p.second;
      });
  }
 
  [[nodiscard]] 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;
  }
 
  [[nodiscard]] DynList<Pair *> items_ptr()
  {
    DynList<Pair *> ret;
    for (Iterator it(*this); it.has_curr(); it.next_ne())
      ret.append(&it.get_curr());
    return ret;
  }
};
 
template <typename Key, typename Data, class Cmp = Aleph::equal_to<Key>>
  requires EqualityComparator<Cmp, Key>
struct MapOLhash : public MapOpenHash<Key, Data, Cmp, OLhashTable>
{
  using MapOpenHash<Key, Data, Cmp, OLhashTable>::MapOpenHash;
};
 
template <typename Key, typename Data, class Cmp = Aleph::equal_to<Key>>
  requires EqualityComparator<Cmp, Key>
struct MapODhash : public MapOpenHash<Key, Data, Cmp, ODhashTable>
{
  using MapOpenHash<Key, Data, Cmp, ODhashTable>::MapOpenHash;
};
 
}  // end namespace Aleph
 
#endif  // TPL_DYNMAPOHASH_H