SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
DirectionalIdMap< Dim, T > Class Template Reference

An optimized map with DirectionalId keys. More...

#include <DirectionalIdMap.hpp>

Public Types

using base
Public Types inherited from FixedHashMap< maximum_number_of_neighbors(Dim), DirectionalId< Dim >, T >
using key_type
using mapped_type
using value_type
using size_type
using difference_type
using hasher
using key_equal
using reference
using const_reference
using pointer
using const_pointer
using iterator
using const_iterator

Additional Inherited Members

Public Member Functions inherited from FixedHashMap< maximum_number_of_neighbors(Dim), DirectionalId< Dim >, T >
 FixedHashMap (std::initializer_list< value_type > init)
 FixedHashMap (const FixedHashMap &)=default
FixedHashMapoperator= (const FixedHashMap &other)
 FixedHashMap (FixedHashMap &&)=default
FixedHashMapoperator= (FixedHashMap &&other)
iterator begin ()
const_iterator begin () const
const_iterator cbegin () const
iterator end ()
const_iterator end () const
const_iterator cend () const
bool empty () const
size_t size () const
void clear ()
iterator erase (const const_iterator &pos)
size_t erase (const key_type &key)
mapped_type & at (const key_type &key)
const mapped_type & at (const key_type &key) const
mapped_type & operator[] (const key_type &key)
size_t count (const key_type &key) const
iterator find (const key_type &key)
const_iterator find (const key_type &key) const
bool contains (const key_type &key) const
 Check if key is in the map.
key_equal key_eq () const
 Get key equal function object.
hasher hash_function () const
 Get hash function object.
void pup (PUP::er &p)
auto insert_or_assign_impl (key_type &&key, M &&obj) -> std::pair< iterator, bool >
auto get_data_entry (const DirectionalId< Dim > &key) -> typename storage_type::iterator
std::pair< iterator, bool > insert (const value_type &value)
 Inserts the element if it does not exists.
std::pair< iterator, bool > insert (value_type &&value)
 Inserts the element if it does not exists.
std::pair< iterator, bool > emplace (Args &&... args)
 Inserts the element if it does not exists.
std::pair< iterator, bool > insert_or_assign (const key_type &key, M &&obj)
 Inserts the element if it does not exists, otherwise assigns to it the new value.
std::pair< iterator, bool > insert_or_assign (key_type &&key, M &&obj)
 Inserts the element if it does not exists, otherwise assigns to it the new value.

Detailed Description

template<size_t Dim, typename T>
class DirectionalIdMap< Dim, T >

An optimized map with DirectionalId keys.

Member Typedef Documentation

◆ base

template<size_t Dim, typename T>
using DirectionalIdMap< Dim, T >::base
Initial value:
constexpr size_t maximum_number_of_neighbors(const size_t dim)
Returns the maximum number of neighbors an element can have in dim dimensions.
Definition MaxNumberOfNeighbors.hpp:15
The ElementId of an Element in a given Direction.
Definition DirectionalId.hpp:22

The documentation for this class was generated from the following file:
  • src/Domain/Structure/DirectionalIdMap.hpp