mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
b83007594a
- This follows the same idea as cbegin/cend and is helpful when using
C++11 auto to ensure we have unambiguous const-safe access.
Previously:
====
typename someLongClass::const_iterator iter = someTable.find(key);
... later on:
*iter = value; // Oops, but caught by compiler.
We can save some typing with auto, but it is uncertain what we get:
====
auto iter = someTable.find(key);
// iterator or const_iterator?
// depends on someTable having const or non-const access.
... later on:
*iter = value; // Oops, but not caught by compiler.
Using cfind instead, auto will deduce const_iterator as the type:
====
auto iter = someTable.cfind(key); // definitely const_iterator
... later on:
*iter = value; // Oops, but caught by compiler.
531 lines
12 KiB
C
531 lines
12 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef StaticHashTable_C
|
|
#define StaticHashTable_C
|
|
|
|
#include "StaticHashTable.H"
|
|
#include "List.H"
|
|
#include "IOstreams.H"
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
template<class T, class Key, class Hash>
|
|
Foam::StaticHashTable<T, Key, Hash>::StaticHashTable(const label size)
|
|
:
|
|
StaticHashTableCore(),
|
|
keys_(StaticHashTableCore::canonicalSize(size)),
|
|
objects_(keys_.size()),
|
|
nElmts_(0),
|
|
endIter_(*this, keys_.size(), 0),
|
|
endConstIter_(*this, keys_.size(), 0)
|
|
{
|
|
if (size < 1)
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Illegal size " << size << " for StaticHashTable."
|
|
<< " Minimum size is 1" << abort(FatalError);
|
|
}
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
Foam::StaticHashTable<T, Key, Hash>::StaticHashTable
|
|
(
|
|
const StaticHashTable<T, Key, Hash>& ht
|
|
)
|
|
:
|
|
StaticHashTableCore(),
|
|
keys_(ht.keys_),
|
|
objects_(ht.objects_),
|
|
nElmts_(ht.nElmts_),
|
|
endIter_(*this, keys_.size(), 0),
|
|
endConstIter_(*this, keys_.size(), 0)
|
|
{}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
Foam::StaticHashTable<T, Key, Hash>::StaticHashTable
|
|
(
|
|
const Xfer<StaticHashTable<T, Key, Hash>>& ht
|
|
)
|
|
:
|
|
StaticHashTableCore(),
|
|
keys_(0),
|
|
objects_(0),
|
|
nElmts_(0),
|
|
endIter_(*this, 0, 0),
|
|
endConstIter_(*this, 0, 0)
|
|
{
|
|
transfer(ht());
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
template<class T, class Key, class Hash>
|
|
Foam::StaticHashTable<T, Key, Hash>::~StaticHashTable()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
template<class T, class Key, class Hash>
|
|
bool Foam::StaticHashTable<T, Key, Hash>::found(const Key& key) const
|
|
{
|
|
if (nElmts_)
|
|
{
|
|
const label hashIdx = hashKeyIndex(key);
|
|
const List<Key>& localKeys = keys_[hashIdx];
|
|
|
|
forAll(localKeys, elemIdx)
|
|
{
|
|
if (key == localKeys[elemIdx])
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
#ifdef FULLDEBUG
|
|
if (debug)
|
|
{
|
|
InfoInFunction << "Entry " << key << " not found in hash table\n";
|
|
}
|
|
#endif
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
typename Foam::StaticHashTable<T, Key, Hash>::iterator
|
|
Foam::StaticHashTable<T, Key, Hash>::find
|
|
(
|
|
const Key& key
|
|
)
|
|
{
|
|
if (nElmts_)
|
|
{
|
|
const label hashIdx = hashKeyIndex(key);
|
|
const List<Key>& localKeys = keys_[hashIdx];
|
|
|
|
forAll(localKeys, elemIdx)
|
|
{
|
|
if (key == localKeys[elemIdx])
|
|
{
|
|
return iterator(*this, hashIdx, elemIdx);
|
|
}
|
|
}
|
|
}
|
|
|
|
#ifdef FULLDEBUG
|
|
if (debug)
|
|
{
|
|
InfoInFunction << "Entry " << key << " not found in hash table\n";
|
|
}
|
|
#endif
|
|
|
|
return end();
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
typename Foam::StaticHashTable<T, Key, Hash>::const_iterator
|
|
Foam::StaticHashTable<T, Key, Hash>::find
|
|
(
|
|
const Key& key
|
|
) const
|
|
{
|
|
return this->cfind(key);
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
typename Foam::StaticHashTable<T, Key, Hash>::const_iterator
|
|
Foam::StaticHashTable<T, Key, Hash>::cfind
|
|
(
|
|
const Key& key
|
|
) const
|
|
{
|
|
if (nElmts_)
|
|
{
|
|
const label hashIdx = hashKeyIndex(key);
|
|
const List<Key>& localKeys = keys_[hashIdx];
|
|
|
|
forAll(localKeys, elemIdx)
|
|
{
|
|
if (key == localKeys[elemIdx])
|
|
{
|
|
return const_iterator(*this, hashIdx, elemIdx);
|
|
}
|
|
}
|
|
}
|
|
|
|
#ifdef FULLDEBUG
|
|
if (debug)
|
|
{
|
|
InfoInFunction << "Entry " << key << " not found in hash table\n";
|
|
}
|
|
#endif
|
|
|
|
return cend();
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
Foam::List<Key> Foam::StaticHashTable<T, Key, Hash>::toc() const
|
|
{
|
|
List<Key> keys(nElmts_);
|
|
label keyI = 0;
|
|
|
|
for (const_iterator iter = cbegin(); iter != cend(); ++iter)
|
|
{
|
|
keys[keyI++] = iter.key();
|
|
}
|
|
|
|
return keys;
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
bool Foam::StaticHashTable<T, Key, Hash>::set
|
|
(
|
|
const Key& key,
|
|
const T& obj,
|
|
const bool protect
|
|
)
|
|
{
|
|
const label hashIdx = hashKeyIndex(key);
|
|
List<Key>& localKeys = keys_[hashIdx];
|
|
|
|
label existing = localKeys.size();
|
|
forAll(localKeys, elemIdx)
|
|
{
|
|
if (key == localKeys[elemIdx])
|
|
{
|
|
existing = elemIdx;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (existing == localKeys.size())
|
|
{
|
|
// Not found, append
|
|
List<T>& localObjects = objects_[hashIdx];
|
|
|
|
localKeys.setSize(existing+1);
|
|
localObjects.setSize(existing+1);
|
|
|
|
localKeys[existing] = key;
|
|
localObjects[existing] = obj;
|
|
|
|
nElmts_++;
|
|
}
|
|
else if (protect)
|
|
{
|
|
// Found - but protected from overwriting
|
|
// this corresponds to the STL 'insert' convention
|
|
#ifdef FULLDEBUG
|
|
if (debug)
|
|
{
|
|
InfoInFunction
|
|
<< "Cannot insert " << key << " already in hash table\n";
|
|
}
|
|
#endif
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
// Found - overwrite existing entry
|
|
// this corresponds to the Perl convention
|
|
objects_[hashIdx][existing] = obj;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
bool Foam::StaticHashTable<T, Key, Hash>::erase(const iterator& cit)
|
|
{
|
|
if (cit != end())
|
|
{
|
|
List<Key>& localKeys = keys_[cit.hashIndex_];
|
|
List<T>& localObjects = objects_[cit.hashIndex_];
|
|
|
|
// Copy down
|
|
for (label i = cit.elemIndex_+1; i < localKeys.size(); i++)
|
|
{
|
|
localKeys[i-1] = localKeys[i];
|
|
localObjects[i-1] = localObjects[i];
|
|
}
|
|
localKeys.setSize(localKeys.size()-1);
|
|
localObjects.setSize(localObjects.size()-1);
|
|
|
|
// Adjust iterator after erase
|
|
iterator& it = const_cast<iterator&>(cit);
|
|
|
|
it.elemIndex_--;
|
|
if (it.elemIndex_ < 0)
|
|
{
|
|
// No previous element in the local list
|
|
// Mark with as special value (see notes in HashTable)
|
|
it.hashIndex_ = -it.hashIndex_ - 1;
|
|
it.elemIndex_ = 0;
|
|
}
|
|
|
|
nElmts_--;
|
|
|
|
#ifdef FULLDEBUG
|
|
if (debug)
|
|
{
|
|
InfoInFunction << "hashedEntry removed.\n";
|
|
}
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
#ifdef FULLDEBUG
|
|
if (debug)
|
|
{
|
|
InfoInFunction
|
|
<< "Cannot remove hashedEntry from hash table\n";
|
|
}
|
|
#endif
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
bool Foam::StaticHashTable<T, Key, Hash>::erase(const Key& key)
|
|
{
|
|
iterator it = find(key);
|
|
|
|
if (it != end())
|
|
{
|
|
return erase(it);
|
|
}
|
|
else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
Foam::label Foam::StaticHashTable<T, Key, Hash>::erase
|
|
(
|
|
const StaticHashTable<T, Key, Hash>& rhs
|
|
)
|
|
{
|
|
label count = 0;
|
|
|
|
// Remove rhs elements from this table
|
|
// NOTE: could optimize depending on which hash is smaller
|
|
for (iterator iter = this->begin(); iter != this->end(); ++iter)
|
|
{
|
|
if (rhs.found(iter.key()) && erase(iter))
|
|
{
|
|
count++;
|
|
}
|
|
}
|
|
|
|
return count;
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
void Foam::StaticHashTable<T, Key, Hash>::resize(const label sz)
|
|
{
|
|
label newSize = StaticHashTableCore::canonicalSize(sz);
|
|
|
|
if (newSize == keys_.size())
|
|
{
|
|
#ifdef FULLDEBUG
|
|
if (debug)
|
|
{
|
|
InfoInFunction << "New table size == old table size\n";
|
|
}
|
|
#endif
|
|
|
|
return;
|
|
}
|
|
|
|
if (newSize < 1)
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Illegal size " << newSize << " for StaticHashTable."
|
|
<< " Minimum size is 1" << abort(FatalError);
|
|
}
|
|
|
|
|
|
StaticHashTable<T, Key, Hash> newTable(newSize);
|
|
|
|
for (const_iterator iter = cbegin(); iter != cend(); ++iter)
|
|
{
|
|
newTable.insert(iter.key(), *iter);
|
|
}
|
|
|
|
transfer(newTable);
|
|
|
|
// Adapt end() iterators
|
|
endIter_.hashIndex_ = keys_.size();
|
|
endConstIter_.hashIndex_ = keys_.size();
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
void Foam::StaticHashTable<T, Key, Hash>::clear()
|
|
{
|
|
forAll(keys_, hashIdx)
|
|
{
|
|
keys_[hashIdx].clear();
|
|
objects_[hashIdx].clear();
|
|
}
|
|
|
|
nElmts_ = 0;
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
void Foam::StaticHashTable<T, Key, Hash>::clearStorage()
|
|
{
|
|
clear();
|
|
resize(1);
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
void Foam::StaticHashTable<T, Key, Hash>::transfer
|
|
(
|
|
StaticHashTable<T, Key, Hash>& ht
|
|
)
|
|
{
|
|
// Remove existing elements
|
|
clear();
|
|
|
|
// Copy data from ht
|
|
keys_.transfer(ht.keys_);
|
|
objects_.transfer(ht.objects_);
|
|
|
|
nElmts_ = ht.nElmts_;
|
|
ht.nElmts_ = 0;
|
|
|
|
// Adapt end() iterators
|
|
endIter_.hashIndex_ = keys_.size();
|
|
endConstIter_.hashIndex_ = keys_.size();
|
|
|
|
ht.endIter_.hashIndex_ = 0;
|
|
ht.endConstIter_.hashIndex_ = 0;
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
|
|
|
|
template<class T, class Key, class Hash>
|
|
void Foam::StaticHashTable<T, Key, Hash>::operator=
|
|
(
|
|
const StaticHashTable<T, Key, Hash>& rhs
|
|
)
|
|
{
|
|
// Check for assignment to self
|
|
if (this == &rhs)
|
|
{
|
|
FatalErrorInFunction
|
|
<< "attempted assignment to self"
|
|
<< abort(FatalError);
|
|
}
|
|
|
|
|
|
// keys could be empty from a previous transfer()
|
|
if (keys_.empty())
|
|
{
|
|
keys_.setSize(rhs.keys_.size());
|
|
objects_.setSize(keys_.size());
|
|
|
|
// Adapt end() iterators
|
|
endIter_.hashIndex_ = keys_.size();
|
|
endConstIter_.hashIndex_ = keys_.size();
|
|
}
|
|
else
|
|
{
|
|
clear();
|
|
// keys_.size() does not change so neither does end() iterator.
|
|
}
|
|
|
|
|
|
for (const_iterator iter = rhs.cbegin(); iter != rhs.cend(); ++iter)
|
|
{
|
|
insert(iter.key(), *iter);
|
|
}
|
|
}
|
|
|
|
template<class T, class Key, class Hash>
|
|
bool Foam::StaticHashTable<T, Key, Hash>::operator==
|
|
(
|
|
const StaticHashTable<T, Key, Hash>& rhs
|
|
) const
|
|
{
|
|
// Sizes (number of keys) must match
|
|
|
|
for (const_iterator iter = rhs.cbegin(); iter != rhs.cend(); ++iter)
|
|
{
|
|
const_iterator fnd = find(iter.key());
|
|
|
|
if (fnd == cend() || fnd() != iter())
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
template<class T, class Key, class Hash>
|
|
bool Foam::StaticHashTable<T, Key, Hash>::operator!=
|
|
(
|
|
const StaticHashTable<T, Key, Hash>& rhs
|
|
) const
|
|
{
|
|
return !(operator==(rhs));
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Friend Operators * * * * * * * * * * * * * //
|
|
|
|
#include "StaticHashTableIO.C"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|