177 lines
No EOL
11 KiB
HTML
177 lines
No EOL
11 KiB
HTML
<!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="API documentation for the Rust `depth_first_search` fn in crate `petgraph`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, depth_first_search">
|
||
|
||
<title>petgraph::visit::depth_first_search - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
||
<script src="../../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc fn">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'><a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a></p><script>window.sidebarCurrent = {name: 'depth_first_search', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../../theme.js"></script>
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a>::<wbr><a class="fn" href=''>depth_first_search</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/petgraph/visit/dfsvisit.rs.html#148-162' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust fn'>pub fn depth_first_search<G, I, F, C>(graph: G, starts: I, visitor: F) -> C <span class="where fmt-newline">where<br> G: <a class="trait" href="../../petgraph/visit/trait.IntoNeighbors.html" title="trait petgraph::visit::IntoNeighbors">IntoNeighbors</a> + <a class="trait" href="../../petgraph/visit/trait.Visitable.html" title="trait petgraph::visit::Visitable">Visitable</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="../../petgraph/visit/enum.DfsEvent.html" title="enum petgraph::visit::DfsEvent">DfsEvent</a><G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>>) -> C,<br> C: <a class="trait" href="../../petgraph/visit/trait.ControlFlow.html" title="trait petgraph::visit::ControlFlow">ControlFlow</a>, </span></pre><div class='docblock'><p>A recursive depth first search.</p>
|
||
<p>Starting points are the nodes in the iterator <code>starts</code> (specify just one
|
||
start vertex <em>x</em> by using <code>Some(x)</code>).</p>
|
||
<p>The traversal emits discovery and finish events for each reachable vertex,
|
||
and edge classification of each reachable edge. <code>visitor</code> is called for each
|
||
event, see <a href="enum.DfsEvent.html"><code>DfsEvent</code></a> for possible values.</p>
|
||
<p>If the return value of the visitor is simply <code>()</code>, the visit runs until it
|
||
is finished. If the return value is a <code>Control<B></code>, it can be used to
|
||
break the visit early, and the last control value is returned by the
|
||
function.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<p>Find a path from vertex 0 to 5, and exit the visit as soon as we reach
|
||
the goal vertex.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">petgraph</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">use</span> <span class="ident">petgraph</span>::<span class="ident">graph</span>::<span class="ident">node_index</span> <span class="kw">as</span> <span class="ident">n</span>;
|
||
<span class="kw">use</span> <span class="ident">petgraph</span>::<span class="ident">visit</span>::<span class="ident">depth_first_search</span>;
|
||
<span class="kw">use</span> <span class="ident">petgraph</span>::<span class="ident">visit</span>::{<span class="ident">DfsEvent</span>, <span class="ident">Control</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">gr</span>: <span class="ident">Graph</span><span class="op"><</span>(), ()<span class="op">></span> <span class="op">=</span> <span class="ident">Graph</span>::<span class="ident">from_edges</span>(<span class="kw-2">&</span>[
|
||
(<span class="number">0</span>, <span class="number">1</span>), (<span class="number">0</span>, <span class="number">2</span>), (<span class="number">0</span>, <span class="number">3</span>),
|
||
(<span class="number">1</span>, <span class="number">3</span>),
|
||
(<span class="number">2</span>, <span class="number">3</span>), (<span class="number">2</span>, <span class="number">4</span>),
|
||
(<span class="number">4</span>, <span class="number">0</span>), (<span class="number">4</span>, <span class="number">5</span>),
|
||
]);
|
||
|
||
<span class="comment">// record each predecessor, mapping node → node</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">predecessor</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">NodeIndex</span>::<span class="ident">end</span>(); <span class="ident">gr</span>.<span class="ident">node_count</span>()];
|
||
<span class="kw">let</span> <span class="ident">start</span> <span class="op">=</span> <span class="ident">n</span>(<span class="number">0</span>);
|
||
<span class="kw">let</span> <span class="ident">goal</span> <span class="op">=</span> <span class="ident">n</span>(<span class="number">5</span>);
|
||
<span class="ident">depth_first_search</span>(<span class="kw-2">&</span><span class="ident">gr</span>, <span class="prelude-val">Some</span>(<span class="ident">start</span>), <span class="op">|</span><span class="ident">event</span><span class="op">|</span> {
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">DfsEvent</span>::<span class="ident">TreeEdge</span>(<span class="ident">u</span>, <span class="ident">v</span>) <span class="op">=</span> <span class="ident">event</span> {
|
||
<span class="ident">predecessor</span>[<span class="ident">v</span>.<span class="ident">index</span>()] <span class="op">=</span> <span class="ident">u</span>;
|
||
<span class="kw">if</span> <span class="ident">v</span> <span class="op">==</span> <span class="ident">goal</span> {
|
||
<span class="kw">return</span> <span class="ident">Control</span>::<span class="ident">Break</span>(<span class="ident">v</span>);
|
||
}
|
||
}
|
||
<span class="ident">Control</span>::<span class="ident">Continue</span>
|
||
});
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">next</span> <span class="op">=</span> <span class="ident">goal</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">path</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">next</span>];
|
||
<span class="kw">while</span> <span class="ident">next</span> <span class="op">!=</span> <span class="ident">start</span> {
|
||
<span class="kw">let</span> <span class="ident">pred</span> <span class="op">=</span> <span class="ident">predecessor</span>[<span class="ident">next</span>.<span class="ident">index</span>()];
|
||
<span class="ident">path</span>.<span class="ident">push</span>(<span class="ident">pred</span>);
|
||
<span class="ident">next</span> <span class="op">=</span> <span class="ident">pred</span>;
|
||
}
|
||
<span class="ident">path</span>.<span class="ident">reverse</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">path</span>, <span class="kw-2">&</span>[<span class="ident">n</span>(<span class="number">0</span>), <span class="ident">n</span>(<span class="number">2</span>), <span class="ident">n</span>(<span class="number">4</span>), <span class="ident">n</span>(<span class="number">5</span>)]);</pre>
|
||
</div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "petgraph";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |