pointPairs< Triangulation > Class Template Reference

HashSet of unique edges. The edges are stored as a pair of pairs: More...

Inheritance diagram for pointPairs< Triangulation >:
[legend]
Collaboration diagram for pointPairs< Triangulation >:
[legend]

Public Member Functions

 pointPairs (const Triangulation &triangulation)
 Construct from triangulation. More...
 
 ~pointPairs ()
 Destructor. More...
 
bool isPointPair (const Vertex_handle &vA, const Vertex_handle &vB) const
 
bool isPointPair (const labelPair &vA, const labelPair &vB) const
 
bool addPointPair (const labelPair &vA, const labelPair &vB)
 
bool addPointPair (const labelPair &master, const DynamicList< labelPair > &slaves)
 
bool addPointPair (const label vA, const label vB)
 
void reIndex (const Map< label > &oldToNewIndices)
 
- Public Member Functions inherited from HashSet< labelPairPair >
Foam::label assignMany (const label nItems, InputIter first, InputIter last)
 
 HashSet ()
 Default construct with default (128) table capacity. More...
 
 HashSet (const this_type &rhs)
 Copy construct. More...
 
 HashSet (this_type &&rhs)
 Move construct. More...
 
 HashSet (const label size)
 Construct given initial table capacity. More...
 
 HashSet (Istream &is)
 Construct from Istream with default table capacity. More...
 
 HashSet (const FixedList< labelPairPair, N > &list)
 Construct from FixedList of Key. More...
 
 HashSet (const UList< labelPairPair > &list)
 Construct from UList of Key. More...
 
 HashSet (const IndirectListBase< labelPairPair, Addr > &list)
 Construct from an indirect list. More...
 
 HashSet (std::initializer_list< labelPairPair > list)
 Construct from an initializer list of Key. More...
 
 HashSet (const HashTable< AnyType, labelPairPair, AnyHash > &tbl)
 
bool test (const labelPairPair &key) const noexcept
 Same as found() - return true if key exists in the set. More...
 
bool insert (const labelPairPair &key)
 Insert a new entry, not overwriting existing entries. More...
 
label insert (InputIter first, InputIter last)
 Insert keys from the input iterator range. More...
 
label insert (std::initializer_list< labelPairPair > list)
 Insert keys from a initializer list of Key. More...
 
label insert (const FixedList< labelPairPair, N > &list)
 Insert keys from the list of Key. More...
 
label insert (const UList< labelPairPair > &list)
 Insert keys from the list of Key. More...
 
label insert (const IndirectListBase< labelPairPair, Addr > &list)
 Insert keys from the list of Key. More...
 
Foam::label insert (InputIter first, InputIter last)
 
Foam::label insert (const FixedList< labelPairPair, N > &list)
 
Foam::label insert (const IndirectListBase< labelPairPair, Addr > &list)
 
bool set (const labelPairPair &key)
 Same as insert (no value to overwrite) More...
 
label set (InputIter first, InputIter last)
 Same as insert (no value to overwrite) More...
 
label set (std::initializer_list< labelPairPair > list)
 Same as insert (no value to overwrite) More...
 
label set (const FixedList< labelPairPair, N > &list)
 Same as insert (no value to overwrite) More...
 
label set (const UList< labelPairPair > &list)
 Same as insert (no value to overwrite) More...
 
label set (const IndirectListBase< labelPairPair, Addr > &list)
 Same as insert (no value to overwrite) More...
 
bool unset (const labelPairPair &key)
 Unset the specified key - same as erase. More...
 
label unset (InputIter first, InputIter last)
 Unset the keys listed in the input iterator range. More...
 
label unset (std::initializer_list< labelPairPair > list)
 Unset the listed keys - same as erase. More...
 
label unset (const FixedList< labelPairPair, N > &list)
 Unset the listed keys - same as erase. More...
 
label unset (const UList< labelPairPair > &list)
 Unset the listed keys - same as erase. More...
 
label unset (const IndirectListBase< labelPairPair, Addr > &list)
 Unset the listed keys - same as erase. More...
 
Foam::label unset (InputIter first, InputIter last)
 
Foam::label unset (const FixedList< labelPairPair, N > &list)
 
Foam::label unset (const IndirectListBase< labelPairPair, Addr > &list)
 
label setMany (InputIter first, InputIter last)
 Same as insert (no value to overwrite) More...
 
iterator begin ()
 
const_iterator begin () const
 
const_iterator cbegin () const
 
iterator end () noexcept
 
const_iterator end () const noexcept
 
constexpr const_iterator cend () const noexcept
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 
bool operator() (const labelPairPair &key) const noexcept
 Return true if the entry exists, same as found() More...
 
bool operator[] (const labelPairPair &key) const noexcept
 Return true if the entry exists, same as found(). More...
 
void operator= (const this_type &rhs)
 Copy assign. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 
void operator= (const UList< labelPairPair > &rhs)
 Assignment from a UList of keys. More...
 
void operator= (const FixedList< labelPairPair, N > &rhs)
 Assignment from a FixedList of keys. More...
 
void operator= (std::initializer_list< labelPairPair > rhs)
 Assignment from an initializer list of keys. More...
 
bool operator== (const this_type &rhs) const
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
this_typeoperator|= (const this_type &rhs)
 Add entries to this HashSet. More...
 
this_typeoperator&= (const this_type &rhs)
 Only retain entries found in both HashSets. More...
 
this_typeoperator^= (const this_type &rhs)
 Only retain unique entries (xor) More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries to this HashSet. Same as the '|=' operator. More...
 
this_typeoperator-= (const this_type &rhs)
 Remove entries from this HashSet. Uses erase() More...
 
List< labelPairPairtocValues (const UnaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
List< labelPairPairtocEntries (const BinaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
label countValues (const UnaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
label countEntries (const BinaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
label filterValues (const UnaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
label filterEntries (const BinaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
- Public Member Functions inherited from HashTable< T, Key, Hash >
 HashTable ()
 Default construct with default (128) table capacity. More...
 
 HashTable (const label size)
 Construct given initial table capacity. More...
 
 HashTable (Istream &is, const label size=128)
 Construct from Istream with default table capacity. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs)
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< Key, T > > list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const noexcept
 The size of the underlying table. More...
 
label size () const noexcept
 The number of elements in table. More...
 
bool empty () const noexcept
 True if the hash table is empty. More...
 
Tat (const Key &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const Tat (const Key &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
bool found (const Key &key) const
 Return true if hashed entry is found in table. More...
 
iterator find (const Key &key)
 Find and return an iterator set at the hashed entry. More...
 
const_iterator find (const Key &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const_iterator cfind (const Key &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const Tlookup (const Key &key, const T &deflt) const
 Return hashed entry if it exists, or return the given default. More...
 
List< Key > toc () const
 The table of contents (the keys) in unsorted order. More...
 
List< Key > sortedToc () const
 The table of contents (the keys) in sorted order. More...
 
template<class Compare >
List< Key > sortedToc (const Compare &comp) const
 
template<class UnaryPredicate >
List< Key > tocKeys (const UnaryPredicate &pred, const bool invert=false) const
 
template<class UnaryPredicate >
List< Key > tocValues (const UnaryPredicate &pred, const bool invert=false) const
 
template<class BinaryPredicate >
List< Key > tocEntries (const BinaryPredicate &pred, const bool invert=false) const
 
UPtrList< const node_typecsorted () const
 
UPtrList< const node_typesorted () const
 
UPtrList< node_typesorted ()
 
template<class UnaryPredicate >
label countKeys (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of keys that satisfy the unary predicate. More...
 
template<class UnaryPredicate >
label countValues (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of values that satisfy the unary predicate. More...
 
template<class BinaryPredicate >
label countEntries (const BinaryPredicate &pred, const bool invert=false) const
 Count the number of entries that satisfy the binary predicate. More...
 
template<class... Args>
bool emplace (const Key &key, Args &&... args)
 Emplace insert a new entry, not overwriting existing entries. More...
 
template<class... Args>
bool emplace_set (const Key &key, Args &&... args)
 Emplace set an entry, overwriting any existing entries. More...
 
bool insert (const Key &key, const T &obj)
 Copy insert a new entry, not overwriting existing entries. More...
 
bool insert (const Key &key, T &&obj)
 Move insert a new entry, not overwriting existing entries. More...
 
bool set (const Key &key, const T &obj)
 Copy assign a new entry, overwriting existing entries. More...
 
bool set (const Key &key, T &&obj)
 Move assign a new entry, overwriting existing entries. More...
 
bool erase (const iterator &iter)
 Erase an entry specified by given iterator. More...
 
bool erase (const Key &key)
 Erase an entry specified by the given key. More...
 
template<class AnyType , class AnyHash >
label erase (const HashTable< AnyType, Key, AnyHash > &other)
 Remove table entries given by keys of the other hash-table. More...
 
label erase (std::initializer_list< Key > keys)
 Remove table entries given by the listed keys. More...
 
template<class InputIter >
label erase (InputIter first, InputIter last)
 Remove multiple entries using an iterator range of keys. More...
 
template<unsigned N>
label erase (const FixedList< Key, N > &keys)
 Remove table entries given by the listed keys. More...
 
label erase (const UList< Key > &keys)
 Remove table entries given by the listed keys. More...
 
template<class AnyType , class AnyHash >
label retain (const HashTable< AnyType, Key, AnyHash > &other)
 Retain table entries given by keys of the other hash-table. More...
 
template<class UnaryPredicate >
label filterKeys (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their keys. More...
 
template<class UnaryPredicate >
label filterValues (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their values. More...
 
template<class BinaryPredicate >
label filterEntries (const BinaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their key/value. More...
 
void resize (const label sz)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void swap (HashTable< T, Key, Hash > &rhs)
 Swap contents into this table. More...
 
void transfer (HashTable< T, Key, Hash > &rhs)
 Transfer contents into this table. More...
 
Toperator[] (const Key &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const Toperator[] (const Key &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
Toperator() (const Key &key)
 Return existing entry or create a new entry. More...
 
Toperator() (const Key &key, const T &deflt)
 Return existing entry or insert a new entry. More...
 
void operator= (const this_type &rhs)
 Copy assign. More...
 
void operator= (std::initializer_list< std::pair< Key, T > > rhs)
 Copy assign from an initializer list. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 
bool operator== (const this_type &rhs) const
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries into this HashTable. More...
 
const_iterator_pair< const_key_iterator, this_typekeys () const
 A const iterator begin/end pair for iterating over keys. More...
 
iterator begin ()
 iterator set to the beginning of the HashTable More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
iterator end () noexcept
 iterator to signal the end (for any HashTable) More...
 
const_iterator end () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
constexpr const_iterator cend () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
OstreamprintInfo (Ostream &os) const
 Print information. More...
 
OstreamwriteKeys (Ostream &os, const label shortLen=0) const
 
template<class Compare >
Foam::List< Key > sortedToc (const Compare &comp) const
 
template<class UnaryPredicate >
Foam::List< Key > tocKeys (const UnaryPredicate &pred, const bool invert) const
 
template<class UnaryPredicate >
Foam::List< Key > tocValues (const UnaryPredicate &pred, const bool invert) const
 
template<class BinaryPredicate >
Foam::List< Key > tocEntries (const BinaryPredicate &pred, const bool invert) const
 
template<class UnaryPredicate >
Foam::label countKeys (const UnaryPredicate &pred, const bool invert) const
 
template<class UnaryPredicate >
Foam::label countValues (const UnaryPredicate &pred, const bool invert) const
 
template<class BinaryPredicate >
Foam::label countEntries (const BinaryPredicate &pred, const bool invert) const
 
template<class InputIter >
Foam::label erase (InputIter first, InputIter last)
 
template<unsigned N>
Foam::label erase (const FixedList< Key, N > &keys)
 
template<class AnyType , class AnyHash >
Foam::label erase (const HashTable< AnyType, Key, AnyHash > &other)
 
template<class AnyType , class AnyHash >
Foam::label retain (const HashTable< AnyType, Key, AnyHash > &other)
 
template<class UnaryPredicate >
Foam::label filterKeys (const UnaryPredicate &pred, const bool pruning)
 
template<class UnaryPredicate >
Foam::label filterValues (const UnaryPredicate &pred, const bool pruning)
 
template<class BinaryPredicate >
Foam::label filterEntries (const BinaryPredicate &pred, const bool pruning)
 
- Public Member Functions inherited from HashTableCore
 ClassName ("HashTable")
 Declare type-name (with debug switch) More...
 
 HashTableCore ()=default
 Default construct. More...
 

Additional Inherited Members

- Public Types inherited from HashSet< labelPairPair >
typedef HashSet< labelPairPair, Foam::Hash< labelPairPair > > this_type
 The template instance used for this HashSet. More...
 
typedef HashTable< zero::null, labelPairPair, Foam::Hash< labelPairPair > > parent_type
 The template instance used for the parent HashTable. More...
 
using iterator = typename parent_type::key_iterator
 An iterator, returning reference to the key. More...
 
using const_iterator = typename parent_type::const_key_iterator
 A const_iterator, returning reference to the key. More...
 
- Public Types inherited from HashTable< T, Key, Hash >
typedef HashTable< T, Key, Hashthis_type
 The template instance used for this HashTable. More...
 
typedef std::conditional< std::is_same< zero::null, typenamestd::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type node_type
 
typedef Key key_type
 The second template parameter, type of keys used. More...
 
typedef T mapped_type
 The first template parameter, type of objects contained. More...
 
typedef T value_type
 Same as mapped_type for OpenFOAM HashTables. More...
 
typedef Hash hasher
 The third template parameter, the hash index method. More...
 
typedef Tpointer
 Pointer type for storing into value_type objects. More...
 
typedef Treference
 Reference to the stored value_type. More...
 
typedef const Tconst_pointer
 Const pointer type for the stored value_type. More...
 
typedef const Tconst_reference
 Const reference to the stored value_type. More...
 
typedef label difference_type
 The type to represent the difference between two iterators. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
using key_iterator = key_iterator_base< iterator >
 Forward iterator returning the key. More...
 
using const_key_iterator = key_iterator_base< const_iterator >
 Forward const iterator returning the key. More...
 
- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label requested_size)
 Return a canonical (power-of-two) of the requested size. More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable internal table size. Approximately labelMax/4. More...
 
- Protected Member Functions inherited from HashTable< T, Key, Hash >
bool iterator_erase (node_type *&entry, label &index)
 Low-level entry erasure using iterator internals. More...
 

Detailed Description

template<class Triangulation>
class Foam::pointPairs< Triangulation >

HashSet of unique edges. The edges are stored as a pair of pairs:

( (local index, processor index) (local index, processor index) )

e.g.,

( (0 1) (3 1) ) ( (0 2) (5 1) )

Definition at line 56 of file pointPairs.H.

Constructor & Destructor Documentation

◆ pointPairs()

pointPairs ( const Triangulation &  triangulation)

Construct from triangulation.

◆ ~pointPairs()

~pointPairs ( )

Destructor.

Member Function Documentation

◆ isPointPair() [1/2]

bool isPointPair ( const Vertex_handle &  vA,
const Vertex_handle &  vB 
) const
inline

◆ isPointPair() [2/2]

bool isPointPair ( const labelPair vA,
const labelPair vB 
) const
inline

◆ addPointPair() [1/3]

bool addPointPair ( const labelPair vA,
const labelPair vB 
)
inline

◆ addPointPair() [2/3]

bool addPointPair ( const labelPair master,
const DynamicList< labelPair > &  slaves 
)
inline

◆ addPointPair() [3/3]

bool addPointPair ( const label  vA,
const label  vB 
)
inline

◆ reIndex()

void reIndex ( const Map< label > &  oldToNewIndices)

The documentation for this class was generated from the following file: