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

#include <pointPairs.H>

Inheritance diagram for pointPairs< Triangulation >:

[legend]

Collaboration diagram for pointPairs< Triangulation >:

Public Member Functions
	pointPairs (const Triangulation &triangulation)
	Construct from triangulation.
	~pointPairs ()
	Destructor.
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 UList< labelPair > &slaves)
bool	addPointPair (const label vA, const label vB)
void	reIndex (const Map< label > &oldToNewIndices)
Public Member Functions inherited from HashSet< labelPairPair >
constexpr	HashSet () noexcept=default
	Default construct: empty without allocation (capacity=0).
constexpr	HashSet (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashSet (const label initialCapacity)
	Construct empty with initial table capacity.
	HashSet (const this_type &rhs)
	Copy construct.
	HashSet (this_type &&rhs) noexcept
	Move construct.
	HashSet (Istream &is)
	Construct from Istream with default initial table capacity.
	HashSet (const FixedList< labelPairPair, N > &list)
	Construct from FixedList of Key.
	HashSet (const UList< labelPairPair > &list)
	Construct from UList of Key.
	HashSet (const IndirectListBase< labelPairPair, Addr > &list)
	Construct from an indirect list.
	HashSet (std::initializer_list< labelPairPair > list)
	Construct from an initializer list of Key.
	HashSet (const HashTable< AnyType, labelPairPair, AnyHash > &tbl)
	Construct from the keys of another HashTable, the type of values held is arbitrary.
bool	test (const labelPairPair &key) const
	Same as contains() - return true if key exists in the set.
bool	insert (const labelPairPair &key)
	Insert a new entry, not overwriting existing entries.
bool	set (const labelPairPair &key)
	Same as insert (no value to overwrite).
bool	unset (const labelPairPair &key)
	Unset the specified key - same as erase.
void	merge (HashSet< labelPairPair, Foam::Hash< labelPairPair > > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
void	merge (HashSet< labelPairPair, Foam::Hash< labelPairPair > > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
label	insert (InputIter first, InputIter last)
	Insert keys from the input iterator range.
label	insert (std::initializer_list< labelPairPair > list)
	Insert keys from a initializer list of Key.
label	insert (const FixedList< labelPairPair, N > &list)
	Insert keys from the list of Key.
label	insert (const UList< labelPairPair > &list)
	Insert keys from the list of Key.
label	insert (const IndirectListBase< labelPairPair, Addr > &list)
	Insert keys from the list of Key.
label	set (InputIter first, InputIter last)
	Same as insert (no value to overwrite).
label	set (std::initializer_list< labelPairPair > list)
	Same as insert (no value to overwrite).
label	set (const FixedList< labelPairPair, N > &list)
	Same as insert (no value to overwrite).
label	set (const UList< labelPairPair > &list)
	Same as insert (no value to overwrite).
label	set (const IndirectListBase< labelPairPair, Addr > &list)
	Same as insert (no value to overwrite).
label	setMany (InputIter first, InputIter last)
	Same as insert (no value to overwrite).
label	unset (InputIter first, InputIter last)
	Unset the keys listed in the input iterator range.
label	unset (std::initializer_list< labelPairPair > list)
	Unset the listed keys - same as erase.
label	unset (const FixedList< labelPairPair, N > &list)
	Unset the listed keys - same as erase.
label	unset (const UList< labelPairPair > &list)
	Unset the listed keys - same as erase.
label	unset (const IndirectListBase< labelPairPair, Addr > &list)
	Unset the listed keys - same as erase.
iterator	begin ()
const_iterator	begin () const
const_iterator	cbegin () const
iterator	end () noexcept
const_iterator	end () const noexcept
constexpr const_iterator	cend () const noexcept
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen.
bool	operator() (const labelPairPair &key) const noexcept
	Return true if the entry exists, same as contains().
bool	operator[] (const labelPairPair &key) const noexcept
	Return true if the entry exists, same as contains().
void	operator= (const this_type &rhs)
	Copy assign.
void	operator= (this_type &&rhs)
	Move assign.
bool	operator== (const this_type &rhs) const
	Sets are equal if all keys are equal, independent of order or underlying storage size.
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation.
void	operator= (const UList< labelPairPair > &rhs)
	Assignment from a UList of keys.
void	operator= (const FixedList< labelPairPair, N > &rhs)
	Assignment from a FixedList of keys.
void	operator= (std::initializer_list< labelPairPair > rhs)
	Assignment from an initializer list of keys.
this_type &	operator\|= (const this_type &rhs)
	Add entries to this HashSet.
this_type &	operator&= (const this_type &rhs)
	Only retain entries contained in both HashSets.
this_type &	operator^= (const this_type &rhs)
	Only retain unique entries (xor).
this_type &	operator+= (const this_type &rhs)
	Add entries to this HashSet. Same as the '\|=' operator.
this_type &	operator-= (const this_type &rhs)
	Remove entries from this HashSet. Uses erase().
List< labelPairPair >	tocValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
List< labelPairPair >	tocEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	countValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	countEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	filterValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	filterEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
Foam::label	assignMany (const label nItems, InputIter first, InputIter last)
Foam::label	insert (InputIter first, InputIter last)
Foam::label	insert (const FixedList< labelPairPair, N > &list)
Foam::label	insert (const IndirectListBase< labelPairPair, Addr > &list)
Foam::label	unset (InputIter first, InputIter last)
Foam::label	unset (const FixedList< labelPairPair, N > &list)
Foam::label	unset (const IndirectListBase< labelPairPair, Addr > &list)
Public Member Functions inherited from HashTable< T, Key, Hash >
constexpr	HashTable () noexcept
	Default construct: empty without allocation (capacity=0).
constexpr	HashTable (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashTable (const label initialCapacity)
	Construct empty with initial table capacity.
	HashTable (Istream &is)
	Construct from Istream.
	HashTable (const this_type &ht)
	Copy construct.
	HashTable (this_type &&rhs) noexcept
	Move construct.
	HashTable (std::initializer_list< std::pair< Key, T > > list, const bool overwrite=false)
	Construct from key/value pairs in initializer list.
	HashTable (const UList< Key > &keys, const UList< T > &values, const bool overwrite=false)
	Construct from key/value pairs.
	~HashTable ()
	Destructor.
bool	empty () const noexcept
	True if the hash table is empty.
label	size () const noexcept
	The number of elements in table.
label	capacity () const noexcept
	The size of the underlying table (the number of buckets).
T &	at (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
bool	contains (const Key &key) const
	True if hashed key is contained (found) in table.
iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry.
const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const T &	lookup (const Key &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default.
List< Key >	toc () const
	The table of contents (the keys) in unsorted order.
List< Key >	sortedToc () const
	The table of contents (the keys) in sorted order.
template<class Compare>
List< Key >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator.
template<class UnaryPredicate>
List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the keys.
template<class UnaryPredicate>
List< Key >	tocValues (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the values.
template<class BinaryPredicate>
List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the binary predicate applied to the keys and values.
UPtrList< const node_type >	csorted () const
	Const access to the hash-table contents in sorted order (sorted by keys).
UPtrList< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys).
template<class UnaryPredicate>
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate.
template<class UnaryPredicate>
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate.
template<class BinaryPredicate>
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate.
template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries.
template<class... Args>
bool	emplace_set (const Key &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries.
bool	insert (const Key &key, const T &obj)
	Copy insert a new entry, not overwriting existing entries.
bool	insert (const Key &key, T &&obj)
	Move insert a new entry, not overwriting existing entries.
bool	set (const Key &key, const T &obj)
	Copy assign a new entry, overwriting existing entries.
bool	set (const Key &key, T &&obj)
	Move assign a new entry, overwriting existing entries.
bool	erase (const iterator &iter)
	Erase an entry specified by given iterator.
bool	erase (const Key &key)
	Erase an entry specified by the given key.
template<class AnyType, class AnyHash>
label	erase (const HashTable< AnyType, Key, AnyHash > &other)
	Remove table entries given by keys of the other hash-table.
label	erase (std::initializer_list< Key > keys)
	Remove table entries given by the listed keys.
template<class InputIter>
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys.
template<unsigned N>
label	erase (const FixedList< Key, N > &keys)
	Remove table entries given by the listed keys.
label	erase (const UList< Key > &keys)
	Remove table entries given by the listed keys.
template<class AnyType, class AnyHash>
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table.
template<class UnaryPredicate>
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys.
template<class UnaryPredicate>
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values.
template<class BinaryPredicate>
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value.
void	clear ()
	Remove all entries from table.
void	clearStorage ()
	Remove all entries from table and the table itself.
void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets).
void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity().
void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table.
void	swap (HashTable< T, Key, Hash > &rhs) noexcept
	Swap contents into this table.
void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table.
void	merge (HashTable< T, Key, Hash > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
void	merge (HashTable< T, Key, Hash > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
T &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
T &	operator() (const Key &key)
	Return existing entry or create a new entry.
T &	operator() (const Key &key, const T &deflt)
	Return existing entry or insert a new entry.
void	operator= (const this_type &rhs)
	Copy assign.
void	operator= (std::initializer_list< std::pair< Key, T > > rhs)
	Copy assign from an initializer list.
void	operator= (this_type &&rhs)
	Move assign.
bool	operator== (const this_type &rhs) const
	Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size.
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation.
this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable.
const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys.
iterator	begin ()
	iterator set to the beginning of the HashTable
const_iterator	begin () const
	const_iterator set to the beginning of the HashTable
const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable
iterator	end () noexcept
	iterator to signal the end (for any HashTable)
const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable)
constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable)
Ostream &	printInfo (Ostream &os) const
	Print information.
Ostream &	writeKeys (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen.
bool	found (const Key &key) const
	Same as contains().
UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method.
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).
constexpr	HashTableCore () noexcept=default
	Default construct.

Additional Inherited Members
Public Types inherited from HashSet< labelPairPair >
typedef HashSet< labelPairPair, Foam::Hash< labelPairPair > >	this_type
	The template instance used for this HashSet.
typedef HashTable< Foam::zero, labelPairPair, Foam::Hash< labelPairPair > >	parent_type
	The template instance used for the parent HashTable.
using	iterator
	An iterator, returning reference to the key.
using	const_iterator
	A const_iterator, returning reference to the key.
Public Types inherited from HashTable< T, Key, Hash >
typedef HashTable< T, Key, Hash >	this_type
	The template instance used for this HashTable.
using	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions.
typedef Key	key_type
	The second template parameter, type of keys used.
typedef T	mapped_type
	The first template parameter, type of objects contained.
typedef T	value_type
	Same as mapped_type for OpenFOAM HashTables.
typedef Hash	hasher
	The third template parameter, the hash index method.
typedef T *	pointer
	Pointer type for storing into value_type objects.
typedef T &	reference
	Reference to the stored value_type.
typedef const T *	const_pointer
	Const pointer type for the stored value_type.
typedef const T &	const_reference
	Const reference to the stored value_type.
typedef label	difference_type
	The type to represent the difference between two iterators.
typedef label	size_type
	The type that can represent the size of a HashTable.
using	key_iterator = key_iterator_base<iterator>
	Forward iterator returning the key.
using	const_key_iterator = key_iterator_base<const_iterator>
	Forward const iterator returning the key.
Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label size) noexcept
	Return a canonical (power-of-two) of the requested size.
Static Public Attributes inherited from HashTableCore
static constexpr int32_t	maxTableSize = (1 << (32-3))
	Maximum allowable internal table size (must be a power of two!).

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 50 of file pointPairs.H.

Constructor & Destructor Documentation

◆ pointPairs()

template<class Triangulation>

pointPairs ( const Triangulation & triangulation )

Construct from triangulation.

◆ ~pointPairs()

template<class Triangulation>

~pointPairs ( )

Destructor.

Member Function Documentation

◆ isPointPair() [1/2]

template<class Triangulation>

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

inline

◆ isPointPair() [2/2]

template<class Triangulation>

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

inline

◆ addPointPair() [1/3]

template<class Triangulation>

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

inline

◆ addPointPair() [2/3]

template<class Triangulation>

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

inline

◆ addPointPair() [3/3]

template<class Triangulation>

bool addPointPair	(	const label	vA,
		const label	vB )

inline

◆ reIndex()

template<class Triangulation>

void reIndex ( const Map< label > & oldToNewIndices )

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

applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/pointPairs/pointPairs.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pointPairs()

◆ ~pointPairs()

Member Function Documentation

◆ isPointPair() [1/2]

◆ isPointPair() [2/2]

◆ addPointPair() [1/3]

◆ addPointPair() [2/3]

◆ addPointPair() [3/3]

◆ reIndex()