4f43f0302d
- construct Map/HashTable from key/value lists. - invertToMap() : like invert() but returns a Map<label>, which is useful for sparse numbering - inplaceRenumber() : taking a Map<label> for the mapper ENH: construct/reset CStringList for list of C-strings
160 lines
4.4 KiB
C++
160 lines
4.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
Copyright (C) 2017-2024 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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/>.
|
|
|
|
Class
|
|
Foam::Map
|
|
|
|
Description
|
|
A HashTable to objects of type \<T\> with a label key.
|
|
|
|
Note
|
|
The Map contents are unordered.
|
|
When the key order is important, use the sortedToc() method to obtain
|
|
a list of sorted keys and use that for further access.
|
|
|
|
See also
|
|
PtrMap
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef Foam_Map_H
|
|
#define Foam_Map_H
|
|
|
|
#include "HashTable.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class Map Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class T>
|
|
class Map
|
|
:
|
|
public HashTable<T, label, Hash<label>>
|
|
{
|
|
public:
|
|
|
|
//- The template instance used for this Map
|
|
typedef Map<T> this_type;
|
|
|
|
//- The template instance used for the parent HashTable
|
|
typedef HashTable<T, label, Hash<label>> parent_type;
|
|
|
|
using iterator = typename parent_type::iterator;
|
|
using const_iterator = typename parent_type::const_iterator;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Default construct: empty without allocation (capacity=0)
|
|
Map() noexcept = default;
|
|
|
|
//- Construct empty without allocation (capacity=0)
|
|
explicit Map(const Foam::zero) noexcept
|
|
:
|
|
parent_type(Foam::zero{})
|
|
{}
|
|
|
|
//- Construct empty with given initial table capacity
|
|
explicit Map(const label initialCapacity)
|
|
:
|
|
parent_type(initialCapacity)
|
|
{}
|
|
|
|
//- Construct from Istream (with default initial table capacity)
|
|
Map(Istream& is)
|
|
:
|
|
parent_type(is)
|
|
{}
|
|
|
|
//- Copy construct
|
|
Map(const this_type& map)
|
|
:
|
|
parent_type(map)
|
|
{}
|
|
|
|
//- Move construct
|
|
Map(this_type&& map) noexcept
|
|
:
|
|
parent_type(std::move(map))
|
|
{}
|
|
|
|
//- Construct from key/value pairs in initializer list
|
|
// By default, uses insert not overwrite semantics for duplicates.
|
|
Map
|
|
(
|
|
std::initializer_list<std::pair<label, T>> map,
|
|
const bool overwrite = false
|
|
)
|
|
:
|
|
parent_type(map, overwrite)
|
|
{}
|
|
|
|
//- Construct from key/value pairs
|
|
// By default, uses insert not overwrite semantics for duplicates.
|
|
Map
|
|
(
|
|
const UList<label>& keys,
|
|
const UList<T>& values,
|
|
const bool overwrite = false
|
|
)
|
|
:
|
|
parent_type(keys, values, overwrite)
|
|
{}
|
|
|
|
|
|
// Member Operators
|
|
|
|
using parent_type::operator=;
|
|
|
|
//- Copy assignment
|
|
void operator=(const this_type& rhs)
|
|
{
|
|
parent_type::operator=(rhs);
|
|
}
|
|
|
|
//- Move assignment
|
|
void operator=(this_type&& rhs)
|
|
{
|
|
parent_type::operator=(std::move(rhs));
|
|
}
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|