axom::bump::MapBasedNaming< IndexT, MAXIDS > Class Template Reference

This class implements a naming policy that uses a map to keep track of naming groups of ids. It is NOT parallel or device-enabled. It can be used for serial cases or serial debugging. More...

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

Classes
class	View
	A view for making names. More...

Public Types
using	KeyType = std::uint64_t
using	IndexType = IndexT

Public Member Functions
KeyType	makeName (const IndexType *p, int n) const
	Make a name from the array of ids. More...
void	setMaxId (IndexType n)
	Set the max number of nodes, which can help with id packing/narrowing. More...
View	view ()
	Return a view that can be used on device. More...

Static Public Member Functions
static std::string	toString (KeyType key)
	Turn name into a string. More...

Public Attributes
View	m_view {}
MapType	m_map

Detailed Description

template<typename IndexT, int MAXIDS = 14>
class axom::bump::MapBasedNaming< IndexT, MAXIDS >

This class implements a naming policy that uses a map to keep track of naming groups of ids. It is NOT parallel or device-enabled. It can be used for serial cases or serial debugging.

Template Parameters

IndexT	The index type that gets hashed.
MAXIDS	The max number of ids that get hashed.

Member Typedef Documentation

KeyType

template<typename IndexT , int MAXIDS = 14>

using axom::bump::MapBasedNaming< IndexT, MAXIDS >::KeyType = std::uint64_t

IndexType

template<typename IndexT , int MAXIDS = 14>

using axom::bump::MapBasedNaming< IndexT, MAXIDS >::IndexType = IndexT

Member Function Documentation

makeName()

template<typename IndexT , int MAXIDS = 14>

KeyType axom::bump::MapBasedNaming< IndexT, MAXIDS >::makeName ( const IndexType *  p, int  n  ) const

inline

Make a name from the array of ids.

References axom::bump::MapBasedNaming< IndexT, MAXIDS >::m_view, and axom::bump::MapBasedNaming< IndexT, MAXIDS >::View::makeName().

setMaxId()

template<typename IndexT , int MAXIDS = 14>

void axom::bump::MapBasedNaming< IndexT, MAXIDS >::setMaxId ( IndexType  n )

inline

Set the max number of nodes, which can help with id packing/narrowing.

Parameters

n	The number of nodes.

References axom::bump::MapBasedNaming< IndexT, MAXIDS >::m_view, and axom::bump::MapBasedNaming< IndexT, MAXIDS >::View::setMaxId().

view()

template<typename IndexT , int MAXIDS = 14>

View axom::bump::MapBasedNaming< IndexT, MAXIDS >::view ( )

inline

Return a view that can be used on device.

References axom::bump::MapBasedNaming< IndexT, MAXIDS >::m_map, axom::bump::MapBasedNaming< IndexT, MAXIDS >::View::m_map_ptr, and axom::bump::MapBasedNaming< IndexT, MAXIDS >::m_view.

toString()

template<typename IndexT , int MAXIDS = 14>

static std::string axom::bump::MapBasedNaming< IndexT, MAXIDS >::toString ( KeyType  key )

inlinestatic

Turn name into a string.

Parameters

key

The name.

Returns

A string that represents the name.

Member Data Documentation

m_view

template<typename IndexT , int MAXIDS = 14>

View axom::bump::MapBasedNaming< IndexT, MAXIDS >::m_view {}

m_map

template<typename IndexT , int MAXIDS = 14>

MapType axom::bump::MapBasedNaming< IndexT, MAXIDS >::m_map

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/bump/MapBasedNaming.hpp