mentat/petgraph/visit/trait.GraphBase.html
2018-08-22 17:04:13 +00:00

164 lines
No EOL
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `GraphBase` trait in crate `petgraph`.">
<meta name="keywords" content="rust, rustlang, rust-lang, GraphBase">
<title>petgraph::visit::GraphBase - 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 GraphBase</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.EdgeId">EdgeId</a><a href="#associatedtype.NodeId">NodeId</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-GraphBase">&amp;&#39;a G</a><a href="#impl-GraphBase">&amp;&#39;a mut 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: 'GraphBase', 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=''>GraphBase</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 GraphBase {
type <a href='#associatedtype.EdgeId' class="type">EdgeId</a>: <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.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>;
type <a href='#associatedtype.NodeId' class="type">NodeId</a>: <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.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>;
}</pre><div class='docblock'><p>Base graph trait: defines the associated node identifier and
edge identifier types.</p>
</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.EdgeId' class='method'><span id='EdgeId.t' class='invisible'><code>type <a href='#associatedtype.EdgeId' class="type">EdgeId</a>: <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.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a></code></span></h3><div class='docblock'><p>edge identifier</p>
</div><h3 id='associatedtype.NodeId' class='method'><span id='NodeId.t' class='invisible'><code>type <a href='#associatedtype.NodeId' class="type">NodeId</a>: <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.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a></code></span></h3><div class='docblock'><p>node identifier</p>
</div></div>
<h2 id='foreign-impls' class='small-section-header'>
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
</h2>
<h3 id='impl-GraphBase' class='impl'><span class='in-band'><code>impl&lt;'a, G&gt; <a class="trait" href="../../petgraph/visit/trait.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</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.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a>,&nbsp;</span></code><a href='#impl-GraphBase' 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.NodeId-1' class="type"><span id='NodeId.t-1' class='invisible'><code>type <a href='#associatedtype.NodeId' class="type">NodeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a></code></span></h4>
<h4 id='associatedtype.EdgeId-1' class="type"><span id='EdgeId.t-1' class='invisible'><code>type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a></code></span></h4>
</div></span><h3 id='impl-GraphBase-1' class='impl'><span class='in-band'><code>impl&lt;'a, G&gt; <a class="trait" href="../../petgraph/visit/trait.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>G <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;G: <a class="trait" href="../../petgraph/visit/trait.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a>,&nbsp;</span></code><a href='#impl-GraphBase-1' 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.NodeId-2' class="type"><span id='NodeId.t-2' class='invisible'><code>type <a href='#associatedtype.NodeId' class="type">NodeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a></code></span></h4>
<h4 id='associatedtype.EdgeId-2' class="type"><span id='EdgeId.t-2' class='invisible'><code>type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a></code></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#72-75' title='goto source code'>[src]</a></div><code>impl&lt;G, F&gt; GraphBase for <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.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/filter.rs.html#322-325' title='goto source code'>[src]</a></div><code>impl&lt;G, F&gt; GraphBase for <a class="struct" href="../../petgraph/visit/struct.EdgeFiltered.html" title="struct petgraph::visit::EdgeFiltered">EdgeFiltered</a>&lt;G, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;G: <a class="trait" href="../../petgraph/visit/trait.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/reversed.rs.html#30-33' title='goto source code'>[src]</a></div><code>impl&lt;G:&nbsp;<a class="trait" href="../../petgraph/visit/trait.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a>&gt; GraphBase 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"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#105-108' title='goto source code'>[src]</a></div><code>impl&lt;'a, G&gt; GraphBase for <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.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#603-608' title='goto source code'>[src]</a></div><code>impl&lt;N, E, Ty, Ix&gt; GraphBase for <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;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.NodeId' class="type">NodeId</a> = <a class="struct" href="../../petgraph/graph/struct.NodeIndex.html" title="struct petgraph::graph::NodeIndex">NodeIndex</a>&lt;Ix&gt;;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="struct" href="../../petgraph/graph/struct.EdgeIndex.html" title="struct petgraph::graph::EdgeIndex">EdgeIndex</a>&lt;Ix&gt;;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#624-629' title='goto source code'>[src]</a></div><code>impl&lt;N, E, Ty, Ix&gt; GraphBase for <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;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.NodeId' class="type">NodeId</a> = <a class="struct" href="../../petgraph/graph/struct.NodeIndex.html" title="struct petgraph::graph::NodeIndex">NodeIndex</a>&lt;Ix&gt;;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="struct" href="../../petgraph/graph/struct.EdgeIndex.html" title="struct petgraph::graph::EdgeIndex">EdgeIndex</a>&lt;Ix&gt;;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#657-662' title='goto source code'>[src]</a></div><code>impl&lt;N, E, Ty&gt; GraphBase for <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.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,&nbsp;</span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = N;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>N, N<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></li>
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/csr.rs.html#496-502' title='goto source code'>[src]</a></div><code>impl&lt;N, E, Ty, Ix&gt; GraphBase for <a class="struct" href="../../petgraph/csr/struct.Csr.html" title="struct petgraph::csr::Csr">Csr</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.NodeId' class="type">NodeId</a> = <a class="type" href="../../petgraph/csr/type.NodeIndex.html" title="type petgraph::csr::NodeIndex">NodeIndex</a>&lt;Ix&gt;;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="type" href="../../petgraph/csr/type.EdgeIndex.html" title="type petgraph::csr::EdgeIndex">EdgeIndex</a>;</span></code></li>
</ul><script type="text/javascript" async
src="../../implementors/petgraph/visit/trait.GraphBase.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>