mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation fixes

Browse Source
This commit is contained in:
Amanda Stjerna 2024-05-13 14:02:14 +02:00
parent b1ace388c0
commit d2a01760bc
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
compiler/rustc_data_structures/src/graph/scc/mod.rs
View File

@ -250,17 +250,17 @@ enum NodeState<N, S, A> {
NotVisited, NotVisited,
/// This node is currently being walked as part of our DFS. It is on /// This node is currently being walked as part of our DFS. It is on
/// the stack at the depth `depth` and the heaviest node on the way /// the stack at the depth `depth` and its current annotation is
/// there is `max_weigth_on_path`. /// `annotation`.
/// ///
/// After SCC construction is complete, this state ought to be /// After SCC construction is complete, this state ought to be
/// impossible. /// impossible.
BeingVisited { depth: usize, annotation: A }, BeingVisited { depth: usize, annotation: A },
/// Indicates that this node is a member of the given cycle where /// Indicates that this node is a member of the given cycle where
/// the weight of the heaviest node is `cycle_max_weight`. /// the merged annotation is `annotation`.
/// Note that an SCC can have several cycles, so the max /// Note that an SCC can have several cycles, so its final annotation
/// weight of an SCC is the max weight of all its cycles. /// is the merged value of all its member annotations.
InCycle { scc_index: S, annotation: A }, InCycle { scc_index: S, annotation: A },
/// Indicates that this node is a member of whatever cycle /// Indicates that this node is a member of whatever cycle
@ -304,9 +304,8 @@ impl<'c, G, S, A, F> SccsConstruction<'c, G, S, A, F>
/// D' (i.e., D' < D), we know that N, N', and all nodes in /// D' (i.e., D' < D), we know that N, N', and all nodes in
/// between them on the stack are part of an SCC. /// between them on the stack are part of an SCC.
/// ///
/// Additionally, we keep track of a representative of the SCC with the highest /// Additionally, we keep track of a representative annotation of the
/// reachable weight for all SCCs, for some arbitrary ordering function that assigns /// SCC.
/// a weight to nodes.
/// ///
/// [wikipedia]: https://bit.ly/2EZIx84 /// [wikipedia]: https://bit.ly/2EZIx84
fn construct(graph: &'c G, to_annotation: F) -> Sccs<G::Node, S, A> { fn construct(graph: &'c G, to_annotation: F) -> Sccs<G::Node, S, A> {