gum::NodeGraphPartIterator Class Reference

Unsafe iterator on the node set of a graph. More...

#include <nodeGraphPart.h>

Inheritance diagram for gum::NodeGraphPartIterator:

Collaboration diagram for gum::NodeGraphPartIterator:

Public Member Functions
Constructors / Destructors
	NodeGraphPartIterator (const NodeGraphPart &nodes) noexcept
	Default constructor. More...
	NodeGraphPartIterator (const NodeGraphPartIterator &it) noexcept
	copy constructor More...
	NodeGraphPartIterator (NodeGraphPartIterator &&it) noexcept
	move constructor More...
virtual	~NodeGraphPartIterator () noexcept
	destructor More...
Operators
NodeGraphPartIterator &	operator= (const NodeGraphPartIterator &it) noexcept
	copy assignment operator More...
NodeGraphPartIterator &	operator= (NodeGraphPartIterator &&it) noexcept
	move assignment operator More...
bool	operator== (const NodeGraphPartIterator &it) const noexcept
	checks whether two iterators point toward the same node More...
bool	operator!= (const NodeGraphPartIterator &it) const noexcept
	checks whether two iterators point toward different nodes More...
NodeGraphPartIterator &	operator++ () noexcept
	increment the iterator More...
value_type	operator* () const
	dereferencing operator More...

Public Types
using	iterator_category = std::forward_iterator_tag
	types for STL compliance More...
using	value_type = NodeId
	types for STL compliance More...
using	reference = value_type &
	types for STL compliance More...
using	const_reference = const value_type &
	types for STL compliance More...
using	pointer = value_type *
	types for STL compliance More...
using	const_pointer = const value_type *
	types for STL compliance More...
using	difference_type = std::ptrdiff_t
	types for STL compliance More...

Protected Attributes
const NodeGraphPart *	nodes_
	the nodegraphpart on which points the iterator More...
NodeId	pos_ {0}
	the nodeid on which the iterator points currently More...
bool	valid_ {false}

Protected Member Functions
void	setPos_ (NodeId id) noexcept
	this function is used by NodeGraphPart to update More...
void	validate_ () noexcept
	ensure that the nodeId is either end() either a valid NodeId More...

Friends
class	NodeGraphPart

Detailed Description

Unsafe iterator on the node set of a graph.

Definition at line 57 of file nodeGraphPart.h.

Member Typedef Documentation

const_pointer

using gum::NodeGraphPartIterator::const_pointer = const value_type*

types for STL compliance

Definition at line 68 of file nodeGraphPart.h.

const_reference

using gum::NodeGraphPartIterator::const_reference = const value_type&

types for STL compliance

Definition at line 66 of file nodeGraphPart.h.

difference_type

using gum::NodeGraphPartIterator::difference_type = std::ptrdiff_t

types for STL compliance

Definition at line 69 of file nodeGraphPart.h.

iterator_category

using gum::NodeGraphPartIterator::iterator_category = std::forward_iterator_tag

types for STL compliance

Definition at line 63 of file nodeGraphPart.h.

pointer

using gum::NodeGraphPartIterator::pointer = value_type*

types for STL compliance

Definition at line 67 of file nodeGraphPart.h.

reference

using gum::NodeGraphPartIterator::reference = value_type&

types for STL compliance

Definition at line 65 of file nodeGraphPart.h.

value_type

using gum::NodeGraphPartIterator::value_type = NodeId

types for STL compliance

Definition at line 64 of file nodeGraphPart.h.

Constructor & Destructor Documentation

NodeGraphPartIterator() [1/3]

INLINE gum::NodeGraphPartIterator::NodeGraphPartIterator ( const NodeGraphPart &  nodes )

noexcept

Default constructor.

default constructor

Definition at line 54 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                  :
      nodes_(&nodes) {
    GUM_CONSTRUCTOR(NodeGraphPartIterator);
  }

Here is the call graph for this function:

NodeGraphPartIterator() [2/3]

INLINE gum::NodeGraphPartIterator::NodeGraphPartIterator ( const NodeGraphPartIterator &  it )

noexcept

copy constructor

Definition at line 60 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                              :
      nodes_(it.nodes_), pos_(it.pos_), valid_(it.valid_) {
    GUM_CONS_CPY(NodeGraphPartIterator);
  }

Here is the call graph for this function:

NodeGraphPartIterator() [3/3]

INLINE gum::NodeGraphPartIterator::NodeGraphPartIterator ( NodeGraphPartIterator &&  it )

noexcept

move constructor

Definition at line 66 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         :
      nodes_(it.nodes_), pos_(it.pos_), valid_(it.valid_) {
    GUM_CONS_MOV(NodeGraphPartIterator);
  }

Here is the call graph for this function:

~NodeGraphPartIterator()

INLINE gum::NodeGraphPartIterator::~NodeGraphPartIterator ( )

virtualnoexcept

destructor

Definition at line 72 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                {
    GUM_DESTRUCTOR(NodeGraphPartIterator);
  }

Here is the call graph for this function:

Member Function Documentation

operator!=()

INLINE bool gum::NodeGraphPartIterator::operator!= ( const NodeGraphPartIterator &  it ) const

noexcept

checks whether two iterators point toward different nodes

Definition at line 106 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                       {
    return !(operator==(it));
  }

Here is the call graph for this function:

operator*()

INLINE NodeId gum::NodeGraphPartIterator::operator*

(

)

const

dereferencing operator

Definition at line 118 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                       {
    if (!valid_) { GUM_ERROR(UndefinedIteratorValue, "This iterator is not valid !") }

    return pos_;
  }

Here is the call graph for this function:

operator++()

INLINE NodeGraphPartIterator & gum::NodeGraphPartIterator::operator++ ( )

noexcept

increment the iterator

Definition at line 111 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                           {
    ++pos_;
    validate_();
    return *this;
  }

Here is the call graph for this function:

operator=() [1/2]

INLINE NodeGraphPartIterator & gum::NodeGraphPartIterator::operator= ( const NodeGraphPartIterator &  it )

noexcept

copy assignment operator

Definition at line 78 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                              {
    nodes_ = it.nodes_;
    pos_   = it.pos_;
    valid_ = it.valid_;
    GUM_OP_CPY(NodeGraphPartIterator);

    return *this;
  }

Here is the call graph for this function:

operator=() [2/2]

INLINE NodeGraphPartIterator & gum::NodeGraphPartIterator::operator= ( NodeGraphPartIterator &&  it )

noexcept

move assignment operator

Definition at line 89 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                         {
    nodes_ = it.nodes_;
    pos_   = it.pos_;
    valid_ = it.valid_;
    GUM_OP_MOV(NodeGraphPartIterator);

    return *this;
  }

Here is the call graph for this function:

operator==()

INLINE bool gum::NodeGraphPartIterator::operator== ( const NodeGraphPartIterator &  it ) const

noexcept

checks whether two iterators point toward the same node

Definition at line 100 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                       {
    return ((pos_ == it.pos_) && (valid_ == it.valid_) && (nodes_ == it.nodes_));
  }

Here is the call graph for this function:

setPos_()

INLINE void gum::NodeGraphPartIterator::setPos_ ( NodeId  id )

protectednoexcept

this function is used by NodeGraphPart to update

Definition at line 125 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    pos_ = id;

    if (pos_ >= nodes_->bound()) {
      pos_   = nodes_->bound();
      valid_ = false;
    } else {
      valid_ = nodes_->exists(pos_);
    }
  }

Here is the call graph for this function:

validate_()

INLINE void gum::NodeGraphPartIterator::validate_ ( )

protectednoexcept

ensure that the nodeId is either end() either a valid NodeId

Definition at line 37 of file nodeGraphPart_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                        {
    valid_ = false;

    if (pos_ > nodes_->bound()) { pos_ = nodes_->bound(); }

    while (pos_ < nodes_->bound()) {
      if (!nodes_->_inHoles_(pos_)) {
        valid_ = true;
        return;
      }

      ++pos_;
    }
  }

Here is the call graph for this function:

Friends And Related Function Documentation

NodeGraphPart

friend class NodeGraphPart

friend

Definition at line 58 of file nodeGraphPart.h.

Member Data Documentation

nodes_

const NodeGraphPart* gum::NodeGraphPartIterator::nodes_

protected

the nodegraphpart on which points the iterator

Definition at line 126 of file nodeGraphPart.h.

pos_

NodeId gum::NodeGraphPartIterator::pos_ {0}

protected

the nodeid on which the iterator points currently

Definition at line 129 of file nodeGraphPart.h.

valid_

bool gum::NodeGraphPartIterator::valid_ {false}

protected

Definition at line 132 of file nodeGraphPart.h.

---

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

• agrum/tools/graphs/parts/nodeGraphPart.h
• agrum/tools/graphs/parts/nodeGraphPart_inl.h