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 58 of file nodeGraphPart.h.

Member Typedef Documentation

const_pointer

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

types for STL compliance

Definition at line 69 of file nodeGraphPart.h.

const_reference

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

types for STL compliance

Definition at line 67 of file nodeGraphPart.h.

difference_type

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

types for STL compliance

Definition at line 70 of file nodeGraphPart.h.

iterator_category

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

types for STL compliance

Definition at line 64 of file nodeGraphPart.h.

pointer

using gum::NodeGraphPartIterator::pointer = value_type*

types for STL compliance

Definition at line 68 of file nodeGraphPart.h.

reference

using gum::NodeGraphPartIterator::reference = value_type&

types for STL compliance

Definition at line 66 of file nodeGraphPart.h.

value_type

using gum::NodeGraphPartIterator::value_type = NodeId

types for STL compliance

Definition at line 65 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 55 of file nodeGraphPart_inl.h.

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

NodeGraphPartIterator() [2/3]

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

noexcept

copy constructor

Definition at line 63 of file nodeGraphPart_inl.h.

                                               :
      _nodes(it._nodes),
      _pos(it._pos), _valid(it._valid) {
    GUM_CONS_CPY(NodeGraphPartIterator);
  }

NodeGraphPartIterator() [3/3]

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

noexcept

move constructor

Definition at line 72 of file nodeGraphPart_inl.h.

                                          :
      _nodes(it._nodes),
      _pos(it._pos), _valid(it._valid) {
    GUM_CONS_MOV(NodeGraphPartIterator);
  }

~NodeGraphPartIterator()

INLINE gum::NodeGraphPartIterator::~NodeGraphPartIterator ( )

virtualnoexcept

destructor

Definition at line 80 of file nodeGraphPart_inl.h.

References operator=().

                                                                {
    GUM_DESTRUCTOR(NodeGraphPartIterator);
  }

Here is the call graph for this function:

Member Function Documentation

_setPos()

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

protectednoexcept

this function is used by NodeGraphPart to update

Definition at line 137 of file nodeGraphPart_inl.h.

References _nodes, _pos, _valid, gum::NodeGraphPart::bound(), and gum::NodeGraphPart::exists().

                                                               {
    _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 38 of file nodeGraphPart_inl.h.

References gum::NodeGraphPart::__inHoles(), _nodes, _pos, _valid, and gum::NodeGraphPart::bound().

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

                                                        {
    _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:

Here is the caller graph for this function:

operator!=()

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

noexcept

checks whether two iterators point toward different nodes

Definition at line 115 of file nodeGraphPart_inl.h.

References operator==().

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

Here is the call graph for this function:

operator*()

INLINE NodeId gum::NodeGraphPartIterator::operator*

(

)

const

dereferencing operator

Definition at line 128 of file nodeGraphPart_inl.h.

References _pos, _valid, and GUM_ERROR.

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

    return _pos;
  }

operator++()

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

noexcept

increment the iterator

Definition at line 121 of file nodeGraphPart_inl.h.

References _pos, and _validate().

                                                                           {
    ++_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 86 of file nodeGraphPart_inl.h.

References _nodes, _pos, and _valid.

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

                                                                                    {
    _nodes = it._nodes;
    _pos = it._pos;
    _valid = it._valid;
    GUM_OP_CPY(NodeGraphPartIterator);

    return *this;
  }

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

References _nodes, _pos, and _valid.

                                                                               {
    _nodes = it._nodes;
    _pos = it._pos;
    _valid = it._valid;
    GUM_OP_MOV(NodeGraphPartIterator);

    return *this;
  }

operator==()

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

noexcept

checks whether two iterators point toward the same node

Definition at line 108 of file nodeGraphPart_inl.h.

References _nodes, _pos, and _valid.

Referenced by operator!=(), and gum::NodeGraphPart::operator!=().

              {
    return ((_pos == it._pos) && (_valid == it._valid) && (_nodes == it._nodes));
  }

Here is the caller graph for this function:

Friends And Related Function Documentation

NodeGraphPart

friend class NodeGraphPart

friend

Definition at line 59 of file nodeGraphPart.h.

Member Data Documentation

_nodes

const NodeGraphPart* gum::NodeGraphPartIterator::_nodes

protected

the nodegraphpart on which points the iterator

Definition at line 127 of file nodeGraphPart.h.

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

_pos

NodeId gum::NodeGraphPartIterator::_pos {0}

protected

the nodeid on which the iterator points currently

Definition at line 130 of file nodeGraphPart.h.

Referenced by _setPos(), _validate(), operator*(), operator++(), operator=(), and operator==().

_valid

bool gum::NodeGraphPartIterator::_valid {false}

protected

Definition at line 133 of file nodeGraphPart.h.

Referenced by _setPos(), _validate(), operator*(), operator=(), and operator==().

---

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

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