AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
|
Models a set whose elements belong to a contiguous range \( \in [lowerIndex,upperIndex) \). More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/slam/RangeSet.hpp>
Public Types | |
using | PositionType = P |
using | ElementType = E |
using | SizePolicyType = policies::RuntimeSize< P > |
using | OffsetPolicyType = policies::RuntimeOffset< P > |
using | StridePolicyType = StridingPolicy |
using | IndirectionPolicyType = IndirectionPolicy |
using | SubsettingPolicyType = SubsettingPolicy |
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 > |
Public Member Functions | |
GenericRangeSet (PositionType size=OrderedSetType::SizePolicyType::DEFAULT_VALUE) | |
GenericRangeSet (const typename OrderedSetType::SetBuilder &builder) | |
GenericRangeSet (PositionType lowerIndex, PositionType upperIndex) | |
iterator | begin () |
const_iterator | begin () const |
iterator | end () |
const_iterator | end () const |
iterator_pair | range () |
const_iterator_pair | range () const |
IndirectionPolicy::ConstIndirectionResult | operator[] (PositionType pos) const |
Given a position in the Set, return a position in the larger index space. More... | |
IndirectionPolicy::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 | 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 |
P & | operator() () |
P | offset () const |
P & | offset () |
Static Public Attributes | |
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 |
Protected Attributes | |
P | m_sz |
Models a set whose elements belong to a contiguous range \( \in [lowerIndex,upperIndex) \).
using axom::slam::GenericRangeSet< P, E, StridingPolicy, IndirectionPolicy, SubsettingPolicy >::PositionType = P |
using axom::slam::GenericRangeSet< P, E, StridingPolicy, IndirectionPolicy, SubsettingPolicy >::ElementType = E |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inline |
|
inline |
|
inline |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Given a position in the Set, return a position in the larger index space.
|
inlineinherited |
|
inlinevirtualinherited |
Random access to the entities of the set.
The | index of the desired element |
Implements axom::slam::Set< P, E >.
|
inlinevirtualinherited |
Get the number of entities in the set.
Implements axom::slam::Set< P, E >.
|
inlineinherited |
|
inlinevirtualinherited |
Checks if there are any elements in the set – equivalent to: set.size() == 0.
Implements axom::slam::Set< P, E >.
|
virtualinherited |
Checks whether the set is valid.
Implements axom::slam::Set< P, E >.
|
inlinevirtualinherited |
Determines if the Set is a Subset of another set.
Implements axom::slam::Set< P, E >.
|
inlineinherited |
checks whether the given position (index) is valid.
An index pos is valid when \( 0 \le pos < size() \)
|
inlineinherited |
returns a PositionSet over the set's positions
This can be used to simplify code to loop through the elements of a set.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
staticinherited |
|
staticinherited |
|
protectedinherited |