mentat/petgraph/visit/trait.IntoNeighborsDirected.html

168 lines
18 KiB
HTML
Raw Normal View History

2018-08-22 17:04:13 +00:00
<!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 `IntoNeighborsDirected` trait in crate `petgraph`.">
<meta name="keywords" content="rust, rustlang, rust-lang, IntoNeighborsDirected">
<title>petgraph::visit::IntoNeighborsDirected - 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 trait">
<!--[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">&#9776;</div>
<p class='location'>Trait IntoNeighborsDirected</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.NeighborsDirected">NeighborsDirected</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.neighbors_directed">neighbors_directed</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-IntoNeighborsDirected">&amp;&#39;a G</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a></p><script>window.sidebarCurrent = {name: 'IntoNeighborsDirected', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</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'>Trait <a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a>::<wbr><a class="trait" href=''>IntoNeighborsDirected</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/petgraph/visit/macros.rs.html#22-62' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait IntoNeighborsDirected: <a class="trait" href="../../petgraph/visit/trait.IntoNeighbors.html" title="trait petgraph::visit::IntoNeighbors">IntoNeighbors</a> {
type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = Self::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>&gt;;
fn <a href='#tymethod.neighbors_directed' class='fnname'>neighbors_directed</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;n: Self::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;d: <a class="enum" href="../../petgraph/enum.Direction.html" title="enum petgraph::Direction">Direction</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; Self::<a class="type" href="../../petgraph/visit/trait.IntoNeighborsDirected.html#associatedtype.NeighborsDirected" title="type petgraph::visit::IntoNeighborsDirected::NeighborsDirected">NeighborsDirected</a>;
}</pre><div class='docblock'><p>Access to the neighbors of each node, through incoming or outgoing edges.</p>
<p>Depending on the graphs edge type, the neighbors of a given directionality
are:</p>
<ul>
<li><code>Directed</code>, <code>Outgoing</code>: All targets of edges from <code>a</code>.</li>
<li><code>Directed</code>, <code>Incoming</code>: All sources of edges to <code>a</code>.</li>
<li><code>Undirected</code>: All other endpoints of edges connected to <code>a</code>.</li>
</ul>
</div>
<h2 id='associated-types' class='small-section-header'>
Associated Types<a href='#associated-types' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='associatedtype.NeighborsDirected' class='method'><span id='NeighborsDirected.t' class='invisible'><code>type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = Self::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>&gt;</code></span></h3></div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.neighbors_directed' class='method'><span id='neighbors_directed.v' class='invisible'><code>fn <a href='#tymethod.neighbors_directed' class='fnname'>neighbors_directed</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;n: Self::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;d: <a class="enum" href="../../petgraph/enum.Direction.html" title="enum petgraph::Direction">Direction</a><br>) -&gt; Self::<a class="type" href="../../petgraph/visit/trait.IntoNeighborsDirected.html#associatedtype.NeighborsDirected" title="type petgraph::visit::IntoNeighborsDirected::NeighborsDirected">NeighborsDirected</a></code></span></h3></div>
<h2 id='foreign-impls' class='small-section-header'>
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
</h2>
<h3 id='impl-IntoNeighborsDirected' class='impl'><span class='in-band'><code>impl&lt;'a, G&gt; <a class="trait" href="../../petgraph/visit/trait.IntoNeighborsDirected.html" title="trait petgraph::visit::IntoNeighborsDirected">IntoNeighborsDirected</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>G <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;G: <a class="trait" href="../../petgraph/visit/trait.IntoNeighborsDirected.html" title="trait petgraph::visit::IntoNeighborsDirected">IntoNeighborsDirected</a>,&nbsp;</span></code><a href='#impl-IntoNeighborsDirected' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/macros.rs.html#114-130' title='goto source code'>[src]</a></span></h3>
<span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.NeighborsDirected-1' class="type"><span id='NeighborsDirected.t-1' class='invisible'><code>type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a> = G::<a class="type" href="../../petgraph/visit/trait.IntoNeighborsDirected.html#associatedtype.NeighborsDirected" title="type petgraph::visit::IntoNeighborsDirected::NeighborsDirected">NeighborsDirected</a></code></span></h4>
<h4 id='method.neighbors_directed' class="method"><span id='neighbors_directed.v-1' class='invisible'><code>fn <a href='#method.neighbors_directed' class='fnname'>neighbors_directed</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;n: Self::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;d: <a class="enum" href="../../petgraph/enum.Direction.html" title="enum petgraph::Direction">Direction</a><br>) -&gt; Self::<a class="type" href="../../petgraph/visit/trait.IntoNeighborsDirected.html#associatedtype.NeighborsDirected" title="type petgraph::visit::IntoNeighborsDirected::NeighborsDirected">NeighborsDirected</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/macros.rs.html#125-127' title='goto source code'>[src]</a></span></h4>
</div></span>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/filter.rs.html#115-128' title='goto source code'>[src]</a></div><code>impl&lt;'a, G, F&gt; IntoNeighborsDirected for &amp;'a <a class="struct" href="../../petgraph/visit/struct.NodeFiltered.html" title="struct petgraph::visit::NodeFiltered">NodeFiltered</a>&lt;G, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;G: <a class="trait" href="../../petgraph/visit/trait.IntoNeighborsDirected.html" title="trait petgraph::visit::IntoNeighborsDirected">IntoNeighborsDirected</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="../../petgraph/visit/trait.FilterNode.html" title="trait petgraph::visit::FilterNode">FilterNode</a>&lt;G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>&gt;,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a> = <a class="struct" href="../../petgraph/visit/struct.NodeFilteredNeighbors.html" title="struct petgraph::visit::NodeFilteredNeighbors">NodeFilteredNeighbors</a>&lt;'a, G::<a class="type" href="../../petgraph/visit/trait.IntoNeighborsDirected.html#associatedtype.NeighborsDirected" title="type petgraph::visit::IntoNeighborsDirected::NeighborsDirected">NeighborsDirected</a>, F&gt;;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/reversed.rs.html#49-58' title='goto source code'>[src]</a></div><code>impl&lt;G&gt; IntoNeighborsDirected for <a class="struct" href="../../petgraph/visit/struct.Reversed.html" title="struct petgraph::visit::Reversed">Reversed</a>&lt;G&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;G: <a class="trait" href="../../petgraph/visit/trait.IntoNeighborsDirected.html" title="trait petgraph::visit::IntoNeighborsDirected">IntoNeighborsDirected</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a> = G::<a class="type" href="../../petgraph/visit/trait.IntoNeighborsDirected.html#associatedtype.NeighborsDirected" title="type petgraph::visit::IntoNeighborsDirected::NeighborsDirected">NeighborsDirected</a>;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#182-192' title='goto source code'>[src]</a></div><code>impl&lt;'a, N, E:&nbsp;'a, Ty, Ix&gt; IntoNeighborsDirected for &amp;'a <a class="struct" href="../../petgraph/graph/struct.Graph.html" title="struct petgraph::graph::Graph">Graph</a>&lt;N, E, Ty, Ix&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Ty: <a class="trait" href="../../petgraph/trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;Ix: <a class="trait" href="../../petgraph/graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a> = <a class="struct" href="../../petgraph/graph/struct.Neighbors.html" title="struct petgraph::graph::Neighbors">Neighbors</a>&lt;'a, E, Ix&gt;;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#195-205' title='goto source code'>[src]</a></div><code>impl&lt;'a, N, E:&nbsp;'a, Ty, Ix&gt; IntoNeighborsDirected for &amp;'a <a class="struct" href="../../petgraph/stable_graph/struct.StableGraph.html" title="struct petgraph::stable_graph::StableGraph">StableGraph</a>&lt;N, E, Ty, Ix&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Ty: <a class="trait" href="../../petgraph/trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;Ix: <a class="trait" href="../../petgraph/graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a> = <a class="struct" href="../../petgraph/stable_graph/struct.Neighbors.html" title="struct petgraph::stable_graph::Neighbors">Neighbors</a>&lt;'a, E, Ix&gt;;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#208-218' title='goto source code'>[src]</a></div><code>impl&lt;'a, N:&nbsp;'a, E, Ty&gt; IntoNeighborsDirected for &amp;'a <a class="struct" href="../../petgraph/graphmap/struct.GraphMap.html" title="struct petgraph::graphmap::GraphMap">GraphMap</a>&lt;N, E, Ty&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;Ty: <a class="trait" href="../../petgraph/trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a> = <a class="struct" href="../../petgraph/graphmap/struct.NeighborsDirected.html" title="struct petgraph::graphmap::NeighborsDirected">NeighborsDirected</a>&lt;'a, N, Ty&gt;;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/macros.rs.html#114-130' title='goto source code'>[src]</a></div><code>impl&lt;'a, 'b, G&gt; IntoNeighborsDirected for &amp;'b <a class="struct" href="../../petgraph/graph/struct.Frozen.html" title="struct petgraph::graph::Frozen">Frozen</a>&lt;'a, G&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;G: <a class="trait" href="../../petgraph/visit/trait.IntoNeighborsDirected.html" title="trait petgraph::visit::IntoNeighborsDirected">IntoNeighborsDirected</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NeighborsDirected' class="type">NeighborsDirected</a> = G::<a class="type" href="../../petgraph/visit/trait.IntoNeighborsDirected.html#associatedtype.NeighborsDirected" title="type petgraph::visit::IntoNeighborsDirected::NeighborsDirected">NeighborsDirected</a>;</span></code></li>
</ul><script type="text/javascript" async
src="../../implementors/petgraph/visit/trait.IntoNeighborsDirected.js">
</script></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>&#9166;</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>