An iterator type for a BivariateMap, iterating via its ElementFlatIndex. More...

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

Inheritance diagram for axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator:

Public Types
using	PositionType = SetPosition

Public Member Functions
	BivariateMapIterator (BivariateMap *sMap, PositionType pos)
	Construct a new BivariateMap Iterator given an ElementFlatIndex. More...

bool	operator== (const iter &other) const

bool	operator!= (const iter &other) const

DataType &	operator* ()
	Returns the current iterator value. If the BivariateMap has multiple components, this will return the first component. To access the other components, use iter(comp) More...

DataType &	operator() (PositionType comp_idx=0)
	Returns the iterator's value at the specified component. Returns the first component if comp_idx is not specified. More...

DataType &	operator[] (PositionType n)
	Returns the first component value after n increments. More...

DataType &	value (PositionType comp=0)
	Return the value at the iterator's position. Same as operator() More...

PositionType	firstIndex ()
	return the current iterator's first index into the BivariateSet More...

PositionType	secondIndex ()
	return the current iterator's second index (DenseIndex) into the BivariateSet More...

PositionType	numComp () const
	Returns the number of components per element in the map. More...

Iterator advance and distance operators
BivariateMapIterator &	operator++ ()
	Pre-increment operator. More...

BivariateMapIterator	operator++ (int)
	Post-increment operator. More...

BivariateMapIterator &	operator-- ()
	Pre-decrement operator. More...

BivariateMapIterator	operator-- (int)
	Post-decrement operator. More...

BivariateMapIterator &	operator+= (SetPosition n)
	Addition-assignment operator. More...

BivariateMapIterator &	operator-= (SetPosition n)
	Subtraction-assignment operator. More...

Public Attributes
const PositionType	INVALID_POS = -2

Protected Member Functions
void	advance (PositionType n)

Protected Attributes
SetPosition	m_pos

Detailed Description

template<typename SetType, typename DataType, typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>
class axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator

An iterator type for a BivariateMap, iterating via its ElementFlatIndex.

This iterator class traverses the BivariateMap using its ElementFlatIndex. In addition to m_pos from IteratorBase, this class also keeps track of the iterator's first index (firstIdx), second dense index (secondIdx), and the second sparse index (secondSparseIdx). The advance() function is implemented to update those three additional indices.

Member Typedef Documentation

◆ PositionType

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

using axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::PositionType = SetPosition

Constructor & Destructor Documentation

◆ BivariateMapIterator()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::BivariateMapIterator	(	BivariateMap *	sMap,
		PositionType	pos
	)

inline

Construct a new BivariateMap Iterator given an ElementFlatIndex.

Referenced by axom::slam::BivariateMap< SetType, DataType, StridePolicy >::begin(), and axom::slam::BivariateMap< SetType, DataType, StridePolicy >::end().

Member Function Documentation

◆ operator==()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

bool axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator== ( const iter & other ) const

inline

References axom::slam::IteratorBase< BivariateMapIterator, SetPosition >::m_pos, and axom::slam::IteratorBase< IterType, PosType >::m_pos.

Referenced by axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator!=().

◆ operator!=()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

bool axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator!= ( const iter & other ) const

inline

References axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator==().

◆ operator*()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

DataType& axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator* ( )

inline

Returns the current iterator value. If the BivariateMap has multiple components, this will return the first component. To access the other components, use iter(comp)

◆ operator()()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

DataType& axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator() ( PositionType comp_idx = 0 )

inline

Returns the iterator's value at the specified component. Returns the first component if comp_idx is not specified.

Parameters

comp_idx (Optional) Zero-based index of the component.

◆ operator[]()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

DataType& axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator[] ( PositionType n )

inline

Returns the first component value after n increments.

References axom::slam::IteratorBase< BivariateMapIterator, SetPosition >::operator+.

◆ value()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

DataType& axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::value ( PositionType comp = 0 )

inline

Return the value at the iterator's position. Same as operator()

◆ firstIndex()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

PositionType axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::firstIndex ( )

inline

return the current iterator's first index into the BivariateSet

◆ secondIndex()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

PositionType axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::secondIndex ( )

inline

return the current iterator's second index (DenseIndex) into the BivariateSet

References axom::slam::BivariateSet< PosType, ElemType >::at(), axom::slam::IteratorBase< BivariateMapIterator, SetPosition >::m_pos, and axom::slam::BivariateMap< SetType, DataType, StridePolicy >::set().

◆ numComp()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

PositionType axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::numComp ( ) const

inline

Returns the number of components per element in the map.

References axom::slam::BivariateSet< PosType, ElemType >::at(), axom::slam::BivariateMap< SetType, DataType, StridePolicy >::firstSetSize(), axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::INVALID_POS, axom::slam::IteratorBase< BivariateMapIterator, SetPosition >::m_pos, axom::slam::BivariateMap< SetType, DataType, StridePolicy >::numComp(), axom::slam::BivariateMap< SetType, DataType, StridePolicy >::set(), axom::slam::BivariateSet< PosType, ElemType >::size(), SLIC_ASSERT, and axom::slam::BivariateMap< SetType, DataType, StridePolicy >::totalSize().

◆ advance()

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

void axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::advance ( PositionType n )

inlineprotected

Implementation of advance() as required by IteratorBase. It updates the three other indices as well.

References axom::slam::BivariateMap< SetType, DataType, StridePolicy >::firstSetSize(), axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::INVALID_POS, axom::slam::IteratorBase< BivariateMapIterator, SetPosition >::m_pos, axom::slam::BivariateMap< SetType, DataType, StridePolicy >::size(), and axom::slam::BivariateMap< SetType, DataType, StridePolicy >::totalSize().

◆ operator++() [1/2]

BivariateMapIterator & axom::slam::IteratorBase< BivariateMapIterator , SetPosition >::operator++ ( )

inlineinherited

Pre-increment operator.

◆ operator++() [2/2]

BivariateMapIterator axom::slam::IteratorBase< BivariateMapIterator , SetPosition >::operator++ ( int )

inlineinherited

Post-increment operator.

◆ operator--() [1/2]

BivariateMapIterator & axom::slam::IteratorBase< BivariateMapIterator , SetPosition >::operator-- ( )

inlineinherited

Pre-decrement operator.

◆ operator--() [2/2]

BivariateMapIterator axom::slam::IteratorBase< BivariateMapIterator , SetPosition >::operator-- ( int )

inlineinherited

Post-decrement operator.

◆ operator+=()

BivariateMapIterator & axom::slam::IteratorBase< BivariateMapIterator , SetPosition >::operator+= ( SetPosition n )

inlineinherited

Addition-assignment operator.

◆ operator-=()

BivariateMapIterator & axom::slam::IteratorBase< BivariateMapIterator , SetPosition >::operator-= ( SetPosition n )

inlineinherited

Subtraction-assignment operator.

Member Data Documentation

◆ INVALID_POS

template<typename SetType , typename DataType , typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>

const PositionType axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::INVALID_POS = -2

Referenced by axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::advance(), and axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::numComp().

◆ m_pos

SetPosition axom::slam::IteratorBase< BivariateMapIterator , SetPosition >::m_pos

protectedinherited

Referenced by axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::advance(), axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::numComp(), axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::operator==(), and axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator::secondIndex().

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/BivariateMap.hpp

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<typename SetType, typename DataType, typename StridePolicy = policies::StrideOne<typename SetType::PositionType>> class axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator

Member Typedef Documentation

◆ PositionType

Constructor & Destructor Documentation

◆ BivariateMapIterator()

Member Function Documentation

◆ operator==()

◆ operator!=()

◆ operator*()

◆ operator()()

◆ operator[]()

◆ value()

◆ firstIndex()

◆ secondIndex()

◆ numComp()

◆ advance()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator+=()

◆ operator-=()

Member Data Documentation

◆ INVALID_POS

◆ m_pos

template<typename SetType, typename DataType, typename StridePolicy = policies::StrideOne<typename SetType::PositionType>>
class axom::slam::BivariateMap< SetType, DataType, StridePolicy >::BivariateMapIterator