Alias template for an OrderedSet whose elements belong to a contiguous range \( \in [0,size) \). More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/slam/RangeSet.hpp>

Inheritance diagram for axom::slam::PositionSet< P, E >:

[legend]

Public Types
using	PositionType = P

using	ElementType = E

using	SizePolicyType = policies::RuntimeSize< P >

using	OffsetPolicyType = policies::ZeroOffset< P >

using	StridePolicyType = policies::StrideOne< P >

using	IndirectionPolicyType = policies::NoIndirection< P, E >

using	SubsettingPolicyType = policies::NoSubset

using	ModularIntType = ModularInt< policies::RuntimeSize< P > >

using	PositionSet = OrderedSet< PositionType >

using	const_iterator = OrderedSetIterator< ElementType, true >

using	const_iterator_pair = std::pair< const_iterator, const_iterator >

using	iterator = OrderedSetIterator< ElementType, false >

using	iterator_pair = std::pair< iterator, iterator >

using	IndirectionResult = E

using	ConstIndirectionResult = const E

using	IndirectionBufferType = struct { }

using	ParentSetType = const Set<>

Public Member Functions
	PositionSet (PositionType size=DEFAULT_SIZE)

	PositionSet (const typename OrderedSetType::SetBuilder &builder)

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

iterator_pair	range ()

const_iterator_pair	range () const

policies::NoIndirection< P, E > ::ConstIndirectionResult	operator[] (PositionType pos) const
	Given a position in the Set, return a position in the larger index space. More...

policies::NoIndirection< P, E > ::IndirectionResult	operator[] (PositionType pos)

ElementType	at (PositionType pos) const
	Random access to the entities of the set. More...

PositionType	size () const
	Get the number of entities in the set. More...

P &	size ()

bool	empty () const
	Checks if there are any elements in the set – equivalent to: set.size() == 0. More...

bool	isValid (bool verboseOutput=false) const
	Checks whether the set is valid. More...

bool	isValid (P, P, P, bool) const

template<typename OrderedSetIt >
bool	isValid (OrderedSetIt, OrderedSetIt, bool) const

bool	isSubset () const
	Determines if the Set is a Subset of another set. More...

bool	isValidIndex (PositionType pos) const
	checks whether the given position (index) is valid. More...

PositionSet	positions () const
	returns a PositionSet over the set's positions More...

P	operator() () const

P &	operator() ()

P	operator() () const

const P	operator() () const

IndirectionResult	operator() (P pos) const

P	offset () const

const P	stride () const

void	setStride (P AXOM_DEBUG_PARAM(val))

IndirectionResult	indirection (P pos) const

IndirectionBufferType *	data ()

bool	hasIndirection () const

const ParentSetType *	parentSet () const

Static Public Attributes
static const NullSet	s_nullSet

OrderedSet_Size_Policies
A few default policies for the size of an OrderedSet
static const P	DEFAULT_VALUE

OrderedSet_Offset_Policies
A few default policies for the offset of an OrderedSet
static const P	DEFAULT_VALUE

OrderedSet_Stride_Policies
A few default policies for the stride of an OrderedSet
static const P	DEFAULT_VALUE

Protected Attributes
P	m_sz

Detailed Description

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

Alias template for an OrderedSet whose elements belong to a contiguous range \( \in [0,size) \).

Template Parameters

P	The PositionType
E	The ElementType

See also: OrderedSet

Member Typedef Documentation

◆ PositionType

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

using axom::slam::PositionSet< P, E >::PositionType = P

◆ ElementType

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

using axom::slam::PositionSet< P, E >::ElementType = E

◆ SizePolicyType

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::SizePolicyType = policies::RuntimeSize

inherited

◆ OffsetPolicyType

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::OffsetPolicyType = policies::ZeroOffset

inherited

◆ StridePolicyType

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::StridePolicyType = policies::StrideOne

inherited

◆ IndirectionPolicyType

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::IndirectionPolicyType = policies::NoIndirection

inherited

◆ SubsettingPolicyType

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::SubsettingPolicyType = policies::NoSubset

inherited

◆ ModularIntType

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::ModularIntType = ModularInt<policies::RuntimeSize >

inherited

◆ PositionSet

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::PositionSet = OrderedSet<PositionType>

inherited

◆ const_iterator

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::const_iterator = OrderedSetIterator<ElementType, true>

inherited

◆ const_iterator_pair

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::const_iterator_pair = std::pair<const_iterator, const_iterator>

inherited

◆ iterator

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::iterator = OrderedSetIterator<ElementType, false>

inherited

◆ iterator_pair

using axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::iterator_pair = std::pair<iterator, iterator>

inherited

◆ IndirectionResult

using axom::slam::policies::NoIndirection::IndirectionResult = E

inherited

◆ ConstIndirectionResult

using axom::slam::policies::NoIndirection::ConstIndirectionResult = const E

inherited

◆ IndirectionBufferType

using axom::slam::policies::NoIndirection::IndirectionBufferType = struct { }

inherited

◆ ParentSetType

using axom::slam::policies::NoSubset::ParentSetType = const Set<>

inherited

Constructor & Destructor Documentation

◆ PositionSet() [1/2]

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

axom::slam::PositionSet< P, E >::PositionSet ( PositionType size = DEFAULT_SIZE )

inline

◆ PositionSet() [2/2]

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

axom::slam::PositionSet< P, E >::PositionSet ( const typename OrderedSetType::SetBuilder & builder )

inline

Member Function Documentation

◆ begin() [1/2]

iterator axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::begin ( )

inlineinherited

◆ begin() [2/2]

const_iterator axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::begin ( ) const

inlineinherited

◆ end() [1/2]

iterator axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::end ( )

inlineinherited

◆ end() [2/2]

const_iterator axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::end ( ) const

inlineinherited

◆ range() [1/2]

iterator_pair axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::range ( )

inlineinherited

◆ range() [2/2]

const_iterator_pair axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::range ( ) const

inlineinherited

◆ operator[]() [1/2]

policies::NoIndirection ::ConstIndirectionResult axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::operator[] ( PositionType pos ) const

inlineinherited

Given a position in the Set, return a position in the larger index space.

◆ operator[]() [2/2]

policies::NoIndirection ::IndirectionResult axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::operator[] ( PositionType pos )

inlineinherited

◆ at()

ElementType axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::at ( PositionType pos ) const

inlinevirtualinherited

Random access to the entities of the set.

Parameters

The	index of the desired element

Returns: The value of the element at the given position

Precondition: The position must be less than the number of elements in the set ( size() )

Note: Concrete realizations of Set also support subscript operator – operator[].; How are we planning to handle indexes that are out or range (accidentally)? Are we planning to handle indexes that are intentionally out of range (e.g. to indicate a problem, or a missing element etc..)?

Implements axom::slam::Set< P, E >.

◆ size() [1/2]

PositionType axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::size ( ) const

inlinevirtualinherited

Get the number of entities in the set.

Returns: The number of entities in the set.

Implements axom::slam::Set< P, E >.

◆ size() [2/2]

P & axom::slam::policies::RuntimeSize::size ( )

inlineinherited

◆ empty()

bool axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::empty ( ) const

inlinevirtualinherited

Checks if there are any elements in the set – equivalent to: set.size() == 0.

Implements axom::slam::Set< P, E >.

◆ isValid() [1/3]

bool axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::isValid ( bool verboseOutput = false ) const

virtualinherited

Checks whether the set is valid.

Returns: true if the underlying indices are valid, false otherwise.

Implements axom::slam::Set< P, E >.

◆ isValid() [2/3]

bool axom::slam::policies::NoIndirection< P , E >::isValid	(	P	,
		P	,
		P	,
		bool
	)		const

inlineinherited

◆ isValid() [3/3]

template<typename OrderedSetIt >

bool axom::slam::policies::NoSubset::isValid	(	OrderedSetIt	,
		OrderedSetIt	,
		bool
	)		const

inlineinherited

◆ isSubset()

bool axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::isSubset ( ) const

inlinevirtualinherited

Determines if the Set is a Subset of another set.

Returns: true if the set is a subset of another set, otherwise false.

Implements axom::slam::Set< P, E >.

◆ isValidIndex()

bool axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::isValidIndex ( PositionType pos ) const

inlineinherited

checks whether the given position (index) is valid.

An index pos is valid when \( 0 \le pos < size() \)

Returns: true if the position is valid, false otherwise

◆ positions()

PositionSet axom::slam::OrderedSet , policies::ZeroOffset , policies::StrideOne , policies::NoIndirection , policies::NoSubset >::positions ( ) const

inlineinherited

returns a PositionSet over the set's positions

This can be used to simplify code to loop through the elements of a set.

◆ operator()() [1/5]

P axom::slam::policies::RuntimeSize::operator() ( ) const

inlineinherited

◆ operator()() [2/5]

P & axom::slam::policies::RuntimeSize::operator() ( )

inlineinherited

◆ operator()() [3/5]

P axom::slam::policies::ZeroOffset::operator() ( ) const

inlineinherited

◆ operator()() [4/5]

const P axom::slam::policies::StrideOne::operator() ( ) const

inlineinherited

◆ operator()() [5/5]

IndirectionResult axom::slam::policies::NoIndirection::operator() ( P pos ) const

inlineinherited

◆ offset()

P axom::slam::policies::ZeroOffset::offset ( ) const

inlineinherited

◆ stride()

const P axom::slam::policies::StrideOne::stride ( ) const

inlineinherited

◆ setStride()

void axom::slam::policies::StrideOne::setStride ( P AXOM_DEBUG_PARAMval )

inlineinherited

◆ indirection()

IndirectionResult axom::slam::policies::NoIndirection::indirection ( P pos ) const

inlineinherited

◆ data()

IndirectionBufferType* axom::slam::policies::NoIndirection::data ( )

inlineinherited

◆ hasIndirection()

bool axom::slam::policies::NoIndirection::hasIndirection ( ) const

inlineinherited

◆ parentSet()

const ParentSetType* axom::slam::policies::NoSubset::parentSet ( ) const

inlineinherited

Member Data Documentation

◆ DEFAULT_VALUE [1/3]

const P axom::slam::policies::RuntimeSize::DEFAULT_VALUE

staticinherited

◆ DEFAULT_VALUE [2/3]

const P axom::slam::policies::ZeroOffset::DEFAULT_VALUE

staticinherited

◆ DEFAULT_VALUE [3/3]

const P axom::slam::policies::StrideOne::DEFAULT_VALUE

staticinherited

◆ m_sz

P axom::slam::policies::RuntimeSize::m_sz

protectedinherited

◆ s_nullSet

const NullSet axom::slam::policies::NoSubset::s_nullSet

staticinherited

Referenced by axom::slam::policies::VirtualParentSubset::isSubset().

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/slam/RangeSet.hpp

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ PositionType

◆ ElementType

◆ SizePolicyType

◆ OffsetPolicyType

◆ StridePolicyType

◆ IndirectionPolicyType

◆ SubsettingPolicyType

◆ ModularIntType

◆ PositionSet

◆ const_iterator

◆ const_iterator_pair

◆ iterator

◆ iterator_pair

◆ IndirectionResult

◆ ConstIndirectionResult

◆ IndirectionBufferType

◆ ParentSetType

Constructor & Destructor Documentation

◆ PositionSet() [1/2]

◆ PositionSet() [2/2]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ range() [1/2]

◆ range() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ at()

◆ size() [1/2]

◆ size() [2/2]

◆ empty()

◆ isValid() [1/3]

◆ isValid() [2/3]

◆ isValid() [3/3]

◆ isSubset()

◆ isValidIndex()

◆ positions()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ offset()

◆ stride()

◆ setStride()

◆ indirection()

◆ data()

◆ hasIndirection()

◆ parentSet()

Member Data Documentation

◆ DEFAULT_VALUE [1/3]

◆ DEFAULT_VALUE [2/3]

◆ DEFAULT_VALUE [3/3]

◆ m_sz

◆ s_nullSet

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