AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::slam::MapBase< SetPositionType > Class Template Referenceabstract

A base class specifying methods that support operations of a Map, associating value(s) to each element in a Set. MapBase can be used as a base class pointer to a templated Map object. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/slam/MapBase.hpp>

Public Types

using SetPosition = SetPositionType
 

Public Member Functions

virtual ~MapBase ()
 
virtual AXOM_HOST_DEVICE SetPosition size () const =0
 Get the number of entities in the set used by this map. More...
 
virtual bool isValid (bool verboseOutput) const =0
 Checks whether the Map is valid. More...
 

Detailed Description

template<typename SetPositionType = slam::DefaultPositionType>
class axom::slam::MapBase< SetPositionType >

A base class specifying methods that support operations of a Map, associating value(s) to each element in a Set. MapBase can be used as a base class pointer to a templated Map object.

See also
Map

Member Typedef Documentation

◆ SetPosition

template<typename SetPositionType = slam::DefaultPositionType>
using axom::slam::MapBase< SetPositionType >::SetPosition = SetPositionType

Constructor & Destructor Documentation

◆ ~MapBase()

template<typename SetPositionType = slam::DefaultPositionType>
virtual axom::slam::MapBase< SetPositionType >::~MapBase ( )
inlinevirtual

Member Function Documentation

◆ size()

template<typename SetPositionType = slam::DefaultPositionType>
virtual AXOM_HOST_DEVICE SetPosition axom::slam::MapBase< SetPositionType >::size ( ) const
pure virtual

Get the number of entities in the set used by this map.

Returns
The number of entities in the set used in the map.

◆ isValid()

template<typename SetPositionType = slam::DefaultPositionType>
virtual bool axom::slam::MapBase< SetPositionType >::isValid ( bool  verboseOutput) const
pure virtual

Checks whether the Map is valid.

Returns
True if valid, false otherwise.

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