Namespaces
	policies

	traits

	util

Classes
class	BitSet
	A bitset class. More...

class	BivariateMap
	A Map for BivariateSet. It associates a constant number of values to every element in a BivariateSet (as determined by StridePolicy). More...

class	BivariateSetIterator
	Implements a forward iterator concept on a BivariateSet type. More...

class	BivariateSet
	Abstract class that models a set whose elements are indexed by two indices. Each element in a BivariateSet is equivalent to an ordered pair containing a row and column index, similar to indexing in a matrix. More...

class	NullBivariateSet
	A Null BivariateSet class. Same as the NullSet for Set class. More...

class	DynamicConstantRelation
	A relation class with constant cardinality that supports adding, removing and modifying set relations. More...

class	DynamicMap
	A slam map class that supports adding and removing entries. More...

class	DynamicSet
	A Set class that supports dynamically adding and removing set items. More...

class	DynamicVariableRelation

class	FieldRegistry
	Simple container for fields of type DataType w/ minimal error checking. More...

class	Map
	A Map class that associates a constant number of values to every element in a set. More...

class	MapBase
	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...

class	ModularInt
	This class is a wrapper around an int and encapsulates modular arithmetic with a given modulus. More...

class	NullSet
	An indexed set (a tuple) of entities in a simulation. More...

class	OrderedSet
	Models a set whose elements can be defined as strided offsets of the position, possibly with a level of indirection. More...

class	ProductSet
	Models a set whose element is the Cartesian product of two sets. The number of elements in this set is the product of the sizes of the two input sets. More...

class	GenericRangeSet
	Models a set whose elements belong to a contiguous range \( \in [lowerIndex,upperIndex) \). More...

class	Relation

class	RelationSet
	Models a Set whose elements are derived from a relation, one element per fromSet and toSet pair in the relation. More...

class	Set
	Abstract base class for a Set of entities in a simulation. More...

class	StaticRelation

class	SubMap
	The SubMap class provides an API to easily traverse a subset of a Map. More...

class	NotImplementedException

Typedefs
template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>
using	CArrayIndirectionSet = OrderedSet< PosType, ElemType, policies::RuntimeSize< PosType >, policies::ZeroOffset< PosType >, policies::StrideOne< PosType >, policies::CArrayIndirection< PosType, ElemType > >
	Alias template for an OrderedSet with indirection over a C array. More...

template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>
using	VectorIndirectionSet = OrderedSet< PosType, ElemType, policies::RuntimeSize< PosType >, policies::ZeroOffset< PosType >, policies::StrideOne< PosType >, policies::STLVectorIndirection< PosType, ElemType > >
	Alias template for an OrderedSet with indirection over an stl vector. More...

template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>
using	ArrayIndirectionSet = OrderedSet< PosType, ElemType, policies::RuntimeSize< PosType >, policies::ZeroOffset< PosType >, policies::StrideOne< PosType >, policies::ArrayIndirection< PosType, ElemType > >
	Alias template for an OrderedSet with indirection over an axom::Array. More...

template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>
using	ArrayViewIndirectionSet = OrderedSet< PosType, ElemType, policies::RuntimeSize< PosType >, policies::ZeroOffset< PosType >, policies::StrideOne< PosType >, policies::ArrayViewIndirection< PosType, ElemType > >
	Alias template for an OrderedSet with indirection over an axom::ArrayView. More...

template<typename P = slam::DefaultPositionType, typename E = slam::DefaultElementType>
using	PositionSet = GenericRangeSet< P, E, policies::ZeroOffset< P > >

template<typename P = slam::DefaultPositionType, typename E = slam::DefaultElementType>
using	RangeSet = GenericRangeSet< P, E >

using	DefaultPositionType = axom::IndexType

using	DefaultElementType = axom::IndexType

Functions
BitSet	operator\| (const BitSet &lhs, const BitSet &rhs)
	Union operator for two bit sets. More...

BitSet	operator& (const BitSet &lhs, const BitSet &rhs)
	Intersection operator for two bit sets. More...

BitSet	operator^ (const BitSet &lhs, const BitSet &rhs)
	Exclusive or (xor) operator for two bit sets. More...

BitSet	operator- (const BitSet &lhs, const BitSet &rhs)
	Set difference operator for two bit sets. More...

template<typename SizePolicy >
ModularInt< SizePolicy >	operator+ (const ModularInt< SizePolicy > &zn, const int n)

template<typename SizePolicy >
ModularInt< SizePolicy >	operator+ (const int n, const ModularInt< SizePolicy > &zn)

template<typename SizePolicy >
ModularInt< SizePolicy >	operator- (const ModularInt< SizePolicy > &zn, const int n)

template<typename SizePolicy >
ModularInt< SizePolicy >	operator- (const int n, const ModularInt< SizePolicy > &zn)

template<typename SizePolicy >
ModularInt< SizePolicy >	operator* (const ModularInt< SizePolicy > &zn, const int n)

template<typename SizePolicy >
ModularInt< SizePolicy >	operator* (const int n, const ModularInt< SizePolicy > &zn)

template<typename P1 , typename E1 , typename P2 , typename E2 >
bool	operator== (const Set< P1, E1 > &set1, const Set< P2, E2 > &set2)
	General equality operator for two sets. More...

template<typename P1 , typename E1 , typename P2 , typename E2 >
bool	operator!= (const Set< P1, E1 > &set1, const Set< P2, E2 > &set2)
	Set inequality operator. More...

Typedef Documentation

◆ CArrayIndirectionSet

template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>

using axom::slam::CArrayIndirectionSet = typedef OrderedSet<PosType, ElemType, policies::RuntimeSize<PosType>, policies::ZeroOffset<PosType>, policies::StrideOne<PosType>, policies::CArrayIndirection<PosType, ElemType> >

Alias template for an OrderedSet with indirection over a C array.

Template Parameters

PosType	The position type for indexing into the set
ElemType	The type for the set's elements

See also: OrderedSet

◆ VectorIndirectionSet

template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>

using axom::slam::VectorIndirectionSet = typedef OrderedSet<PosType, ElemType, policies::RuntimeSize<PosType>, policies::ZeroOffset<PosType>, policies::StrideOne<PosType>, policies::STLVectorIndirection<PosType, ElemType> >

Alias template for an OrderedSet with indirection over an stl vector.

Template Parameters

PosType	The position type for indexing into the set
ElemType	The type for the set's elements

See also: OrderedSet

◆ ArrayIndirectionSet

template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>

using axom::slam::ArrayIndirectionSet = typedef OrderedSet<PosType, ElemType, policies::RuntimeSize<PosType>, policies::ZeroOffset<PosType>, policies::StrideOne<PosType>, policies::ArrayIndirection<PosType, ElemType> >

Alias template for an OrderedSet with indirection over an axom::Array.

Template Parameters

PosType	The position type for indexing into the set
ElemType	The type for the set's elements

See also: OrderedSet

◆ ArrayViewIndirectionSet

template<typename PosType = slam::DefaultPositionType, typename ElemType = slam::DefaultElementType>

using axom::slam::ArrayViewIndirectionSet = typedef OrderedSet<PosType, ElemType, policies::RuntimeSize<PosType>, policies::ZeroOffset<PosType>, policies::StrideOne<PosType>, policies::ArrayViewIndirection<PosType, ElemType> >

Alias template for an OrderedSet with indirection over an axom::ArrayView.

Template Parameters

PosType	The position type for indexing into the set
ElemType	The type for the set's elements

See also: OrderedSet

◆ PositionSet

template<typename P = slam::DefaultPositionType, typename E = slam::DefaultElementType>

using axom::slam::PositionSet = typedef GenericRangeSet<P, E, policies::ZeroOffset<P> >

◆ RangeSet

template<typename P = slam::DefaultPositionType, typename E = slam::DefaultElementType>

using axom::slam::RangeSet = typedef GenericRangeSet<P, E>

◆ DefaultPositionType

using axom::slam::DefaultPositionType = typedef axom::IndexType

◆ DefaultElementType

using axom::slam::DefaultElementType = typedef axom::IndexType

Function Documentation

◆ operator|()

BitSet axom::slam::operator\|	(	const BitSet &	lhs,
		const BitSet &	rhs
	)

Union operator for two bit sets.

Parameters

lhs	The first bitset
rhs	The second bitset

Returns: The union of the two input bitsets, where the i^th bit is set it is set in either lhs or rhs (e.g. b[i] = lhs[i] || rhs[i]).

Precondition: lhs.size() == rhs.size()

◆ operator&()

BitSet axom::slam::operator&	(	const BitSet &	lhs,
		const BitSet &	rhs
	)

Intersection operator for two bit sets.

Parameters

lhs	The first bitset
rhs	The second bitset

Returns: The intersection of the two input bitsets, where the i^th bit is set it is set in both lhs and rhs (e.g. b[i] = lhs[i] && rhs[i]).

Precondition: lhs.size() == rhs.size()

◆ operator^()

BitSet axom::slam::operator^	(	const BitSet &	lhs,
		const BitSet &	rhs
	)

Exclusive or (xor) operator for two bit sets.

Parameters

lhs	The first bitset
rhs	The second bitset

Returns: The xor of the two input bitsets, where the i^th bit is set it is set in either lhs or rhs but not both (e.g. b[i] = lhs[i] ^ rhs[i]).

Precondition: lhs.size() == rhs.size()

◆ operator-() [1/3]

BitSet axom::slam::operator-	(	const BitSet &	lhs,
		const BitSet &	rhs
	)

Set difference operator for two bit sets.

Parameters

lhs	The first bitset
rhs	The second bitset

Returns: The set difference of the two input bitsets, where the i^th bit is set it is set in lhs and not rhs (e.g. b[i] = lhs[i] && ! rhs[i]).

Precondition: lhs.size() == rhs.size()