|
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Compute dominators of a control-flow graph."><title>petgraph::algo::dominators - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="petgraph" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../petgraph/index.html">petgraph</a><span class="version">0.6.4</span></h2></div><h2 class="location"><a href="#">Module dominators</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In petgraph::algo</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../petgraph/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">petgraph</a>::<wbr><a href="../index.html">algo</a>::<wbr><a class="mod" href="#">dominators</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/petgraph/algo/dominators.rs.html#1-330">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Compute dominators of a control-flow graph.</p>
|
|
|
<h2 id="the-dominance-relation"><a href="#the-dominance-relation">The Dominance Relation</a></h2>
|
|
|
<p>In a directed graph with a root node <strong>R</strong>, a node <strong>A</strong> is said to <em>dominate</em> a
|
|
|
node <strong>B</strong> iff every path from <strong>R</strong> to <strong>B</strong> contains <strong>A</strong>.</p>
|
|
|
<p>The node <strong>A</strong> is said to <em>strictly dominate</em> the node <strong>B</strong> iff <strong>A</strong> dominates
|
|
|
<strong>B</strong> and <strong>A ≠ B</strong>.</p>
|
|
|
<p>The node <strong>A</strong> is said to be the <em>immediate dominator</em> of a node <strong>B</strong> iff it
|
|
|
strictly dominates <strong>B</strong> and there does not exist any node <strong>C</strong> where <strong>A</strong>
|
|
|
dominates <strong>C</strong> and <strong>C</strong> dominates <strong>B</strong>.</p>
|
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.DominatedByIter.html" title="struct petgraph::algo::dominators::DominatedByIter">DominatedByIter</a></div><div class="desc docblock-short">Iterator for nodes dominated by a given node.</div></li><li><div class="item-name"><a class="struct" href="struct.Dominators.html" title="struct petgraph::algo::dominators::Dominators">Dominators</a></div><div class="desc docblock-short">The dominance relation for some graph and root.</div></li><li><div class="item-name"><a class="struct" href="struct.DominatorsIter.html" title="struct petgraph::algo::dominators::DominatorsIter">DominatorsIter</a></div><div class="desc docblock-short">Iterator for a node’s dominators.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.simple_fast.html" title="fn petgraph::algo::dominators::simple_fast">simple_fast</a></div><div class="desc docblock-short">This is an implementation of the engineered <a href="http://www.cs.rice.edu/~keith/EMBED/dom.pdf">“Simple, Fast Dominance
|
|
|
Algorithm”</a> discovered by Cooper et al.</div></li></ul></section></div></main></body></html> |