pointFeatureEdgesTypes Class Reference

Hold the types of feature edges attached to the point. More...

Inheritance diagram for pointFeatureEdgesTypes:
Collaboration diagram for pointFeatureEdgesTypes:

Public Member Functions

 pointFeatureEdgesTypes (const extendedFeatureEdgeMesh &feMesh, const label pointLabel)
 Construct from components. More...
 
 ~pointFeatureEdgesTypes ()=default
 Destructor. More...
 
List< extendedFeatureEdgeMesh::edgeStatuscalcPointFeatureEdgesTypes ()
 Fill the pointFeatureEdgesType class with the types of feature. More...
 
- Public Member Functions inherited from HashTable< label, extendedFeatureEdgeMesh::edgeStatus, Hash< label > >
 HashTable () noexcept
 Default construct: empty without allocation (capacity=0) More...
 
 HashTable (const Foam::zero) noexcept
 Construct empty without allocation (capacity=0) More...
 
 HashTable (const label initialCapacity)
 Construct empty with initial table capacity. More...
 
 HashTable (Istream &is)
 Construct from Istream. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs) noexcept
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< extendedFeatureEdgeMesh::edgeStatus, label >> list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
bool empty () const noexcept
 True if the hash table is empty. More...
 
label size () const noexcept
 The number of elements in table. More...
 
label capacity () const noexcept
 The size of the underlying table (the number of buckets) More...
 
label & at (const extendedFeatureEdgeMesh::edgeStatus &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const label & at (const extendedFeatureEdgeMesh::edgeStatus &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
bool contains (const extendedFeatureEdgeMesh::edgeStatus &key) const
 True if hashed key is contained (found) in table. More...
 
iterator find (const extendedFeatureEdgeMesh::edgeStatus &key)
 Find and return an iterator set at the hashed entry. More...
 
const_iterator find (const extendedFeatureEdgeMesh::edgeStatus &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const_iterator cfind (const extendedFeatureEdgeMesh::edgeStatus &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const label & lookup (const extendedFeatureEdgeMesh::edgeStatus &key, const label &deflt) const
 Return hashed entry if it exists, or return the given default. More...
 
List< extendedFeatureEdgeMesh::edgeStatustoc () const
 The table of contents (the keys) in unsorted order. More...
 
List< extendedFeatureEdgeMesh::edgeStatussortedToc () const
 The table of contents (the keys) in sorted order. More...
 
List< extendedFeatureEdgeMesh::edgeStatussortedToc (const Compare &comp) const
 The table of contents (the keys) sorted according to the specified comparator. More...
 
Foam::List< extendedFeatureEdgeMesh::edgeStatussortedToc (const Compare &comp) const
 
List< extendedFeatureEdgeMesh::edgeStatustocKeys (const UnaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the unary predicate applied to the keys. More...
 
Foam::List< extendedFeatureEdgeMesh::edgeStatustocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< extendedFeatureEdgeMesh::edgeStatustocValues (const UnaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the unary predicate applied to the values. More...
 
Foam::List< extendedFeatureEdgeMesh::edgeStatustocValues (const UnaryPredicate &pred, const bool invert) const
 
List< extendedFeatureEdgeMesh::edgeStatustocEntries (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. More...
 
Foam::List< extendedFeatureEdgeMesh::edgeStatustocEntries (const BinaryPredicate &pred, const bool invert) const
 
UPtrList< const node_typecsorted () const
 Const access to the hash-table contents in sorted order (sorted by keys). More...
 
UPtrList< node_typesorted ()
 Non-const access to the hash-table contents in sorted order (sorted by keys). More...
 
UPtrList< const node_typesorted () const
 Deprecated(2023-07) use csorted() method. More...
 
label countKeys (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of keys that satisfy the unary predicate. More...
 
Foam::label countKeys (const UnaryPredicate &pred, const bool invert) const
 
label countValues (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of values that satisfy the unary predicate. More...
 
Foam::label countValues (const UnaryPredicate &pred, const bool invert) const
 
label countEntries (const BinaryPredicate &pred, const bool invert=false) const
 Count the number of entries that satisfy the binary predicate. More...
 
Foam::label countEntries (const BinaryPredicate &pred, const bool invert) const
 
bool emplace (const extendedFeatureEdgeMesh::edgeStatus &key, Args &&... args)
 Emplace insert a new entry, not overwriting existing entries. More...
 
bool emplace_set (const extendedFeatureEdgeMesh::edgeStatus &key, Args &&... args)
 Emplace set an entry, overwriting any existing entries. More...
 
bool insert (const extendedFeatureEdgeMesh::edgeStatus &key, const label &obj)
 Copy insert a new entry, not overwriting existing entries. More...
 
bool insert (const extendedFeatureEdgeMesh::edgeStatus &key, label &&obj)
 Move insert a new entry, not overwriting existing entries. More...
 
bool set (const extendedFeatureEdgeMesh::edgeStatus &key, const label &obj)
 Copy assign a new entry, overwriting existing entries. More...
 
bool set (const extendedFeatureEdgeMesh::edgeStatus &key, label &&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 extendedFeatureEdgeMesh::edgeStatus &key)
 Erase an entry specified by the given key. More...
 
label erase (const HashTable< AnyType, extendedFeatureEdgeMesh::edgeStatus, AnyHash > &other)
 Remove table entries given by keys of the other hash-table. More...
 
label erase (std::initializer_list< extendedFeatureEdgeMesh::edgeStatus > keys)
 Remove table entries given by the listed keys. More...
 
label erase (InputIter first, InputIter last)
 Remove multiple entries using an iterator range of keys. More...
 
label erase (const FixedList< extendedFeatureEdgeMesh::edgeStatus, N > &keys)
 Remove table entries given by the listed keys. More...
 
label erase (const UList< extendedFeatureEdgeMesh::edgeStatus > &keys)
 Remove table entries given by the listed keys. More...
 
Foam::label erase (InputIter first, InputIter last)
 
Foam::label erase (const FixedList< extendedFeatureEdgeMesh::edgeStatus, N > &keys)
 
Foam::label erase (const HashTable< AnyType, extendedFeatureEdgeMesh::edgeStatus, AnyHash > &other)
 
label retain (const HashTable< AnyType, extendedFeatureEdgeMesh::edgeStatus, AnyHash > &other)
 Retain table entries given by keys of the other hash-table. More...
 
Foam::label retain (const HashTable< AnyType, extendedFeatureEdgeMesh::edgeStatus, AnyHash > &other)
 
label filterKeys (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their keys. More...
 
Foam::label filterKeys (const UnaryPredicate &pred, const bool pruning)
 
label filterValues (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their values. More...
 
Foam::label filterValues (const UnaryPredicate &pred, const bool pruning)
 
label filterEntries (const BinaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their key/value. More...
 
Foam::label filterEntries (const BinaryPredicate &pred, const bool pruning)
 
void clear ()
 Remove all entries from table. More...
 
void clearStorage ()
 Remove all entries from table and the table itself. More...
 
void setCapacity (label newCapacity)
 Change the hash table capacity (number of buckets). More...
 
void resize (label newCapacity)
 Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...
 
void reserve (label numEntries)
 Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...
 
void swap (HashTable< label, extendedFeatureEdgeMesh::edgeStatus, Hash< label > > &rhs) noexcept
 Swap contents into this table. More...
 
void transfer (HashTable< label, extendedFeatureEdgeMesh::edgeStatus, Hash< label > > &rhs)
 Transfer contents into this table. More...
 
void merge (HashTable< label, extendedFeatureEdgeMesh::edgeStatus, Hash< label > > &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. More...
 
void merge (HashTable< label, extendedFeatureEdgeMesh::edgeStatus, Hash< label > > &&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. More...
 
label & operator[] (const extendedFeatureEdgeMesh::edgeStatus &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const label & operator[] (const extendedFeatureEdgeMesh::edgeStatus &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
label & operator() (const extendedFeatureEdgeMesh::edgeStatus &key)
 Return existing entry or create a new entry. More...
 
label & operator() (const extendedFeatureEdgeMesh::edgeStatus &key, const label &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< extendedFeatureEdgeMesh::edgeStatus, label >> rhs)
 Copy assign from an initializer list. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 
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. More...
 
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
 Write unordered keys (list), with line-breaks when length exceeds shortLen. More...
 
bool found (const extendedFeatureEdgeMesh::edgeStatus &key) const
 Same as contains() More...
 
- Public Member Functions inherited from HashTableCore
 ClassName ("HashTable")
 Declare type-name (with debug switch) More...
 
 HashTableCore () noexcept=default
 Default construct. More...
 

Friends

Ostreamoperator<< (Ostream &os, const pointFeatureEdgesTypes &p)
 

Additional Inherited Members

- Public Types inherited from HashTable< label, extendedFeatureEdgeMesh::edgeStatus, Hash< label > >
typedef HashTable< label, extendedFeatureEdgeMesh::edgeStatus, Hash< label > > this_type
 The template instance used for this HashTable. More...
 
typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< label >::type >::value, Detail::HashTableSingle< extendedFeatureEdgeMesh::edgeStatus >, Detail::HashTablePair< extendedFeatureEdgeMesh::edgeStatus, label > >::type node_type
 A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More...
 
typedef extendedFeatureEdgeMesh::edgeStatus key_type
 The second template parameter, type of keys used. More...
 
typedef label mapped_type
 The first template parameter, type of objects contained. More...
 
typedef label value_type
 Same as mapped_type for OpenFOAM HashTables. More...
 
typedef Hash< label > hasher
 The third template parameter, the hash index method. More...
 
typedef label * pointer
 Pointer type for storing into value_type objects. More...
 
typedef label & reference
 Reference to the stored value_type. More...
 
typedef const label * const_pointer
 Const pointer type for the stored value_type. More...
 
typedef const label & const_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...
 

Detailed Description

Hold the types of feature edges attached to the point.

Holds information on the types of feature edges attached to feature points.

Source files

Definition at line 58 of file pointFeatureEdgesTypes.H.

Constructor & Destructor Documentation

◆ pointFeatureEdgesTypes()

pointFeatureEdgesTypes ( const extendedFeatureEdgeMesh feMesh,
const label  pointLabel 
)

Construct from components.

◆ ~pointFeatureEdgesTypes()

~pointFeatureEdgesTypes ( )
default

Destructor.

Member Function Documentation

◆ calcPointFeatureEdgesTypes()

List<extendedFeatureEdgeMesh::edgeStatus> calcPointFeatureEdgesTypes ( )

Fill the pointFeatureEdgesType class with the types of feature.

edges that are attached to the point.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream os,
const pointFeatureEdgesTypes p 
)
friend

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