carl  24.04
Computer ARithmetic Library
Public Types | Public Member Functions | Data Fields | Protected Attributes
carl::tree_detail::PathIterator< T > Struct Template Reference

Iterator class for iterations from a given element to the root. More...

#include <carlTree.h>

Inheritance diagram for carl::tree_detail::PathIterator< T >:
Inheritance graph
[legend]
Collaboration diagram for carl::tree_detail::PathIterator< T >:
Collaboration graph
[legend]

Public Types

using Base = BaseIterator< T, PathIterator< T >, false >
 

Public Member Functions

 PathIterator (const tree< T > *t, std::size_t root)
 
PathIterator & next ()
 
template<typename It >
 PathIterator (const BaseIterator< T, It, false > &ii)
 
 PathIterator (const PathIterator &ii)
 
 PathIterator (PathIterator &&ii)
 
PathIterator & operator= (const PathIterator &it)
 
PathIterator & operator= (PathIterator &&it) noexcept
 
virtual ~PathIterator () noexcept=default
 
const auto & nodes () const
 
const auto & node (std::size_t id) const
 
const auto & curnode () const
 
std::size_t depth () const
 
std::size_t id () const
 
bool isRoot () const
 
bool isValid () const
 
T * operator-> ()
 
T const * operator-> () const
 

Data Fields

std::size_t current
 

Protected Attributes

const tree< T > * mTree
 

Detailed Description

template<typename T>
struct carl::tree_detail::PathIterator< T >

Iterator class for iterations from a given element to the root.

Definition at line 519 of file carlTree.h.

Member Typedef Documentation

◆ Base

template<typename T >
using carl::tree_detail::PathIterator< T >::Base = BaseIterator<T, PathIterator<T>,false>

Definition at line 523 of file carlTree.h.

Constructor & Destructor Documentation

◆ PathIterator() [1/4]

template<typename T >
carl::tree_detail::PathIterator< T >::PathIterator ( const tree< T > *  t,
std::size_t  root 
)
inline

Definition at line 524 of file carlTree.h.

◆ PathIterator() [2/4]

template<typename T >
template<typename It >
carl::tree_detail::PathIterator< T >::PathIterator ( const BaseIterator< T, It, false > &  ii)
inline

Definition at line 533 of file carlTree.h.

◆ PathIterator() [3/4]

template<typename T >
carl::tree_detail::PathIterator< T >::PathIterator ( const PathIterator< T > &  ii)
inline

Definition at line 534 of file carlTree.h.

◆ PathIterator() [4/4]

template<typename T >
carl::tree_detail::PathIterator< T >::PathIterator ( PathIterator< T > &&  ii)
inline

Definition at line 535 of file carlTree.h.

◆ ~PathIterator()

template<typename T >
virtual carl::tree_detail::PathIterator< T >::~PathIterator ( )
virtualdefaultnoexcept

Member Function Documentation

◆ curnode()

const auto& carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::curnode ( ) const
inlineinherited

Definition at line 86 of file carlTree.h.

◆ depth()

std::size_t carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::depth ( ) const
inlineinherited

Definition at line 96 of file carlTree.h.

◆ id()

std::size_t carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::id ( ) const
inlineinherited

Definition at line 99 of file carlTree.h.

◆ isRoot()

bool carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::isRoot ( ) const
inlineinherited

Definition at line 103 of file carlTree.h.

◆ isValid()

bool carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::isValid ( ) const
inlineinherited

Definition at line 106 of file carlTree.h.

◆ next()

template<typename T >
PathIterator& carl::tree_detail::PathIterator< T >::next ( )
inline

Definition at line 525 of file carlTree.h.

Here is the call graph for this function:

◆ node()

const auto& carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::node ( std::size_t  id) const
inlineinherited

Definition at line 82 of file carlTree.h.

◆ nodes()

const auto& carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::nodes ( ) const
inlineinherited

Definition at line 79 of file carlTree.h.

◆ operator->() [1/2]

T* carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::operator-> ( )
inlineinherited

Definition at line 109 of file carlTree.h.

◆ operator->() [2/2]

T const* carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::operator-> ( ) const
inlineinherited

Definition at line 112 of file carlTree.h.

◆ operator=() [1/2]

template<typename T >
PathIterator& carl::tree_detail::PathIterator< T >::operator= ( const PathIterator< T > &  it)
inline

Definition at line 536 of file carlTree.h.

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename T >
PathIterator& carl::tree_detail::PathIterator< T >::operator= ( PathIterator< T > &&  it)
inlinenoexcept

Definition at line 540 of file carlTree.h.

Here is the call graph for this function:

Field Documentation

◆ current

std::size_t carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::current
inherited

Definition at line 89 of file carlTree.h.

◆ mTree

const tree<T>* carl::tree_detail::BaseIterator< T, PathIterator< T > , reverse >::mTree
protectedinherited

Definition at line 76 of file carlTree.h.

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