maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

SCC: Doxygen-ize comments, NFC 

<rdar://problem/14292693>

llvm-svn: 207251
This commit is contained in:
Duncan P. N. Exon Smith 2014-04-25 18:18:46 +00:00
parent d2d9b76e48
commit f4e1d6fd06
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
llvm/include/llvm/ADT/SCCIterator.h
View File

@ -47,7 +47,7 @@ class scc_iterator
typedef typename super::reference reference; typedef typename super::reference reference;
typedef typename super::pointer pointer; typedef typename super::pointer pointer;
// Element of VisitStack during DFS. /// Element of VisitStack during DFS.
struct StackElement { struct StackElement {
NodeType *Node; ///< The current node pointer. NodeType *Node; ///< The current node pointer.
ChildItTy NextChild; ///< The next child, modified inplace during DFS. ChildItTy NextChild; ///< The next child, modified inplace during DFS.
@ -63,30 +63,30 @@ class scc_iterator
} }
}; };
// The visit counters used to detect when a complete SCC is on the stack. /// The visit counters used to detect when a complete SCC is on the stack.
// visitNum is the global counter. /// visitNum is the global counter.
// nodeVisitNumbers are per-node visit numbers, also used as DFS flags. ///
/// nodeVisitNumbers are per-node visit numbers, also used as DFS flags.
unsigned visitNum; unsigned visitNum;
DenseMap<NodeType *, unsigned> nodeVisitNumbers; DenseMap<NodeType *, unsigned> nodeVisitNumbers;
// Stack holding nodes of the SCC. /// Stack holding nodes of the SCC.
std::vector<NodeType *> SCCNodeStack; std::vector<NodeType *> SCCNodeStack;
// The current SCC, retrieved using operator*(). /// The current SCC, retrieved using operator*().
SccTy CurrentSCC; SccTy CurrentSCC;
/// DFS stack, Used to maintain the ordering. The top contains the current
// DFS stack, Used to maintain the ordering. The top contains the current /// node, the next child to visit, and the minimum uplink value of all child
// node, the next child to visit, and the minimum uplink value of all child
std::vector<StackElement> VisitStack; std::vector<StackElement> VisitStack;
// A single "visit" within the non-recursive DFS traversal. /// A single "visit" within the non-recursive DFS traversal.
void DFSVisitOne(NodeType *N); void DFSVisitOne(NodeType *N);
// The stack-based DFS traversal; defined below. /// The stack-based DFS traversal; defined below.
void DFSVisitChildren(); void DFSVisitChildren();
// Compute the next SCC using the DFS traversal. /// Compute the next SCC using the DFS traversal.
void GetNextSCC(); void GetNextSCC();
scc_iterator(NodeType *entryN) : visitNum(0) { scc_iterator(NodeType *entryN) : visitNum(0) {
@ -94,7 +94,7 @@ class scc_iterator
GetNextSCC(); GetNextSCC();
} }
// End is when the DFS stack is empty. /// End is when the DFS stack is empty.
scc_iterator() {} scc_iterator() {}
public: public: