moab::Range::const_iterator Class Reference

a const iterator which iterates over an Range More...

#include <Range.hpp>

Inheritance diagram for moab::Range::const_iterator:

Collaboration diagram for moab::Range::const_iterator:

Public Member Functions
	const_iterator ()
	default constructor - intialize base default constructor More...
	const_iterator (const PairNode *iter, const EntityHandle val)
	constructor used by Range More...
const EntityHandle &	operator* () const
	dereference that value this iterator points to returns a const reference More...
const_iterator &	operator++ ()
	prefix incrementer More...
const_iterator	operator++ (int)
	postfix incrementer More...
const_iterator &	operator-- ()
	prefix decrementer More...
const_iterator	operator-- (int)
	postfix decrementer More...
const_iterator &	operator+= (EntityID step)
	Advance iterator specified amount. Potentially O(n), but typically better. Always more efficient than calling operator++ step times. More...
const_iterator &	operator-= (EntityID step)
	Regress iterator specified amount. Potentially O(n), but typically better. Always more efficient than calling operator-- step times. More...
bool	operator== (const const_iterator &other) const
	equals operator More...
bool	operator!= (const const_iterator &other) const
	not equals operator More...
const_iterator	end_of_block () const
	get an iterator at the end of the block More...
const_iterator	start_of_block () const
	get an iterator at the start of the block More...

Protected Attributes
PairNode *	mNode
	the node we are pointing at More...
EntityHandle	mValue
	the value in the range More...

Friends
class	Range
class	pair_iterator
class	const_pair_iterator
EntityID	operator- (const const_iterator &, const const_iterator &)

Additional Inherited Members
Public Types inherited from moab::range_base_iter
typedef range_iter_tag	iterator_category
typedef EntityID	difference_type
typedef EntityHandle	value_type
typedef EntityHandle *	pointer
typedef EntityHandle &	reference

Detailed Description

a const iterator which iterates over an Range

Examples

ComputeTriDual.cpp.

Definition at line 459 of file Range.hpp.

Constructor & Destructor Documentation

const_iterator() [1/2]

moab::Range::const_iterator::const_iterator ( )

inline

default constructor - intialize base default constructor

Definition at line 468 of file Range.hpp.

: mNode( NULL ), mValue( 0 ) {}

const_iterator() [2/2]

moab::Range::const_iterator::const_iterator ( const PairNode *  iter, const EntityHandle  val  )

inline

constructor used by Range

Definition at line 471 of file Range.hpp.

 : mNode( const_cast< PairNode* >( iter ) ), mValue( val )
 {
 }

Member Function Documentation

end_of_block()

Range::const_iterator moab::Range::const_iterator::end_of_block ( ) const

inline

get an iterator at the end of the block

Get an iterator at the end of the block of consecutive handles that this iterator is currently contained in. That is, if the range contains blocks of consecutive handles of the form { [1,5], [7,100], ... } and this iterator is at any handle in the range [7,100], return an iterator at the '100' handle.

Never returns begin() or end() unless this iterator is at begin() or end(). May return the same location as this iterator.

Definition at line 896 of file Range.hpp.

{
 return Range::const_iterator( mNode, mNode->second );
}

References mNode.

Referenced by moab::Core::adjacencies_iterate(), moab::Core::connect_iterate(), moab::Core::coords_iterate(), moab::BitTag::get_entities_with_bits(), moab::BitTag::get_tagged(), moab::ReadHDF5Dataset::next_end(), moab::ReadHDF5Dataset::read(), and moab::DenseTag::tag_iterate().

operator!=()

bool moab::Range::const_iterator::operator!= ( const const_iterator &  other ) const

inline

not equals operator

Definition at line 555 of file Range.hpp.

 {
 // call == operator and not it.
 return ( mNode != other.mNode ) || ( mValue != other.mValue );
 }

References mNode, and mValue.

operator*()

const EntityHandle& moab::Range::const_iterator::operator* ( ) const

inline

dereference that value this iterator points to returns a const reference

Definition at line 478 of file Range.hpp.

 {
 return mValue;
 }

operator++() [1/2]

const_iterator& moab::Range::const_iterator::operator++ ( )

inline

prefix incrementer

Definition at line 484 of file Range.hpp.

 {
 // see if we need to increment the base iterator
 if( mValue == mNode->second )
 {
 mNode = mNode->mNext;
 mValue = mNode->first;
 }
 // if not, just increment the value in the range
 else
 ++mValue;
 return *this;
 }

operator++() [2/2]

const_iterator moab::Range::const_iterator::operator++ ( int  )

inline

postfix incrementer

Definition at line 499 of file Range.hpp.

 {
 // make a temporary copy
 const_iterator tmp( *this );
 // increment self
 this->operator++();
 // return the copy
 return tmp;
 }

References moab::operator++().

operator+=()

Range::const_iterator & moab::Range::const_iterator::operator+=

(

EntityID

sstep

)

Advance iterator specified amount. Potentially O(n), but typically better. Always more efficient than calling operator++ step times.

advance iterator

Definition at line 92 of file Range.cpp.

{
 // Check negative now to avoid infinite loop below.
 if( sstep < 0 )
 {
 return operator-=( -sstep );
 }
 EntityHandle step = sstep;
 
 // Handle current PairNode. Either step is within the current
 // node or need to remove the remainder of the current node
 // from step.
 EntityHandle this_node_rem = mNode->second - mValue;
 if( this_node_rem >= step )
 {
 mValue += step;
 return *this;
 }
 step -= this_node_rem + 1;
 
 // For each node we are stepping past, decrement step
 // by the size of the node.
 PairNode* node = mNode->mNext;
 EntityHandle node_size = node->second - node->first + 1;
 while( step >= node_size )
 {
 step -= node_size;
 node = node->mNext;
 node_size = node->second - node->first + 1;
 }
 
 // Advance into the resulting node by whatever is
 // left in step.
 mNode = node;
 mValue = mNode->first + step;
 return *this;
}

References moab::Range::PairNode::mNext, mNode, mValue, and operator-=().

operator--() [1/2]

const_iterator& moab::Range::const_iterator::operator-- ( )

inline

prefix decrementer

Definition at line 510 of file Range.hpp.

 {
 // see if we need to decrement the base iterator
 if( mValue == mNode->first )
 {
 mNode = mNode->mPrev;
 ;
 mValue = mNode->second;
 }
 // if not, just decrement the value
 else
 --mValue;
 return *this;
 }

operator--() [2/2]

const_iterator moab::Range::const_iterator::operator-- ( int  )

inline

postfix decrementer

Definition at line 526 of file Range.hpp.

 {
 // make a copy of this
 const_iterator tmp( *this );
 // decrement self
 this->operator--();
 // return the copy
 return tmp;
 }

operator-=()

Range::const_iterator & moab::Range::const_iterator::operator-=

(

EntityID

sstep

)

Regress iterator specified amount. Potentially O(n), but typically better. Always more efficient than calling operator-- step times.

regress iterator

Definition at line 133 of file Range.cpp.

{
 // Check negative now to avoid infinite loop below.
 if( sstep < 0 )
 {
 return operator+=( -sstep );
 }
 EntityHandle step = sstep;
 
 // Handle current PairNode. Either step is within the current
 // node or need to remove the remainder of the current node
 // from step.
 EntityHandle this_node_rem = mValue - mNode->first;
 if( this_node_rem >= step )
 {
 mValue -= step;
 return *this;
 }
 step -= this_node_rem + 1;
 
 // For each node we are stepping past, decrement step
 // by the size of the node.
 PairNode* node = mNode->mPrev;
 EntityHandle node_size = node->second - node->first + 1;
 while( step >= node_size )
 {
 step -= node_size;
 node = node->mPrev;
 node_size = node->second - node->first + 1;
 }
 
 // Advance into the resulting node by whatever is
 // left in step.
 mNode = node;
 mValue = mNode->second - step;
 return *this;
}

References moab::Range::PairNode::mPrev.

Referenced by operator+=().

operator==()

bool moab::Range::const_iterator::operator== ( const const_iterator &  other ) const

inline

equals operator

Definition at line 547 of file Range.hpp.

 {
 // see if the base iterator is the same and the
 // value of this iterator is the same
 return ( mNode == other.mNode ) && ( mValue == other.mValue );
 }

References mNode, and mValue.

start_of_block()

Range::const_iterator moab::Range::const_iterator::start_of_block ( ) const

inline

get an iterator at the start of the block

Get an iterator at the start of the block of consecutive handles that this iterator is currently contained in. That is, if the range contains blocks of consecutive handles of the form { [1,5], [7,100], ... } and this iterator is at any handle in the range [7,100], return an iterator at the '7' handle.

Never returns end() unless this iterator is at end(). May return the same location as this iterator.

Definition at line 901 of file Range.hpp.

{
 return Range::const_iterator( mNode, mNode->first );
}

Referenced by moab::ReadHDF5VarLen::read_offsets().

Friends And Related Function Documentation

const_pair_iterator

friend class const_pair_iterator

friend

Definition at line 463 of file Range.hpp.

operator-

EntityID operator- ( const const_iterator &  it1, const const_iterator &  it2  )

friend

Definition at line 793 of file Range.cpp.

{
 assert( !it2.mValue || *it2 >= *it1 );
 if( it2.mNode == it1.mNode )
 {
 return *it2 - *it1;
 }
 
 EntityID result = it1.mNode->second - it1.mValue + 1;
 for( Range::PairNode* n = it1.mNode->mNext; n != it2.mNode; n = n->mNext )
 result += n->second - n->first + 1;
 if( it2.mValue ) // (it2.mNode != &mHead)
 result += it2.mValue - it2.mNode->first;
 return result;
}

pair_iterator

friend class pair_iterator

friend

Definition at line 462 of file Range.hpp.

Range

friend class Range

friend

Definition at line 461 of file Range.hpp.

Member Data Documentation

mNode

PairNode* moab::Range::const_iterator::mNode

protected

the node we are pointing at

Definition at line 593 of file Range.hpp.

Referenced by end_of_block(), moab::Range::erase(), moab::Range::insert(), moab::Range::lower_bound(), operator!=(), operator+=(), and operator==().

mValue

EntityHandle moab::Range::const_iterator::mValue

protected

the value in the range

Definition at line 595 of file Range.hpp.

Referenced by moab::Range::erase(), operator!=(), operator+=(), and operator==().

---

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

• Range.hpp
• Range.cpp