Provides a generic associative key-value container. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/core/FlatMap.hpp>

Inherits detail::flat_map::SequentialLookupPolicy< Hash::result_type >.

Public Types
using	key_type = KeyType

using	mapped_type = ValueType

using	size_type = IndexType

using	value_type = KeyValuePair

using	iterator = IteratorImpl< false >

using	const_iterator = IteratorImpl< true >

using	View = FlatMapView< KeyType, ValueType, false, Hash >

using	ConstView = FlatMapView< KeyType, ValueType, true, Hash >

Public Member Functions
	FlatMap (Allocator allocator=Allocator {})
	Constructs a FlatMap with no elements. More...

	FlatMap (IndexType bucket_count, Allocator allocator=Allocator {})
	Constructs a FlatMap with at least a given number of buckets. More...

template<typename InputIt >
	FlatMap (InputIt first, InputIt last, IndexType bucket_count=-1)
	Constructs a FlatMap with a range of elements. More...

	FlatMap (std::initializer_list< value_type > init, IndexType bucket_count=-1)
	Constructs a FlatMap with a range of elements. More...

	FlatMap (FlatMap &&other)
	Move constructor for a FlatMap instance. More...

FlatMap &	operator= (FlatMap &&other)
	Move assignment operator for a FlatMap instance. More...

	FlatMap (const FlatMap &other)
	Copy constructor for a FlatMap instance. More...

FlatMap &	operator= (const FlatMap &other)
	Copy assignment operator for a FlatMap instance. More...

	FlatMap (const FlatMap &other, Allocator allocator)
	Copy constructor for a FlatMap instance with specified allocator. More...

	~FlatMap ()
	Destructor for a FlatMap instance. More...

void	swap (FlatMap &other)
	Swaps the contents of one FlatMap with another. More...

bool	empty () const
	Returns true if there are no entries in the FlatMap, false otherwise. More...

IndexType	size () const
	Returns the number of entries stored in the FlatMap. More...

IndexType	count (const KeyType &key) const
	Return the number of entries matching a given key. More...

bool	contains (const KeyType &key) const
	Return true if the FlatMap contains a key, false otherwise. More...

void	clear ()
	Erases all elements from the FlatMap. More...

template<typename InputIt >
void	insert (InputIt first, InputIt last)
	Inserts a range of key-value pairs into the FlatMap. More...

template<typename ExecSpace , typename InputIt >
void	insert (InputIt first, InputIt last)
	Inserts a range of key-value pairs into the FlatMap. More...

template<typename... Args>
std::pair< iterator, bool >	insert_or_assign (const KeyType &key, Args &&... args)
	Inserts a key-value pair into the FlatMap. More...

template<typename... Args>
std::pair< iterator, bool >	insert_or_assign (KeyType &&key, Args &&... args)

template<typename... Args>
std::pair< iterator, bool >	try_emplace (const KeyType &key, Args &&... args)
	Inserts a key-value pair into the FlatMap. More...

template<typename... Args>
std::pair< iterator, bool >	try_emplace (KeyType &&key, Args &&... args)

iterator	erase (iterator pos)
	Remove a key-value pair from the FlatMap, specified by iterator. More...

iterator	erase (const_iterator pos)

IndexType	erase (const KeyType &key)
	Remove a key-value pair from the FlatMap, specified by key. More...

IndexType	bucket_count () const
	Returns the number of buckets allocated in the FlatMap. More...

double	load_factor () const
	Returns the current load factor of the FlatMap. More...

double	max_load_factor () const
	Returns the maximum load factor of the FlatMap. More...

Allocator	getAllocator () const
	Returns the allocator ID the FlatMap is allocated with. More...

void	rehash (IndexType count)
	Explicitly rehash the FlatMap with a given number of buckets. More...

void	reserve (IndexType count)
	Reallocate and rehash the FlatMap, such that up to the specified number of elements may be inserted without a rehash. More...

View	view ()
	Returns a read-only view of the FlatMap. More...

ConstView	view () const

template<typename ExecSpace >
auto	create (ArrayView< KeyType > keys, ArrayView< ValueType > values, Allocator allocator) -> FlatMap


iterator	begin ()
	Returns an iterator to the first valid object in the bucket array. More...

const_iterator	begin () const

const_iterator	cbegin () const


iterator	end ()
	Returns an iterator to "one past" the last valid object in the bucket array. More...

const_iterator	end () const

const_iterator	cend () const


iterator	find (const KeyType &key)
	Try to find an entry with a given key. More...

const_iterator	find (const KeyType &key) const


ValueType &	at (const KeyType &key)
	Try to find an entry with a given key. More...

const ValueType &	at (const KeyType &key) const


ValueType &	operator[] (const KeyType &key)
	Find an entry with a given key. More...

const ValueType &	operator[] (const KeyType &key) const


std::pair< iterator, bool >	insert (const value_type &value)
	Inserts a key-value pair into the FlatMap. More...

std::pair< iterator, bool >	insert (value_type &&value)

template<typename InputPair >
std::pair< iterator, bool >	insert (InputPair &&pair)

template<typename... InputArgs>
std::pair< iterator, bool >	emplace (InputArgs &&... pair)

Static Public Member Functions
template<typename ExecSpace >
static FlatMap	create (axom::ArrayView< KeyType > keys, axom::ArrayView< ValueType > values, Allocator allocator=Allocator {})
	}@ More...

Friends
template<bool Const>
class	IteratorImpl

class	FlatMapView< KeyType, ValueType, false, Hash >

class	FlatMapView< KeyType, ValueType, true, Hash >

Detailed Description

template<typename KeyType, typename ValueType, typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>
class axom::FlatMap< KeyType, ValueType, Hash >

Provides a generic associative key-value container.

The FlatMap class is a container which maps unique keys to a single value. It supports insertion, removal, and lookup of key-value pairs in amortized constant time.

Note: FlatMap is designed to be a largely drop-in replacement for std::unordered_map. However, FlatMap is internally represented as an open- addressing, quadratic probing hash map; thus, the API differs from unordered_map in certain regards:

Operations which insert a new element may invalidate references and iterators to existing elements in the container, if a resize of the underlying array is triggered.
Methods which only make sense for a closed-addressing hash map, such as begin/end(bucket_index), or bucket(key), are not implemented.

Template Parameters

KeyType	the type of the keys to hold
ValueType	the type of the values to hold
Hash	the hash to use with the key type

Precondition: KeyType must be EqualityComparable; Hash is invocable with an instance of KeyType, and returns an integer value (32- or 64-bit)

Member Typedef Documentation

◆ key_type

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::key_type = KeyType

◆ mapped_type

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::mapped_type = ValueType

◆ size_type

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::size_type = IndexType

◆ value_type

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::value_type = KeyValuePair

◆ iterator

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::iterator = IteratorImpl<false>

◆ const_iterator

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::const_iterator = IteratorImpl<true>

◆ View

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::View = FlatMapView<KeyType, ValueType, false, Hash>

◆ ConstView

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

using axom::FlatMap< KeyType, ValueType, Hash >::ConstView = FlatMapView<KeyType, ValueType, true, Hash>

Constructor & Destructor Documentation

◆ FlatMap() [1/7]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

axom::FlatMap< KeyType, ValueType, Hash >::FlatMap ( Allocator allocator = Allocator {} )

inlineexplicit

Constructs a FlatMap with no elements.

Parameters

[in] allocator memory space to store metadata and key-value pairs

◆ FlatMap() [2/7]

template<typename KeyType , typename ValueType , typename Hash >

axom::FlatMap< KeyType, ValueType, Hash >::FlatMap	(	IndexType	bucket_count,
		Allocator	allocator = `Allocator {}`
	)

Constructs a FlatMap with at least a given number of buckets.

Parameters

[in]	bucket_count	the minimum number of buckets to allocate
[in]	allocator	memory space to store metadata and key-value pairs

References axom::FlatMap< KeyType, ValueType, Hash >::bucket_count(), axom::utilities::ceil(), axom::utilities::countl_zero(), and axom::Allocator::getID().

◆ FlatMap() [3/7]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename InputIt >

axom::FlatMap< KeyType, ValueType, Hash >::FlatMap	(	InputIt	first,
		InputIt	last,
		IndexType	bucket_count = `-1`
	)

inline

Constructs a FlatMap with a range of elements.

Parameters

[in]	first	iterator pointing to the beginning of the range
[in]	last	iterator pointing to the end of the range
[in]	bucket_count	minimum number of buckets to allocate (optional)

◆ FlatMap() [4/7]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

axom::FlatMap< KeyType, ValueType, Hash >::FlatMap	(	std::initializer_list< value_type >	init,
		IndexType	bucket_count = `-1`
	)

inlineexplicit

Constructs a FlatMap with a range of elements.

Parameters

[in]	init	a list of pairs to initialize the map with
[in]	bucket_count	minimum number of buckets to allocate (optional)

◆ FlatMap() [5/7]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

axom::FlatMap< KeyType, ValueType, Hash >::FlatMap ( FlatMap< KeyType, ValueType, Hash > && other )

inline

Move constructor for a FlatMap instance.

Parameters

other the FlatMap to move data from

References axom::FlatMap< KeyType, ValueType, Hash >::swap().

◆ FlatMap() [6/7]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

axom::FlatMap< KeyType, ValueType, Hash >::FlatMap ( const FlatMap< KeyType, ValueType, Hash > & other )

inline

Copy constructor for a FlatMap instance.

Parameters

other the FlatMap to copy data from

Precondition: KeyType must be copy-constructible; ValueType must be copy-constructible

References axom::Array< T, DIM, SPACE, StoragePolicy >::view().

◆ FlatMap() [7/7]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

axom::FlatMap< KeyType, ValueType, Hash >::FlatMap	(	const FlatMap< KeyType, ValueType, Hash > &	other,
		Allocator	allocator
	)

inline

Copy constructor for a FlatMap instance with specified allocator.

Parameters

	other	the FlatMap to copy data from
[in]	allocator	memory space to move data to

Precondition: KeyType must be copy-constructible; ValueType must be copy-constructible

References axom::Array< T, DIM, SPACE, StoragePolicy >::view().

◆ ~FlatMap()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

axom::FlatMap< KeyType, ValueType, Hash >::~FlatMap ( )

inline

Destructor for a FlatMap instance.

References axom::Array< T, DIM, SPACE, StoragePolicy >::view().

Member Function Documentation

◆ operator=() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

FlatMap& axom::FlatMap< KeyType, ValueType, Hash >::operator= ( FlatMap< KeyType, ValueType, Hash > && other )

inline

Move assignment operator for a FlatMap instance.

Parameters

other the FlatMap to move data from

References axom::FlatMap< KeyType, ValueType, Hash >::swap().

◆ operator=() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

FlatMap& axom::FlatMap< KeyType, ValueType, Hash >::operator= ( const FlatMap< KeyType, ValueType, Hash > & other )

inline

Copy assignment operator for a FlatMap instance.

Parameters

other the FlatMap to copy data from

Precondition: KeyType must be copy-constructible; ValueType must be copy-constructible

References axom::FlatMap< KeyType, ValueType, Hash >::swap().

◆ swap()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

void axom::FlatMap< KeyType, ValueType, Hash >::swap ( FlatMap< KeyType, ValueType, Hash > & other )

inline

Swaps the contents of one FlatMap with another.

References axom::Array< T, DIM, SPACE, StoragePolicy >::swap(), and axom::utilities::swap().

◆ begin() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

iterator axom::FlatMap< KeyType, ValueType, Hash >::begin ( )

inline

Returns an iterator to the first valid object in the bucket array.

◆ begin() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

const_iterator axom::FlatMap< KeyType, ValueType, Hash >::begin ( ) const

inline

◆ cbegin()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

const_iterator axom::FlatMap< KeyType, ValueType, Hash >::cbegin ( ) const

inline

◆ end() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

iterator axom::FlatMap< KeyType, ValueType, Hash >::end ( )

inline

Returns an iterator to "one past" the last valid object in the bucket array.

References axom::FlatMap< KeyType, ValueType, Hash >::bucket_count().

◆ end() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

const_iterator axom::FlatMap< KeyType, ValueType, Hash >::end ( ) const

inline

References axom::FlatMap< KeyType, ValueType, Hash >::bucket_count().

◆ cend()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

const_iterator axom::FlatMap< KeyType, ValueType, Hash >::cend ( ) const

inline

References axom::FlatMap< KeyType, ValueType, Hash >::bucket_count().

◆ empty()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

bool axom::FlatMap< KeyType, ValueType, Hash >::empty ( ) const

inline

Returns true if there are no entries in the FlatMap, false otherwise.

◆ size()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

IndexType axom::FlatMap< KeyType, ValueType, Hash >::size ( ) const

inline

Returns the number of entries stored in the FlatMap.

◆ find() [1/2]

template<typename KeyType , typename ValueType , typename Hash >

auto axom::FlatMap< KeyType, ValueType, Hash >::find ( const KeyType & key )

Try to find an entry with a given key.

Parameters

[in] key the key to search for

Returns: An iterator pointing to the corresponding key-value pair, or end() if the key wasn't found.

References axom::utilities::annotations::end().

◆ find() [2/2]

template<typename KeyType , typename ValueType , typename Hash >

auto axom::FlatMap< KeyType, ValueType, Hash >::find ( const KeyType & key ) const

References axom::utilities::annotations::end().

◆ at() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

ValueType& axom::FlatMap< KeyType, ValueType, Hash >::at ( const KeyType & key )

inline

Try to find an entry with a given key.

Parameters

[in] key the key to search for

Returns: A reference to the corresponding value.

Exceptions

std::out_of_range if the key is not found.

References axom::FlatMap< KeyType, ValueType, Hash >::end(), and axom::FlatMap< KeyType, ValueType, Hash >::find().

◆ at() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

const ValueType& axom::FlatMap< KeyType, ValueType, Hash >::at ( const KeyType & key ) const

inline

References axom::FlatMap< KeyType, ValueType, Hash >::end(), and axom::FlatMap< KeyType, ValueType, Hash >::find().

◆ operator[]() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

ValueType& axom::FlatMap< KeyType, ValueType, Hash >::operator[] ( const KeyType & key )

inline

Find an entry with a given key.

If a corresponding value does not exist, a default value for the value type will be inserted for the given key.

Parameters

[in] key the key to search for

Returns: A reference to the corresponding value.

Precondition: ValueType is default-constructible

References axom::FlatMap< KeyType, ValueType, Hash >::try_emplace().

◆ operator[]() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

const ValueType& axom::FlatMap< KeyType, ValueType, Hash >::operator[] ( const KeyType & key ) const

inline

References axom::FlatMap< KeyType, ValueType, Hash >::try_emplace().

◆ count()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

IndexType axom::FlatMap< KeyType, ValueType, Hash >::count ( const KeyType & key ) const

inline

Return the number of entries matching a given key.

This method will always return 0 or 1.

Parameters

[in] key the key to search for

References axom::FlatMap< KeyType, ValueType, Hash >::contains().

◆ contains()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

bool axom::FlatMap< KeyType, ValueType, Hash >::contains ( const KeyType & key ) const

inline

Return true if the FlatMap contains a key, false otherwise.

Parameters

[in] key the key to search for

References axom::FlatMap< KeyType, ValueType, Hash >::end(), and axom::FlatMap< KeyType, ValueType, Hash >::find().

◆ clear()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

void axom::FlatMap< KeyType, ValueType, Hash >::clear ( )

inline

Erases all elements from the FlatMap.

References axom::Array< T, DIM, SPACE, StoragePolicy >::clear(), axom::Array< T, DIM, SPACE, StoragePolicy >::resize(), and axom::Array< T, DIM, SPACE, StoragePolicy >::view().

◆ insert() [1/5]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::insert ( const value_type & value )

inline

Inserts a key-value pair into the FlatMap.

If the key already exists in the FlatMap, insertion is skipped. Otherwise, the key-value mapping is inserted into the FlatMap.

Parameters

[in] value the key-value pair to insert

Returns

A pair consisting of:

an iterator pointing to either the existing key-value pair, or the newly-inserted pair
true if a new pair was inserted, false otherwise

◆ insert() [2/5]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::insert ( value_type && value )

inline

◆ insert() [3/5]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename InputPair >

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::insert ( InputPair && pair )

inline

References axom::FlatMap< KeyType, ValueType, Hash >::emplace().

◆ emplace()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename... InputArgs>

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::emplace ( InputArgs &&... pair )

inline

◆ insert() [4/5]

template<typename KeyType , typename ValueType , typename Hash >

template<typename InputIt >

void axom::FlatMap< KeyType, ValueType, Hash >::insert	(	InputIt	first,
		InputIt	last
	)

Inserts a range of key-value pairs into the FlatMap.

If a key in the range already exists, assigns the value to the existing key in the FlatMap. Otherwise, a new key-value pair is inserted into the FlatMap.

Parameters

[in]	first	the beginning of the range of pairs
[in]	last	the end of the range of pairs

Note: If duplicate keys are present in the range, the key which appears later in the range is updated or inserted. This is equivalent to a sequential for-loop of insertions over the input range.

◆ insert() [5/5]

template<typename KeyType , typename ValueType , typename Hash >

template<typename ExecSpace , typename InputIt >

void axom::FlatMap< KeyType, ValueType, Hash >::insert	(	InputIt	first,
		InputIt	last
	)

Inserts a range of key-value pairs into the FlatMap.

If a key in the range already exists, assigns the value to the existing key in the FlatMap. Otherwise, a new key-value pair is inserted into the FlatMap.

Parameters

[in]	first	the beginning of the range of pairs
[in]	last	the end of the range of pairs

Template Parameters

ExecSpace the execution space in which to perform the batched construction

Precondition: InputIt is a random-access iterator; allocator is accessible from ExecSpace

Note: If duplicate keys are present in the range, the key which appears later in the range is updated or inserted. This is equivalent to a sequential for-loop of insertions over the input range.

References AXOM_LAMBDA, axom::slam::util::distance(), axom::serial::reductions::ReduceSum< ExecSpace, T >::get(), axom::Array< T, DIM, SPACE, StoragePolicy >::resize(), and axom::Array< T, DIM, SPACE, StoragePolicy >::view().

◆ insert_or_assign() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename... Args>

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::insert_or_assign	(	const KeyType &	key,
		Args &&...	args
	)

inline

Inserts a key-value pair into the FlatMap.

If the key already exists, assigns the value to the existing key in the FlatMap.

Parameters

[in]	key	the key to insert or assign
[in]	args	arguments to construct the value with

Returns

A pair consisting of:

an iterator pointing to either the existing key-value pair, or the newly-inserted pair
true if a new pair was inserted, false otherwise {@

◆ insert_or_assign() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename... Args>

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::insert_or_assign	(	KeyType &&	key,
		Args &&...	args
	)

inline

◆ try_emplace() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename... Args>

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::try_emplace	(	const KeyType &	key,
		Args &&...	args
	)

inline

Inserts a key-value pair into the FlatMap.

If the key already exists in the FlatMap, insertion is skipped. Otherwise, the key-value mapping is inserted into the FlatMap.

Compared to emplace(), this method only moves-from the value arguments if the key does not exist; otherwise, the input arguments are left as-is.

Parameters

[in]	key	the key to insert or assign
[in]	args	arguments to construct the value with.

Returns

A pair consisting of:

an iterator pointing to either the existing key-value pair, or the newly-inserted pair
true if a new pair was inserted, false otherwise {@

◆ try_emplace() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename... Args>

std::pair<iterator, bool> axom::FlatMap< KeyType, ValueType, Hash >::try_emplace	(	KeyType &&	key,
		Args &&...	args
	)

inline

◆ erase() [1/3]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

iterator axom::FlatMap< KeyType, ValueType, Hash >::erase ( iterator pos )

inline

Remove a key-value pair from the FlatMap, specified by iterator.

Parameters

pos	the iterator pointing to the key-value pair to remove

Returns: an iterator to the next valid entry after the removed entry {@

References axom::FlatMap< KeyType, ValueType, Hash >::erase().

◆ erase() [2/3]

template<typename KeyType , typename ValueType , typename Hash >

auto axom::FlatMap< KeyType, ValueType, Hash >::erase ( const_iterator pos )

References axom::utilities::annotations::end().

◆ erase() [3/3]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

IndexType axom::FlatMap< KeyType, ValueType, Hash >::erase ( const KeyType & key )

inline

Remove a key-value pair from the FlatMap, specified by key.

If the key doesn't exist in the FlatMap, does nothing.

Parameters

key	the key to remove

Returns: 1 if an entry was removed, 0 otherwise

References axom::FlatMap< KeyType, ValueType, Hash >::end(), axom::FlatMap< KeyType, ValueType, Hash >::erase(), and axom::FlatMap< KeyType, ValueType, Hash >::find().

◆ bucket_count()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

IndexType axom::FlatMap< KeyType, ValueType, Hash >::bucket_count ( ) const

inline

Returns the number of buckets allocated in the FlatMap.

The maximum number of elements that can be stored in the FlatMap without resizing and rehashing is bucket_count() * max_load_factor().

References axom::Array< T, DIM, SPACE, StoragePolicy >::size().

◆ load_factor()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

double axom::FlatMap< KeyType, ValueType, Hash >::load_factor ( ) const

inline

Returns the current load factor of the FlatMap.

References axom::FlatMap< KeyType, ValueType, Hash >::bucket_count().

◆ max_load_factor()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

double axom::FlatMap< KeyType, ValueType, Hash >::max_load_factor ( ) const

inline

Returns the maximum load factor of the FlatMap.

◆ getAllocator()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

Allocator axom::FlatMap< KeyType, ValueType, Hash >::getAllocator ( ) const

inline

Returns the allocator ID the FlatMap is allocated with.

◆ rehash()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

void axom::FlatMap< KeyType, ValueType, Hash >::rehash ( IndexType count )

inline

Explicitly rehash the FlatMap with a given number of buckets.

Parameters

count the minimum number of buckets to allocate for the rehash

References axom::FlatMap< KeyType, ValueType, Hash >::begin(), axom::FlatMap< KeyType, ValueType, Hash >::count(), axom::FlatMap< KeyType, ValueType, Hash >::end(), axom::detail::getAllocatorSpace(), axom::Allocator::getID(), and axom::FlatMap< KeyType, ValueType, Hash >::swap().

◆ reserve()

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

void axom::FlatMap< KeyType, ValueType, Hash >::reserve ( IndexType count )

inline

Reallocate and rehash the FlatMap, such that up to the specified number of elements may be inserted without a rehash.

Parameters

count the number of elements to fit without a rehash

References axom::FlatMap< KeyType, ValueType, Hash >::bucket_count(), axom::FlatMap< KeyType, ValueType, Hash >::count(), axom::FlatMap< KeyType, ValueType, Hash >::max_load_factor(), and axom::FlatMap< KeyType, ValueType, Hash >::rehash().

◆ view() [1/2]

template<typename KeyType , typename ValueType , typename Hash >

auto axom::FlatMap< KeyType, ValueType, Hash >::view

Returns a read-only view of the FlatMap.

See also: FlatMapView {@

◆ view() [2/2]

template<typename KeyType , typename ValueType , typename Hash >

auto axom::FlatMap< KeyType, ValueType, Hash >::view

◆ create() [1/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename ExecSpace >

static FlatMap axom::FlatMap< KeyType, ValueType, Hash >::create	(	axom::ArrayView< KeyType >	keys,
		axom::ArrayView< ValueType >	values,
		Allocator	allocator = `Allocator {}`
	)

static

}@

Constructs and returns a FlatMap given a set of key-value pairs.

Duplicate keys are handled by selecting the last value in the values array corresponding to the equivalent key.

Parameters

keys	[in] array of keys for the pairs to insert
values	[in] array of values for the pairs to insert
allocator	[in] allocator to use for the constructed FlatMap

Template Parameters

ExecSpace the execution space in which to perform the batched construction

Returns: the constructed FlatMap

Precondition: keys.size() == values.size(); {keys, values}.getAllocatorID() is accessible from ExecSpace; allocator is accessible from ExecSpace

◆ create() [2/2]

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<typename ExecSpace >

auto axom::FlatMap< KeyType, ValueType, Hash >::create	(	ArrayView< KeyType >	keys,
		ArrayView< ValueType >	values,
		Allocator	allocator
	)		-> FlatMap

References axom::FlatMap< KeyType, ValueType, Hash >::insert().

Friends And Related Function Documentation

◆ IteratorImpl

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

template<bool Const>

friend class IteratorImpl

friend

◆ FlatMapView< KeyType, ValueType, false, Hash >

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

friend class FlatMapView< KeyType, ValueType, false, Hash >

friend

◆ FlatMapView< KeyType, ValueType, true, Hash >

template<typename KeyType , typename ValueType , typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>

friend class FlatMapView< KeyType, ValueType, true, Hash >

friend

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/core/FlatMap.hpp
/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/core/FlatMapUtil.hpp
/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/core/FlatMapView.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<typename KeyType, typename ValueType, typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>> class axom::FlatMap< KeyType, ValueType, Hash >

Member Typedef Documentation

◆ key_type

◆ mapped_type

◆ size_type

◆ value_type

◆ iterator

◆ const_iterator

◆ View

◆ ConstView

Constructor & Destructor Documentation

◆ FlatMap() [1/7]

◆ FlatMap() [2/7]

◆ FlatMap() [3/7]

◆ FlatMap() [4/7]

◆ FlatMap() [5/7]

◆ FlatMap() [6/7]

◆ FlatMap() [7/7]

◆ ~FlatMap()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ swap()

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ end() [1/2]

◆ end() [2/2]

◆ cend()

◆ empty()

◆ size()

◆ find() [1/2]

◆ find() [2/2]

◆ at() [1/2]

◆ at() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ count()

◆ contains()

◆ clear()

◆ insert() [1/5]

◆ insert() [2/5]

◆ insert() [3/5]

◆ emplace()

◆ insert() [4/5]

◆ insert() [5/5]

◆ insert_or_assign() [1/2]

◆ insert_or_assign() [2/2]

◆ try_emplace() [1/2]

◆ try_emplace() [2/2]

◆ erase() [1/3]

◆ erase() [2/3]

◆ erase() [3/3]

◆ bucket_count()

◆ load_factor()

◆ max_load_factor()

◆ getAllocator()

◆ rehash()

◆ reserve()

◆ view() [1/2]

◆ view() [2/2]

◆ create() [1/2]

◆ create() [2/2]

Friends And Related Function Documentation

◆ IteratorImpl

◆ FlatMapView< KeyType, ValueType, false, Hash >

◆ FlatMapView< KeyType, ValueType, true, Hash >

template<typename KeyType, typename ValueType, typename Hash = detail::flat_map::HashMixer64<KeyType, DeviceHash>>
class axom::FlatMap< KeyType, ValueType, Hash >