tim::graph< T, AllocatorT >::iterator_base Class Reference

Base class for iterators, only pointers stored, no traversal logic. More...

#include "timemory/storage/graph.hpp"

Collaboration diagram for tim::graph< T, AllocatorT >::iterator_base:

Public Types
typedef T	value_type
typedef T *	pointer
typedef T &	reference
typedef size_t	size_type
typedef ptrdiff_t	difference_type
typedef std::bidirectional_iterator_tag	iterator_category

Public Member Functions
	iterator_base ()
	iterator_base (graph_node *)
	iterator_base (const iterator_base &)=default
	iterator_base (iterator_base &&) noexcept=default
iterator_base &	operator= (const iterator_base &)=default
iterator_base &	operator= (iterator_base &&) noexcept=default
	operator bool () const
T &	operator* () const
T *	operator-> () const
void	skip_children ()
	When called, the next increment/decrement skips children of this node. More...
void	skip_children (bool skip)
unsigned int	number_of_children () const
	Number of children of the node pointed to by the iterator. More...
sibling_iterator	begin () const
sibling_iterator	end () const

Public Attributes
graph_node *	node = nullptr

Protected Attributes
bool	m_skip_current_children = false

Detailed Description

template<typename T, typename AllocatorT>
class tim::graph< T, AllocatorT >::iterator_base

Base class for iterators, only pointers stored, no traversal logic.

Definition at line 138 of file graph.hpp.

Member Typedef Documentation

difference_type

template<typename T , typename AllocatorT >

typedef ptrdiff_t tim::graph< T, AllocatorT >::iterator_base::difference_type

Definition at line 145 of file graph.hpp.

iterator_category

template<typename T , typename AllocatorT >

typedef std::bidirectional_iterator_tag tim::graph< T, AllocatorT >::iterator_base::iterator_category

Definition at line 146 of file graph.hpp.

pointer

template<typename T , typename AllocatorT >

typedef T* tim::graph< T, AllocatorT >::iterator_base::pointer

Definition at line 142 of file graph.hpp.

reference

template<typename T , typename AllocatorT >

typedef T& tim::graph< T, AllocatorT >::iterator_base::reference

Definition at line 143 of file graph.hpp.

size_type

template<typename T , typename AllocatorT >

typedef size_t tim::graph< T, AllocatorT >::iterator_base::size_type

Definition at line 144 of file graph.hpp.

value_type

template<typename T , typename AllocatorT >

typedef T tim::graph< T, AllocatorT >::iterator_base::value_type

Definition at line 141 of file graph.hpp.

Constructor & Destructor Documentation

iterator_base() [1/4]

template<typename T , typename AllocatorT >

tim::graph< T, AllocatorT >::iterator_base::iterator_base

Definition at line 2412 of file graph.hpp.

: node(nullptr)
 
{}

iterator_base() [2/4]

template<typename T , typename AllocatorT >

tim::graph< T, AllocatorT >::iterator_base::iterator_base

(

graph_node *

tn

)

Definition at line 2420 of file graph.hpp.

: node(tn)
 
{}

iterator_base() [3/4]

template<typename T , typename AllocatorT >

tim::graph< T, AllocatorT >::iterator_base::iterator_base ( const iterator_base &  )

default

iterator_base() [4/4]

template<typename T , typename AllocatorT >

tim::graph< T, AllocatorT >::iterator_base::iterator_base ( iterator_base &&  )

defaultnoexcept

Member Function Documentation

begin()

template<typename T , typename AllocatorT >

graph< T, AllocatorT >::sibling_iterator tim::graph< T, AllocatorT >::iterator_base::begin

Definition at line 2507 of file graph.hpp.

{
    if(node->first_child == nullptr)
        return end();
 
    sibling_iterator ret(node->first_child);
    ret.m_parent = this->node;
    return ret;
}

References tim::graph< T, AllocatorT >::end(), and tim::graph< T, AllocatorT >::sibling_iterator::m_parent.

Referenced by tim::graph< T, AllocatorT >::graph(), tim::graph< T, AllocatorT >::empty(), tim::graph< T, AllocatorT >::equal_subgraph(), tim::graph< T, AllocatorT >::merge(), and tim::graph< T, AllocatorT >::serialize().

end()

template<typename T , typename AllocatorT >

graph< T, AllocatorT >::sibling_iterator tim::graph< T, AllocatorT >::iterator_base::end

Definition at line 2521 of file graph.hpp.

{
    sibling_iterator ret(nullptr);
    ret.m_parent = node;
    return ret;
}

References tim::graph< T, AllocatorT >::sibling_iterator::m_parent.

Referenced by tim::graph< T, AllocatorT >::begin(), tim::graph< T, AllocatorT >::empty(), tim::graph< T, AllocatorT >::equal_subgraph(), tim::graph< T, AllocatorT >::merge(), tim::graph< T, AllocatorT >::reparent(), and tim::graph< T, AllocatorT >::serialize().

number_of_children()

template<typename T , typename AllocatorT >

unsigned int tim::graph< T, AllocatorT >::iterator_base::number_of_children

Number of children of the node pointed to by the iterator.

Definition at line 2550 of file graph.hpp.

{
    graph_node* pos = node->first_child;
    if(pos == nullptr)
        return 0;
 
    unsigned int ret = 1;
    while(pos != node->last_child)
    {
        ++ret;
        pos = pos->next_sibling;
    }
    return ret;
}

References tim::pos.

Referenced by tim::graph< T, AllocatorT >::equal(), and tim::graph< T, AllocatorT >::equal_subgraph().

operator bool()

template<typename T , typename AllocatorT >

tim::graph< T, AllocatorT >::iterator_base::operator bool ( ) const

inline

Definition at line 159 of file graph.hpp.

{ return node != nullptr; }

operator*()

template<typename T , typename AllocatorT >

T & tim::graph< T, AllocatorT >::iterator_base::operator*

Definition at line 2428 of file graph.hpp.

{
    return node->data;
}

operator->()

template<typename T , typename AllocatorT >

T * tim::graph< T, AllocatorT >::iterator_base::operator->

Definition at line 2436 of file graph.hpp.

{
    return &(node->data);
}

operator=() [1/2]

template<typename T , typename AllocatorT >

iterator_base & tim::graph< T, AllocatorT >::iterator_base::operator= ( const iterator_base &  )

default

operator=() [2/2]

template<typename T , typename AllocatorT >

iterator_base & tim::graph< T, AllocatorT >::iterator_base::operator= ( iterator_base &&  )

defaultnoexcept

skip_children() [1/2]

template<typename T , typename AllocatorT >

void tim::graph< T, AllocatorT >::iterator_base::skip_children

When called, the next increment/decrement skips children of this node.

Definition at line 2532 of file graph.hpp.

{
    m_skip_current_children = true;
}

Referenced by tim::graph< T, AllocatorT >::pre_order_iterator::pre_order_iterator().

skip_children() [2/2]

template<typename T , typename AllocatorT >

void tim::graph< T, AllocatorT >::iterator_base::skip_children

(

bool

skip

)

Definition at line 2541 of file graph.hpp.

{
    m_skip_current_children = skip;
}

Member Data Documentation

m_skip_current_children

template<typename T , typename AllocatorT >

bool tim::graph< T, AllocatorT >::iterator_base::m_skip_current_children = false

protected

Definition at line 182 of file graph.hpp.

node

template<typename T , typename AllocatorT >

graph_node* tim::graph< T, AllocatorT >::iterator_base::node = nullptr

Definition at line 178 of file graph.hpp.

Referenced by tim::graph< T, AllocatorT >::pre_order_iterator::pre_order_iterator(), tim::graph< T, AllocatorT >::child(), tim::graph< T, AllocatorT >::depth(), tim::graph< T, AllocatorT >::erase_children(), tim::graph< T, AllocatorT >::index(), tim::graph< T, AllocatorT >::is_head(), tim::graph< T, AllocatorT >::is_valid(), tim::graph< T, AllocatorT >::move_in(), tim::graph< T, AllocatorT >::move_out(), tim::graph< T, AllocatorT >::number_of_children(), tim::graph< T, AllocatorT >::number_of_siblings(), tim::graph< T, AllocatorT >::pre_order_iterator::operator!=(), tim::graph< T, AllocatorT >::sibling_iterator::operator!=(), tim::graph< T, AllocatorT >::pre_order_iterator::operator==(), tim::graph< T, AllocatorT >::sibling_iterator::operator==(), tim::graph< T, AllocatorT >::reduce(), tim::graph< T, AllocatorT >::reparent(), tim::graph< T, AllocatorT >::replace(), tim::graph< T, AllocatorT >::sibling(), and tim::graph< T, AllocatorT >::swap().

---

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

• timemory/storage/graph.hpp