LLVM  8.0.1
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::df_iterator< GraphT, SetType, ExtStorage, GT > Class Template Reference

#include "llvm/ADT/DepthFirstIterator.h"

Inheritance diagram for llvm::df_iterator< GraphT, SetType, ExtStorage, GT >:
Inheritance graph
[legend]
Collaboration diagram for llvm::df_iterator< GraphT, SetType, ExtStorage, GT >:
Collaboration graph
[legend]

Public Types

using pointer = typename super::pointer
 

Public Member Functions

bool operator== (const df_iterator &x) const
 
bool operator!= (const df_iterator &x) const
 
const NodeRef & operator* () const
 
NodeRef operator-> () const
 
df_iteratoroperator++ ()
 
df_iteratorskipChildren ()
 Skips all children of the current node and traverses to next node. More...
 
df_iterator operator++ (int)
 
bool nodeVisited (NodeRef Node) const
 
unsigned getPathLength () const
 getPathLength - Return the length of the path from the entry node to the current node, counting both nodes. More...
 
NodeRef getPath (unsigned n) const
 getPath - Return the n'th node in the path from the entry node to the current node. More...
 

Static Public Member Functions

static df_iterator begin (const GraphT &G)
 
static df_iterator end (const GraphT &G)
 
static df_iterator begin (const GraphT &G, SetType &S)
 
static df_iterator end (const GraphT &G, SetType &S)
 

Additional Inherited Members

- Public Attributes inherited from llvm::df_iterator_storage< SetType, ExtStorage >
SetType Visited
 

Detailed Description

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
class llvm::df_iterator< GraphT, SetType, ExtStorage, GT >

Definition at line 86 of file DepthFirstIterator.h.

Member Typedef Documentation

◆ pointer

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
using llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::pointer = typename super::pointer

Definition at line 148 of file DepthFirstIterator.h.

Member Function Documentation

◆ begin() [1/2]

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
static df_iterator llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::begin ( const GraphT &  G)
inlinestatic

Definition at line 151 of file DepthFirstIterator.h.

Referenced by llvm::df_begin().

◆ begin() [2/2]

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
static df_iterator llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::begin ( const GraphT &  G,
SetType &  S 
)
inlinestatic

Definition at line 157 of file DepthFirstIterator.h.

◆ end() [1/2]

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
static df_iterator llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::end ( const GraphT &  G)
inlinestatic

Definition at line 154 of file DepthFirstIterator.h.

Referenced by llvm::df_end().

◆ end() [2/2]

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
static df_iterator llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::end ( const GraphT &  G,
SetType &  S 
)
inlinestatic

Definition at line 160 of file DepthFirstIterator.h.

◆ getPath()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
NodeRef llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::getPath ( unsigned  n) const
inline

getPath - Return the n'th node in the path from the entry node to the current node.

Definition at line 211 of file DepthFirstIterator.h.

◆ getPathLength()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
unsigned llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::getPathLength ( ) const
inline

getPathLength - Return the length of the path from the entry node to the current node, counting both nodes.

Definition at line 207 of file DepthFirstIterator.h.

◆ nodeVisited()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
bool llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::nodeVisited ( NodeRef  Node) const
inline

Definition at line 201 of file DepthFirstIterator.h.

◆ operator!=()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
bool llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::operator!= ( const df_iterator< GraphT, SetType, ExtStorage, GT > &  x) const
inline

Definition at line 165 of file DepthFirstIterator.h.

◆ operator*()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
const NodeRef& llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::operator* ( ) const
inline

Definition at line 167 of file DepthFirstIterator.h.

◆ operator++() [1/2]

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
df_iterator& llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::operator++ ( )
inline

Definition at line 175 of file DepthFirstIterator.h.

◆ operator++() [2/2]

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
df_iterator llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::operator++ ( int  )
inline

Definition at line 191 of file DepthFirstIterator.h.

◆ operator->()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
NodeRef llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::operator-> ( ) const
inline

Definition at line 173 of file DepthFirstIterator.h.

◆ operator==()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
bool llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::operator== ( const df_iterator< GraphT, SetType, ExtStorage, GT > &  x) const
inline

Definition at line 162 of file DepthFirstIterator.h.

◆ skipChildren()

template<class GraphT, class SetType = df_iterator_default_set<typename GraphTraits<GraphT>::NodeRef>, bool ExtStorage = false, class GT = GraphTraits<GraphT>>
df_iterator& llvm::df_iterator< GraphT, SetType, ExtStorage, GT >::skipChildren ( )
inline

Skips all children of the current node and traverses to next node.

Note: This function takes care of incrementing the iterator. If you always increment and call this function, you risk walking off the end.

Definition at line 184 of file DepthFirstIterator.h.


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