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

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

Inheritance diagram for axom::slam::RelationSet< Relation, SetType1, SetType2 >:

[legend]

Public Types
using	FirstSetType = SetType1

using	SecondSetType = SetType2

using	RelationType = Relation

using	PositionType = typename RelationType::SetPosition

using	ElementType = typename RelationType::SetElement

using	RelationSubset = typename RelationType::RelationSubset

using	OrderedSetType = typename BivariateSetType::OrderedSetType

using	SizePolicyType = policies::RuntimeSize< Relation::SetPosition >

using	OffsetPolicyType = policies::ZeroOffset< Relation::SetPosition >

using	StridePolicyType = policies::StrideOne< Relation::SetPosition >

using	IndirectionPolicyType = policies::NoIndirection< Relation::SetPosition, Relation::SetElement >

using	SubsettingPolicyType = policies::NoSubset

using	ModularIntType = ModularInt< policies::RuntimeSize< Relation::SetPosition > >

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 = Relation::SetElement

using	ConstIndirectionResult = const Relation::SetElement

using	IndirectionBufferType = struct { }

using	IndirectionPtrType = IndirectionBufferType *

using	ParentSetType = const Set<>

using	NullSetType = NullSet< PositionType, ElementType >

Public Member Functions
	RelationSet ()=default

	RelationSet (RelationType *relation)
	Constructor taking in the relation this BivariateSet is based on. More...

PositionType	findElementIndex (PositionType pos1, PositionType pos2) const override
	Searches for the SparseIndex of the element given its DenseIndex. If the element (i,j) is the k^th non-zero in the row, then `findElementIndex(i,j)` returns `k`. If `element(i,j)` does not exist (such as the case of a zero in a sparse matrix), then `INVALID_POS` is returned. More...

PositionType	findElementFlatIndex (PositionType s1, PositionType s2) const override
	Search for the FlatIndex of the element given its DenseIndex. More...

PositionType	findElementFlatIndex (PositionType pos1) const override
	Given the from-set index pos1, return the FlatIndex of the first existing to-set element in the relation pair, or `INVALID_POS` if this row contains no elements. More...

RangeSetType	elementRangeSet (PositionType pos1) const override

const OrderedSetType	getElements (PositionType s1) const override
	A set of elements with the given first set index. More...

ElementType	at (PositionType pos) const override

RelationType *	getRelation () const
	Returns the relation pointer. More...

RelationType *	getRelation ()

PositionType	totalSize () const
	Return the size of the relation. More...

PositionType	size (PositionType pos) const override
	Return the size of a row, which is the number of to-set elements associated with the given from-set index. More...

bool	isValid (bool verboseOutput=false) const override

PositionType	size () const override
	Size of the BivariateSet, which is the number of non-zero entries in the BivariateSet. More...

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

iterator_pair	range ()

const_iterator_pair	range () const

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

policies::NoIndirection< Relation::SetPosition, Relation::SetElement > ::IndirectionResult	operator[] (PositionType pos)

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

Relation::SetPosition &	size ()

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

bool	isValid (Relation::SetPosition, Relation::SetPosition, Relation::SetPosition, 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...

Relation::SetPosition	operator() () const

Relation::SetPosition &	operator() ()

Relation::SetPosition	operator() () const

const Relation::SetPosition	operator() () const

IndirectionResult	operator() (Relation::SetPosition pos) const

Relation::SetPosition	offset () const

const Relation::SetPosition	stride () const

void	setStride (Relation::SetPosition AXOM_DEBUG_PARAM(val))

IndirectionResult	indirection (Relation::SetPosition pos) const

IndirectionBufferType *	data ()

bool	hasIndirection () const

const ParentSetType *	parentSet () const

virtual PositionType	findElementIndex (PositionType pos1, PositionType pos2) const=0
	Searches for the SparseIndex of the element given its DenseIndex. If the element (i,j) is the k^th non-zero in the row, then `findElementIndex(i,j)` returns `k`. If `element (i,j)` does not exist (such as the case of a zero in a sparse matrix), then `INVALID_POS` is returned. More...

virtual PositionType	findElementFlatIndex (PositionType pos1, PositionType pos2) const=0
	Search for the FlatIndex of the element given its DenseIndex. More...

virtual PositionType	findElementFlatIndex (PositionType pos1) const=0
	Searches for the first existing element given the row index (first set position). More...

virtual RangeSetType	elementRangeSet (PositionType pos1) const=0
	Finds the range of indices of valid elements in the second set, given the index of an element in the first set. More...

virtual PositionType	size (PositionType pos1) const=0
	Number of elements of the BivariateSet whose first index is pos. More...

PositionType	firstSetSize () const
	Size of the first set. More...

PositionType	secondSetSize () const
	Size of the second set. More...

const FirstSetType *	getFirstSet () const
	Returns pointer to the first set. More...

const SecondSetType *	getSecondSet () const
	Returns pointer to the second set. More...

virtual ElementType	at (PositionType pos) const=0
	Returns the element at the given FlatIndex pos. More...

virtual const OrderedSetType	getElements (PositionType s1) const=0
	A set of elements with the given first set index. More...

virtual void	verifyPosition (PositionType s1, PositionType s2) const=0

Static Public Attributes
static const bool	IS_COMPILE_TIME

static AXOM_EXPORT const NullSet	s_nullSet

static const PositionType	INVALID_POS

static const NullSetType	s_nullSet

OrderedSet_Size_Policies
A few default policies for the size of an OrderedSet
static const Relation::SetPosition	DEFAULT_VALUE

OrderedSet_Offset_Policies
A few default policies for the offset of an OrderedSet
static const Relation::SetPosition	DEFAULT_VALUE

OrderedSet_Stride_Policies
A few default policies for the stride of an OrderedSet
static const Relation::SetPosition	DEFAULT_VALUE

Protected Attributes
Relation::SetPosition	m_sz

const FirstSetType *	m_set1

const SecondSetType *	m_set2

Detailed Description

template<typename Relation, typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>
class axom::slam::RelationSet< Relation, SetType1, SetType2 >

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

RelationSet models a subset of the Cartesian product of two sets. Users should refer to the BivariateSet documentation for descriptions of the different indexing names (SparseIndex, DenseIndex, FlatIndex).

Template Parameters

Relation The Relation type that this set uses.

See also: BivariateSet

Member Typedef Documentation

◆ FirstSetType

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

using axom::slam::RelationSet< Relation, SetType1, SetType2 >::FirstSetType = SetType1

◆ SecondSetType

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

using axom::slam::RelationSet< Relation, SetType1, SetType2 >::SecondSetType = SetType2

◆ RelationType

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

using axom::slam::RelationSet< Relation, SetType1, SetType2 >::RelationType = Relation

◆ PositionType

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

using axom::slam::RelationSet< Relation, SetType1, SetType2 >::PositionType = typename RelationType::SetPosition

◆ ElementType

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

using axom::slam::RelationSet< Relation, SetType1, SetType2 >::ElementType = typename RelationType::SetElement

◆ RelationSubset

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

using axom::slam::RelationSet< Relation, SetType1, SetType2 >::RelationSubset = typename RelationType::RelationSubset

◆ OrderedSetType

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

using axom::slam::RelationSet< Relation, SetType1, SetType2 >::OrderedSetType = typename BivariateSetType::OrderedSetType

◆ SizePolicyType

using axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::SizePolicyType = policies::RuntimeSize<Relation::SetPosition >

inherited

◆ OffsetPolicyType

using axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::OffsetPolicyType = policies::ZeroOffset<Relation::SetPosition >

inherited

◆ StridePolicyType

using axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::StridePolicyType = policies::StrideOne<Relation::SetPosition >

inherited

◆ IndirectionPolicyType

using axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::IndirectionPolicyType = policies::NoIndirection<Relation::SetPosition , Relation::SetElement >

inherited

◆ SubsettingPolicyType

using axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::SubsettingPolicyType = policies::NoSubset

inherited

◆ ModularIntType

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

inherited

◆ PositionSet

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

inherited

◆ const_iterator

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

inherited

◆ const_iterator_pair

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

inherited

◆ iterator

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

inherited

◆ iterator_pair

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

inherited

◆ IndirectionResult

using axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::IndirectionResult = Relation::SetElement

inherited

◆ ConstIndirectionResult

using axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::ConstIndirectionResult = const Relation::SetElement

inherited

◆ IndirectionBufferType

using axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::IndirectionBufferType = struct { }

inherited

◆ IndirectionPtrType

using axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::IndirectionPtrType = IndirectionBufferType*

inherited

◆ ParentSetType

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

inherited

◆ NullSetType

using axom::slam::BivariateSet< SetType1 , SetType2 >::NullSetType = NullSet<PositionType, ElementType>

inherited

Constructor & Destructor Documentation

◆ RelationSet() [1/2]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

axom::slam::RelationSet< Relation, SetType1, SetType2 >::RelationSet ( )

default

◆ RelationSet() [2/2]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

axom::slam::RelationSet< Relation, SetType1, SetType2 >::RelationSet ( RelationType * relation )

inline

Constructor taking in the relation this BivariateSet is based on.

Precondition: relation pointer must not be a null pointer

References SLIC_ASSERT.

Member Function Documentation

◆ findElementIndex() [1/2]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

PositionType axom::slam::RelationSet< Relation, SetType1, SetType2 >::findElementIndex	(	PositionType	pos1,
		PositionType	pos2
	)		const

inlineoverride

Searches for the SparseIndex of the element given its DenseIndex. If the element (i,j) is the k^th non-zero in the row, then findElementIndex(i,j) returns k. If element(i,j) does not exist (such as the case of a zero in a sparse matrix), then INVALID_POS is returned.

Warning: This function can be slow, since a linear search is performed on the row each time.

Parameters

pos1	The first set position.
pos2	The second set position.

Returns: The DenseIndex of the given element, or INVALID_POS if such element is missing from the set.

Precondition: 0 <= pos1 <= set1.size() && 0 <= pos2 <= size2.size()

References axom::slam::BivariateSet< Set1, Set2 >::INVALID_POS.

◆ findElementFlatIndex() [1/4]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

PositionType axom::slam::RelationSet< Relation, SetType1, SetType2 >::findElementFlatIndex	(	PositionType	s1,
		PositionType	s2
	)		const

inlineoverride

Search for the FlatIndex of the element given its DenseIndex.

Warning: This function can be slow, since a linear search is performed on the row each time.

Parameters

pos1	The first set position.
pos2	The second set position.

Returns: The element's FlatIndex

Precondition: 0 <= pos1 <= set1.size() && 0 <= pos2 <= size2.size()

References axom::slam::BivariateSet< Set1, Set2 >::INVALID_POS.

◆ findElementFlatIndex() [2/4]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

PositionType axom::slam::RelationSet< Relation, SetType1, SetType2 >::findElementFlatIndex ( PositionType pos1 ) const

inlineoverride

Given the from-set index pos1, return the FlatIndex of the first existing to-set element in the relation pair, or INVALID_POS if this row contains no elements.

Parameters

pos1	Index into the from-set.
pos2	Index into the to-set.

Returns: The FlatIndex of the first existing to-set element.

References axom::slam::BivariateSet< Set1, Set2 >::INVALID_POS.

◆ elementRangeSet() [1/2]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

RangeSetType axom::slam::RelationSet< Relation, SetType1, SetType2 >::elementRangeSet ( PositionType pos1 ) const

inlineoverride

References axom::slam::policies::ZeroOffset< Relation::SetPosition >::offset(), axom::slam::Relation< PosType, ElemType >::size(), and axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::size().

◆ getElements() [1/2]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

const OrderedSetType axom::slam::RelationSet< Relation, SetType1, SetType2 >::getElements ( PositionType s1 ) const

inlineoverride

A set of elements with the given first set index.

Parameters

s1	The first set index.

Returns: An OrderedSet containing the elements in the row.

Precondition: 0 <= pos1 <= set1.size()

◆ at() [1/3]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

ElementType axom::slam::RelationSet< Relation, SetType1, SetType2 >::at ( PositionType pos ) const

inlineoverride

◆ getRelation() [1/2]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

RelationType* axom::slam::RelationSet< Relation, SetType1, SetType2 >::getRelation ( ) const

inline

Returns the relation pointer.

◆ getRelation() [2/2]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

RelationType* axom::slam::RelationSet< Relation, SetType1, SetType2 >::getRelation ( )

inline

◆ totalSize()

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

PositionType axom::slam::RelationSet< Relation, SetType1, SetType2 >::totalSize ( ) const

inline

Return the size of the relation.

References axom::slam::Relation< PosType, ElemType >::size().

◆ size() [1/4]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

PositionType axom::slam::RelationSet< Relation, SetType1, SetType2 >::size ( PositionType pos ) const

inlineoverride

Return the size of a row, which is the number of to-set elements associated with the given from-set index.

Parameters

pos	The from-set position.

References axom::slam::Relation< PosType, ElemType >::size().

◆ isValid() [1/3]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

bool axom::slam::RelationSet< Relation, SetType1, SetType2 >::isValid ( bool verboseOutput = false ) const

inlineoverridevirtual

Reimplemented from axom::slam::BivariateSet< SetType1, SetType2 >.

References axom::slam::Relation< PosType, ElemType >::isValid().

◆ size() [2/4]

template<typename Relation , typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>

PositionType axom::slam::RelationSet< Relation, SetType1, SetType2 >::size ( ) const

inlineoverridevirtual

Size of the BivariateSet, which is the number of non-zero entries in the BivariateSet.

Implements axom::slam::BivariateSet< SetType1, SetType2 >.

References AXOM_DEBUG_PARAM, axom::slam::BivariateSet< SetType1, SetType2 >::firstSetSize(), axom::slam::BivariateSet< SetType1, SetType2 >::secondSetSize(), axom::slam::Relation< PosType, ElemType >::size(), and SLIC_ASSERT_MSG.

◆ begin() [1/2]

iterator axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::begin ( )

inlineinherited

◆ begin() [2/2]

const_iterator axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::begin ( ) const

inlineinherited

◆ end() [1/2]

iterator axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::end ( )

inlineinherited

◆ end() [2/2]

const_iterator axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::end ( ) const

inlineinherited

◆ range() [1/2]

iterator_pair axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::range ( )

inlineinherited

References axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::begin(), and axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::end().

◆ range() [2/2]

const_iterator_pair axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::range ( ) const

inlineinherited

References axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::begin(), and axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::end().

◆ operator[]() [1/2]

policies::NoIndirection<Relation::SetPosition , Relation::SetElement > ::ConstIndirectionResult axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , 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<Relation::SetPosition , Relation::SetElement > ::IndirectionResult axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::operator[] ( PositionType pos )

inlineinherited

◆ at() [2/3]

ElementType axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , 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< Relation::SetPosition, Relation::SetElement >.

References axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::operator[]().

◆ size() [3/4]

Relation::SetPosition & axom::slam::policies::RuntimeSize< Relation::SetPosition >::size ( )

inlineinherited

◆ empty()

bool axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , policies::NoSubset >::empty ( ) const

inlinevirtualinherited

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

Implements axom::slam::Set< Relation::SetPosition, Relation::SetElement >.

References axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::isValid().

◆ isValid() [2/3]

bool axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::isValid	(	Relation::SetPosition	,
		Relation::SetPosition	,
		Relation::SetPosition	,
		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< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , 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< Relation::SetPosition, Relation::SetElement >.

◆ isValidIndex()

bool axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , 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

References axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::SetBuilder::size().

◆ positions()

PositionSet axom::slam::OrderedSet< Relation::SetPosition , Relation::SetElement , policies::RuntimeSize<Relation::SetPosition > , policies::ZeroOffset<Relation::SetPosition > , policies::StrideOne<Relation::SetPosition > , policies::NoIndirection<Relation::SetPosition , Relation::SetElement > , 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.

References AXOM_DEBUG_PARAM, axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::isValidIndex(), axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy >::SetBuilder::size(), and SLIC_ASSERT_MSG.

◆ operator()() [1/5]

Relation::SetPosition axom::slam::policies::RuntimeSize< Relation::SetPosition >::operator() ( ) const

inlineinherited

◆ operator()() [2/5]

Relation::SetPosition & axom::slam::policies::RuntimeSize< Relation::SetPosition >::operator() ( )

inlineinherited

◆ operator()() [3/5]

Relation::SetPosition axom::slam::policies::ZeroOffset< Relation::SetPosition >::operator() ( ) const

inlineinherited

◆ operator()() [4/5]

const Relation::SetPosition axom::slam::policies::StrideOne< Relation::SetPosition >::operator() ( ) const

inlineinherited

◆ operator()() [5/5]

IndirectionResult axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::operator() ( Relation::SetPosition pos ) const

inlineinherited

References axom::slam::policies::NoIndirection< PositionType, ElementType >::indirection().

◆ offset()

Relation::SetPosition axom::slam::policies::ZeroOffset< Relation::SetPosition >::offset ( ) const

inlineinherited

◆ stride()

const Relation::SetPosition axom::slam::policies::StrideOne< Relation::SetPosition >::stride ( ) const

inlineinherited

◆ setStride()

void axom::slam::policies::StrideOne< Relation::SetPosition >::setStride ( Relation::SetPosition AXOM_DEBUG_PARAMval )

inlineinherited

◆ indirection()

IndirectionResult axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::indirection ( Relation::SetPosition pos ) const

inlineinherited

◆ data()

IndirectionBufferType* axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::data ( )

inlineinherited

◆ hasIndirection()

bool axom::slam::policies::NoIndirection< Relation::SetPosition , Relation::SetElement >::hasIndirection ( ) const

inlineinherited

◆ parentSet()

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

inlineinherited

◆ findElementIndex() [2/2]

virtual PositionType axom::slam::BivariateSet< SetType1 , SetType2 >::findElementIndex	(	PositionType	pos1,
		PositionType	pos2
	)		const

pure virtualinherited

Searches for the SparseIndex of the element given its DenseIndex. If the element (i,j) is the k^th non-zero in the row, then findElementIndex(i,j) returns k. If element (i,j) does not exist (such as the case of a zero in a sparse matrix), then INVALID_POS is returned.

Parameters

pos1	The first set position.
pos2	The second set position.

Returns: The DenseIndex of the given element, or INVALID_POS if such element is missing from the set.

Precondition: 0 <= pos1 <= set1.size() && 0 <= pos2 <= size2.size()

◆ findElementFlatIndex() [3/4]

virtual PositionType axom::slam::BivariateSet< SetType1 , SetType2 >::findElementFlatIndex	(	PositionType	pos1,
		PositionType	pos2
	)		const

pure virtualinherited

Search for the FlatIndex of the element given its DenseIndex.

Parameters

pos1	The first set position.
pos2	The second set position.

Returns: The element's FlatIndex

Precondition: 0 <= pos1 <= set1.size() && 0 <= pos2 <= size2.size()

◆ findElementFlatIndex() [4/4]

virtual PositionType axom::slam::BivariateSet< SetType1 , SetType2 >::findElementFlatIndex ( PositionType pos1 ) const

pure virtualinherited

Searches for the first existing element given the row index (first set position).

Parameters

pos1	The first set position.

Returns: The found element's FlatIndex.

Precondition: 0 <= pos1 <= set1.size()

◆ elementRangeSet() [2/2]

virtual RangeSetType axom::slam::BivariateSet< SetType1 , SetType2 >::elementRangeSet ( PositionType pos1 ) const

pure virtualinherited

Finds the range of indices of valid elements in the second set, given the index of an element in the first set.

Parameters

Position of the element in the first set

Returns: A range set of the positions in the second set

◆ size() [4/4]

virtual PositionType axom::slam::BivariateSet< SetType1 , SetType2 >::size ( PositionType pos1 ) const

pure virtualinherited

Number of elements of the BivariateSet whose first index is pos.

Precondition: 0 <= pos1 <= set1.size()

◆ firstSetSize()

PositionType axom::slam::BivariateSet< SetType1 , SetType2 >::firstSetSize ( ) const

inlineinherited

Size of the first set.

References axom::slam::BivariateSet< Set1, Set2 >::m_set1.

◆ secondSetSize()

PositionType axom::slam::BivariateSet< SetType1 , SetType2 >::secondSetSize ( ) const

inlineinherited

Size of the second set.

References axom::slam::BivariateSet< Set1, Set2 >::m_set2.

◆ getFirstSet()

const FirstSetType* axom::slam::BivariateSet< SetType1 , SetType2 >::getFirstSet ( ) const

inlineinherited

Returns pointer to the first set.

References axom::slam::BivariateSet< Set1, Set2 >::m_set1.

◆ getSecondSet()

const SecondSetType* axom::slam::BivariateSet< SetType1 , SetType2 >::getSecondSet ( ) const

inlineinherited

Returns pointer to the second set.

References axom::slam::BivariateSet< Set1, Set2 >::at(), axom::slam::BivariateSet< Set1, Set2 >::getElements(), axom::slam::BivariateSet< Set1, Set2 >::isValid(), axom::slam::BivariateSet< Set1, Set2 >::m_set2, SLIC_ASSERT_MSG, and axom::slam::BivariateSet< Set1, Set2 >::verifyPosition().

◆ at() [3/3]

virtual ElementType axom::slam::BivariateSet< SetType1 , SetType2 >::at ( PositionType pos ) const

pure virtualinherited

Returns the element at the given FlatIndex pos.

◆ getElements() [2/2]

virtual const OrderedSetType axom::slam::BivariateSet< SetType1 , SetType2 >::getElements ( PositionType s1 ) const

pure virtualinherited

A set of elements with the given first set index.

Parameters

s1	The first set index.

Returns: An OrderedSet containing the elements

Precondition: 0 <= pos1 <= set1.size()

◆ verifyPosition()

virtual void axom::slam::BivariateSet< SetType1 , SetType2 >::verifyPosition	(	PositionType	s1,
		PositionType	s2
	)		const

pure virtualinherited

Member Data Documentation

◆ DEFAULT_VALUE [1/3]

const Relation::SetPosition axom::slam::policies::RuntimeSize< Relation::SetPosition >::DEFAULT_VALUE

staticinherited

◆ DEFAULT_VALUE [2/3]

const Relation::SetPosition axom::slam::policies::ZeroOffset< Relation::SetPosition >::DEFAULT_VALUE

staticinherited

◆ DEFAULT_VALUE [3/3]

const Relation::SetPosition axom::slam::policies::StrideOne< Relation::SetPosition >::DEFAULT_VALUE

staticinherited

◆ m_sz

Relation::SetPosition axom::slam::policies::RuntimeSize< Relation::SetPosition >::m_sz

protectedinherited

◆ IS_COMPILE_TIME

const bool axom::slam::policies::StrideOne< Relation::SetPosition >::IS_COMPILE_TIME

staticinherited

◆ s_nullSet [1/2]

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

staticinherited

◆ INVALID_POS

const PositionType axom::slam::BivariateSet< SetType1 , SetType2 >::INVALID_POS

staticinherited

◆ s_nullSet [2/2]

const BivariateSet< SetType1 , SetType2 >::NullSetType axom::slam::BivariateSet< SetType1 , SetType2 >::s_nullSet

staticinherited

◆ m_set1

const FirstSetType* axom::slam::BivariateSet< SetType1 , SetType2 >::m_set1

protectedinherited

◆ m_set2

const SecondSetType* axom::slam::BivariateSet< SetType1 , SetType2 >::m_set2

protectedinherited

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.7.0/src/axom/slam/RelationSet.hpp

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

template<typename Relation, typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>> class axom::slam::RelationSet< Relation, SetType1, SetType2 >

Member Typedef Documentation

◆ FirstSetType

◆ SecondSetType

◆ RelationType

◆ PositionType

◆ ElementType

◆ RelationSubset

◆ OrderedSetType

◆ SizePolicyType

◆ OffsetPolicyType

◆ StridePolicyType

◆ IndirectionPolicyType

◆ SubsettingPolicyType

◆ ModularIntType

◆ PositionSet

◆ const_iterator

◆ const_iterator_pair

◆ iterator

◆ iterator_pair

◆ IndirectionResult

◆ ConstIndirectionResult

◆ IndirectionBufferType

◆ IndirectionPtrType

◆ ParentSetType

◆ NullSetType

Constructor & Destructor Documentation

◆ RelationSet() [1/2]

◆ RelationSet() [2/2]

Member Function Documentation

◆ findElementIndex() [1/2]

◆ findElementFlatIndex() [1/4]

◆ findElementFlatIndex() [2/4]

◆ elementRangeSet() [1/2]

◆ getElements() [1/2]

◆ at() [1/3]

◆ getRelation() [1/2]

◆ getRelation() [2/2]

◆ totalSize()

◆ size() [1/4]

◆ isValid() [1/3]

◆ size() [2/4]

◆ 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() [2/3]

◆ size() [3/4]

◆ empty()

◆ 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()

◆ findElementIndex() [2/2]

◆ findElementFlatIndex() [3/4]

◆ findElementFlatIndex() [4/4]

◆ elementRangeSet() [2/2]

◆ size() [4/4]

template<typename Relation, typename SetType1 = slam::Set<>, typename SetType2 = slam::Set<>>
class axom::slam::RelationSet< Relation, SetType1, SetType2 >