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

#include <nodeGraphPart.h>

Inheritance diagram for gum::NodeGraphPartIterator:

Collaboration diagram for gum::NodeGraphPartIterator:

Public Types

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

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

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

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

Friends
class	NodeGraphPart

Detailed Description

Unsafe iterator on the node set of a graph.

Definition at line 69 of file nodeGraphPart.h.

Member Typedef Documentation

◆ const_pointer

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

types for STL compliance

Definition at line 80 of file nodeGraphPart.h.

◆ const_reference

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

types for STL compliance

Definition at line 78 of file nodeGraphPart.h.

◆ difference_type

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

types for STL compliance

Definition at line 81 of file nodeGraphPart.h.

◆ iterator_category

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

types for STL compliance

Definition at line 75 of file nodeGraphPart.h.

◆ pointer

using gum::NodeGraphPartIterator::pointer = value_type*

types for STL compliance

Definition at line 79 of file nodeGraphPart.h.

◆ reference

using gum::NodeGraphPartIterator::reference = value_type&

types for STL compliance

Definition at line 77 of file nodeGraphPart.h.

◆ value_type

using gum::NodeGraphPartIterator::value_type = NodeId

types for STL compliance

Definition at line 76 of file nodeGraphPart.h.

Constructor & Destructor Documentation

◆ NodeGraphPartIterator() [1/3]

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

explicitnoexcept

Default constructor.

default constructor

Definition at line 76 of file nodeGraphPart_inl.h.

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

References NodeGraphPartIterator(), NodeGraphPart, and nodes_.

Referenced by NodeGraphPartIterator(), NodeGraphPartIterator(), NodeGraphPartIterator(), gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe(), gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe(), gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe(), ~NodeGraphPartIterator(), operator++(), operator=(), operator=(), and operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NodeGraphPartIterator() [2/3]

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

noexcept

copy constructor

Definition at line 82 of file nodeGraphPart_inl.h.

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

References NodeGraphPartIterator(), nodes_, pos_, and valid_.

Here is the call graph for this function:

◆ NodeGraphPartIterator() [3/3]

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

noexcept

move constructor

Definition at line 88 of file nodeGraphPart_inl.h.

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

References NodeGraphPartIterator(), nodes_, pos_, and valid_.

Here is the call graph for this function:

◆ ~NodeGraphPartIterator()

INLINE gum::NodeGraphPartIterator::~NodeGraphPartIterator ( )

virtualnoexcept

destructor

Definition at line 94 of file nodeGraphPart_inl.h.

                                                                {
    GUM_DESTRUCTOR(NodeGraphPartIterator);
  }

References NodeGraphPartIterator().

Here is the call graph for this function:

Member Function Documentation

◆ operator*()

INLINE NodeId gum::NodeGraphPartIterator::operator* ( ) const

dereferencing operator

Definition at line 134 of file nodeGraphPart_inl.h.

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

References GUM_ERROR, pos_, and valid_.

◆ operator++()

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

noexcept

increment the iterator

Definition at line 127 of file nodeGraphPart_inl.h.

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

References NodeGraphPartIterator(), pos_, and validate_().

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 100 of file nodeGraphPart_inl.h.

                                                                             {
    nodes_ = it.nodes_;
    pos_   = it.pos_;
    valid_ = it.valid_;
    GUM_OP_CPY(NodeGraphPartIterator);
 
    return *this;
  }

References NodeGraphPartIterator(), nodes_, pos_, and valid_.

Referenced by gum::NodeGraphPartIteratorSafe::operator=(), and gum::NodeGraphPartIteratorSafe::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

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

noexcept

move assignment operator

Definition at line 111 of file nodeGraphPart_inl.h.

                                                                        {
    nodes_ = it.nodes_;
    pos_   = it.pos_;
    valid_ = it.valid_;
    GUM_OP_MOV(NodeGraphPartIterator);
 
    return *this;
  }

References NodeGraphPartIterator(), nodes_, pos_, and valid_.

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 122 of file nodeGraphPart_inl.h.

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

References NodeGraphPartIterator(), nodes_, pos_, and valid_.

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 141 of file nodeGraphPart_inl.h.

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

References nodes_, pos_, and valid_.

◆ validate_()

INLINE void gum::NodeGraphPartIterator::validate_ ( )

protectednoexcept

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

Definition at line 59 of file nodeGraphPart_inl.h.

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

References nodes_, pos_, and valid_.

Referenced by gum::NodeGraphPart::begin(), gum::NodeGraphPart::beginSafe(), and operator++().

Here is the caller graph for this function:

◆ NodeGraphPart

friend class NodeGraphPart

friend

Definition at line 70 of file nodeGraphPart.h.

References NodeGraphPart.

Referenced by NodeGraphPartIterator(), and NodeGraphPart.

Member Data Documentation

◆ nodes_

const NodeGraphPart* gum::NodeGraphPartIterator::nodes_

protected

the nodegraphpart on which points the iterator

Definition at line 136 of file nodeGraphPart.h.

Referenced by NodeGraphPartIterator(), NodeGraphPartIterator(), NodeGraphPartIterator(), gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe(), gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe(), operator=(), operator=(), operator==(), setPos_(), validate_(), and gum::NodeGraphPartIteratorSafe::whenNodeDeleted().

◆ pos_

NodeId gum::NodeGraphPartIterator::pos_ {0}

protected

the nodeid on which the iterator points currently

Definition at line 139 of file nodeGraphPart.h.

139{0};

Referenced by NodeGraphPartIterator(), NodeGraphPartIterator(), operator*(), operator++(), operator=(), operator=(), operator==(), setPos_(), validate_(), and gum::NodeGraphPartIteratorSafe::whenNodeDeleted().

◆ valid_

bool gum::NodeGraphPartIterator::valid_ {false}

protected

Definition at line 142 of file nodeGraphPart.h.

142{false};

Referenced by NodeGraphPartIterator(), NodeGraphPartIterator(), operator*(), operator=(), operator=(), operator==(), setPos_(), validate_(), and gum::NodeGraphPartIteratorSafe::whenNodeDeleted().

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

agrum/base/graphs/parts/nodeGraphPart.h
agrum/base/graphs/parts/nodeGraphPart_inl.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_pointer

◆ const_reference

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ NodeGraphPartIterator() [1/3]

◆ NodeGraphPartIterator() [2/3]

◆ NodeGraphPartIterator() [3/3]

◆ ~NodeGraphPartIterator()

Member Function Documentation

◆ operator*()

◆ operator++()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ setPos_()

◆ validate_()

Friends And Related Symbol Documentation

◆ NodeGraphPart

Member Data Documentation

◆ nodes_

◆ pos_

◆ valid_