hash.inc

Go to the documentation of this file.

 
#pragma once
 
#pragma GCC visibility push(default)
namespace abacus {
 
 
template <class KeyType, class ItemType>
inline AbaHashItem<KeyType, ItemType>::AbaHashItem(
    const KeyType &key,
    const ItemType &item) :
key_(key),
    item_(item),
    next_(nullptr)
{ }
 
 
template <class KeyType, class ItemType>
std::ostream &operator<<(std::ostream &out, const AbaHashItem<KeyType, ItemType> &rhs)
{
    return out << '(' << rhs.key_ << ',' << rhs.item_ << ')';
}
 
 
template <class KeyType, class ItemType>
inline AbaHashItem<KeyType, ItemType> * AbaHashItem<KeyType,
    ItemType>::next()
{
    return next_;
}
 
 
template <class KeyType, class ItemType>
AbaHash<KeyType, ItemType>::AbaHash(int size)
    : size_(size), nCollisions_(0), iter_(nullptr)
{
    table_ = new AbaHashItem<KeyType, ItemType>* [size];
 
    for (int i = 0; i < size; i++)
        table_[i] = nullptr;
}
 
 
template <class KeyType, class ItemType>
AbaHash<KeyType, ItemType>::~AbaHash()
{
    AbaHashItem<KeyType, ItemType> *h1;
    AbaHashItem<KeyType, ItemType> *h2;
    int i;
 
    for (i = 0; i < size_; i++) {
        if((h1 = table_[i]))
            while (h1) {
                h2 = h1->next_;
                delete h1;
                h1 = h2;
            }
    }
    delete [] table_;
}
 
 
template <class KeyType, class ItemType>
std::ostream &operator<<(std::ostream &out, const AbaHash<KeyType, ItemType> &hash)
{
    AbaHashItem<KeyType, ItemType> *h;
    const int s = hash.size();
 
    for (int i = 0; i < s; i++) {
        h = hash.table_[i];
        if (h) {
            out << i << ':';
            while(h) {
                out << *h << ' ';
                h = h->next();
            }
            out << std::endl;
        }
    }
    return out;
}
 
 
template <class KeyType, class ItemType>
void AbaHash<KeyType, ItemType>::insert(
    const KeyType &key,
    const ItemType &item)
{
    AbaHashItem<KeyType, ItemType> *h = new AbaHashItem<KeyType, ItemType>(key, item);
    int slotNum = hf(key);
 
    if (table_[slotNum]) ++nCollisions_;
    h->next_ = table_[slotNum];
    table_[slotNum] = h;
}
 
 
template <class KeyType, class ItemType>
void AbaHash<KeyType, ItemType>::overWrite(
    const KeyType &key,
    const ItemType &item)
{
    int slotNum = hf(key);
    if (table_[slotNum]) ++nCollisions_;
 
    AbaHashItem<KeyType, ItemType> *h = table_[slotNum];
 
 
    while (h) {
        if (h->key_ == key) {
            h->item_ = item;
            return;
        }
        h = h->next_;
    }
 
    h               = new AbaHashItem<KeyType, ItemType>(key, item);
    h->next_        = table_[slotNum];
    table_[slotNum] = h;
}
 
 
template <class KeyType, class ItemType>
const ItemType * AbaHash<KeyType, ItemType>::find(const KeyType &key) const
{
    const AbaHashItem<KeyType, ItemType> *slot;
 
    slot = table_[hf(key)];
 
    while (slot) {
        if (key == slot->key_) return &(slot->item_);
        slot = slot->next_;
    }
    return nullptr;
}
 
template <class KeyType, class ItemType>
ItemType * AbaHash<KeyType, ItemType>::find(const KeyType &key)
{
    AbaHashItem<KeyType, ItemType> *slot;
 
    slot = table_[hf(key)];
 
    while (slot) {
        if (key == slot->key_) return &(slot->item_);
        slot = slot->next_;
    }
    return 0;
}
 
template <class KeyType, class ItemType>
bool AbaHash<KeyType, ItemType>::find (const KeyType &key, const ItemType &item) const
{
    const AbaHashItem<KeyType, ItemType> *slot;
 
    slot = table_[hf(key)];
 
    while (slot) {
        if (key == slot->key_ && slot->item_ == item)
            return true;
        slot = slot->next_;
    }
    return false;
}
 
 
template <class KeyType, class ItemType>
ItemType *AbaHash<KeyType, ItemType>::initializeIteration(const KeyType &key)
{
    iter_ = table_[hf(key)];
    while (iter_) {
        if (key == iter_->key_) return &(iter_->item_);
        iter_ = iter_->next_;
    }
    return nullptr;
}
 
template <class KeyType, class ItemType>
const ItemType *AbaHash<KeyType, ItemType>::initializeIteration(const KeyType &key) const
{
    iter_ = table_[hf(key)];
    while (iter_) {
        if (key == iter_->key_) return &(iter_->item_);
        iter_ = iter_->next_;
    }
    return nullptr;
}
 
template <class KeyType, class ItemType>
ItemType *AbaHash<KeyType, ItemType>::next(const KeyType &key)
{
    if (iter_ == nullptr) return nullptr;
    iter_ = iter_->next_;
 
    while (iter_) {
        if (key == iter_->key_) return &(iter_->item_);
        iter_ = iter_->next();
    }
    return nullptr;
}
 
template <class KeyType, class ItemType>
const ItemType *AbaHash<KeyType, ItemType>::next(const KeyType &key) const
{
    if (iter_ == nullptr) return nullptr;
    iter_ = iter_->next_;
 
    while (iter_) {
        if (key == iter_->key_) return &(iter_->item_);
        iter_ = iter_->next();
    }
    return nullptr;
}
 
template <class KeyType, class ItemType>
int AbaHash<KeyType, ItemType>::remove(const KeyType &key)
{
    // remove(): find the slot and return if it is empty
    AbaHashItem<KeyType, ItemType> *h1;
    AbaHashItem<KeyType, ItemType> *h2;
    int slotNum = hf(key);
 
    h1 = table_[slotNum];
    if (h1 == 0)
        return 1;
 
    // check if the first item is being removed
    if (h1->key_ == key) {
        table_[slotNum] = h1->next_;
        delete h1;
        return 0;
    }
 
    // otherwise, go through the linked list
    while ((h2 = h1->next_)) {
        if (h2->key_ == key) {
            h1->next_ = h2->next_;
            delete h2;
            return 0;
        }
        h1 = h2;
    }
    return 1;
}
 
 
template <class KeyType, class ItemType>
int AbaHash<KeyType, ItemType>::remove(const KeyType &key, const ItemType &item)
{
    // remove(): find the slot and return if it is empty
    AbaHashItem<KeyType, ItemType> *h1;
    AbaHashItem<KeyType, ItemType> *h2;
    int slotNum = hf(key);
 
    h1 = table_[slotNum];
    if (h1 == nullptr)
        return 1;
 
    // check \a key and \a item of the head of the list
    if (h1->key_ == key && h1->item_ == item) {
        table_[slotNum] = h1->next_;
        delete h1;
        return 0;
    }
 
    // check \a key and \a item of the other elements of the list
    while ((h2 = h1->next_)) {
        if (h2->key_ == key && h2->item_ == item) {
            h1->next_ = h2->next_;
            delete h2;
            return 0;
        }
        h1 = h2;
    }
    return 1;
}
 
 
template <class KeyType, class ItemType>
inline int AbaHash<KeyType, ItemType>::size() const
{
    return size_;
}
 
 
template <class KeyType, class ItemType>
inline int AbaHash<KeyType, ItemType>::nCollisions() const
{
    return nCollisions_;
}
 
 
template <class KeyType, class ItemType>
inline int AbaHash<KeyType, ItemType>::hf(int key) const
{
    if (key < 0) key = -key;
 
    double x = key*0.6180339887;
 
    return (int) (size()*(x-floor(x)));
}
 
 
template <class KeyType, class ItemType>
inline int AbaHash<KeyType, ItemType>::hf(unsigned key) const
{
    double x = key*0.6180339887;
 
    return (int) (size()*fmod(x, 1.0));
}
 
 
template <class KeyType, class ItemType>
int AbaHash<KeyType, ItemType>::hf(const string &str) const
{
    const int prime = 516595003;
    const int mult  = 314159;
 
    string::size_type s     = str.size();
    int h = 0;
    for (string::size_type i = 0; i < s; i++) {
        h += (h ^ (h >> 1)) + mult * (unsigned char) str[i];
        while (h >= prime)
            h -= prime;
    }
 
    return h % size();
}
 
 
template <class KeyType, class ItemType>
void AbaHash<KeyType, ItemType>::resize(int newSize)
{
    // check the value of \a newSize
    if (newSize <= 0) {
        Logger::ifout() << "AbaHash::resize(): new size of hash table must be positive.\n";
        OGDF_THROW_PARAM(AlgorithmFailureException, ogdf::AlgorithmFailureCode::Hash);
    }
 
    // allocate a new hash table
    /* We have to set the entries of the new hash table to 0 that we
    * can insert the items in the linear lists of the slots in a simple way later.
    */
    AbaHashItem<KeyType, ItemType> **newTable;
 
    newTable = new AbaHashItem<KeyType, ItemType>* [newSize];
 
    for (int i = 0; i < newSize; i++)
        newTable[i] = nullptr;
 
    // insert all elements of the old table into the new table
    /* We cannot make copies of slots of the old hash tables but have to reinsert
    * all elements into the new hash table since the hash function might have
    * changed. For efficieny we move each hash item to the new slot.
    *
    * We replace already here the old size with the new size of the hash table,
    * because we need the hash function according to the new size.
    */
    int oldSize = size_;
    size_       = newSize;
 
    for (int i = 0; i < oldSize; i++) {
        if (table_[i]) {
            // move the items to the corresponding new slots
            AbaHashItem<KeyType, ItemType> *current = table_[i];
            AbaHashItem<KeyType, ItemType> *next;
 
            while (current) {
                int slotNum = hf(current->key_);
                next = current->next_;
 
                current->next_    = newTable[slotNum];
                newTable[slotNum] = current;
                current           = next;
            }
 
        }
    }
 
    // replace the old table by the new one
    delete [] table_;
    table_ = newTable;
}
 
}
#pragma GCC visibility pop