zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: cleanup doxygen for HashTable/HashSet

Browse Source 
- remove stray canonicalSize declaration
This commit is contained in:
Mark Olesen
2017-04-11 09:32:53 +02:00
parent ef88dd3e44
commit 31da01d1ea
4 changed files with 61 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/OpenFOAM/containers/HashTables/HashSet/HashSet.H
View File

@ -83,7 +83,7 @@ public:
{}
//- Construct from UList of Key
HashSet(const UList<Key>&);
HashSet(const UList<Key>& lst);
//- Construct from an initializer list of Key
HashSet(std::initializer_list<Key>);
@ -109,7 +109,7 @@ public:
//- Construct from the keys of another HashTable,
// the type of values held is arbitrary.
template<class AnyType, class AnyHash>
HashSet(const HashTable<AnyType, Key, AnyHash>&);
HashSet(const HashTable<AnyType, Key, AnyHash>& h);
// Member Functions
@ -158,24 +158,24 @@ public:
// Member Operators
//- Return true if the entry exists, same as found()
inline bool operator[](const Key&) const;
inline bool operator[](const Key& key) const;
//- Equality. Two hashtables are equal when their contents are equal.
//- Equality. Two hashset are equal when they have the same keys.
// Independent of table size or order.
bool operator==(const HashSet<Key, Hash>&) const;
bool operator==(const HashSet<Key, Hash>& rhs) const;
//- The opposite of the equality operation.
bool operator!=(const HashSet<Key, Hash>&) const;
bool operator!=(const HashSet<Key, Hash>& rhs) const;
//- Combine entries from HashSets
void operator|=(const HashSet<Key, Hash>&);
void operator|=(const HashSet<Key, Hash>& rhs);
//- Only retain entries found in both HashSets
void operator&=(const HashSet<Key, Hash>&);
void operator&=(const HashSet<Key, Hash>& rhs);
//- Only retain unique entries (xor)
void operator^=(const HashSet<Key, Hash>&);
void operator^=(const HashSet<Key, Hash>& rhs);
//- Add entries listed in the given HashSet to this HashSet
inline void operator+=(const HashSet<Key, Hash>& rhs)
@ -184,7 +184,7 @@ public:
}
//- Remove entries listed in the given HashSet from this HashSet
void operator-=(const HashSet<Key, Hash>&);
void operator-=(const HashSet<Key, Hash>& rhs);
};