mentat/petgraph/stable_graph/index.html
2018-08-22 17:04:13 +00:00

221 lines
No EOL
11 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 `stable_graph` mod in crate `petgraph`.">
<meta name="keywords" content="rust, rustlang, rust-lang, stable_graph">
<title>petgraph::stable_graph - 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 mod">
<!--[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'>Module stable_graph</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>petgraph</a></p><script>window.sidebarCurrent = {name: 'stable_graph', ty: 'mod', 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'>Module <a href='../index.html'>petgraph</a>::<wbr><a class="mod" href=''>stable_graph</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/graph_impl/stable_graph/mod.rs.html#1-1677' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p><code>StableGraph</code> keeps indices stable across removals.</p>
<p>Depends on <code>feature = &quot;stable_graph&quot;</code>.</p>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use graph::<a class="struct" href="../../petgraph/graph/struct.NodeIndex.html" title="struct petgraph::graph::NodeIndex">NodeIndex</a>;</code></td></tr><tr><td><code>pub use graph::<a class="struct" href="../../petgraph/graph/struct.EdgeIndex.html" title="struct petgraph::graph::EdgeIndex">EdgeIndex</a>;</code></td></tr><tr><td><code>pub use graph::<a class="trait" href="../../petgraph/graph/trait.GraphIndex.html" title="trait petgraph::graph::GraphIndex">GraphIndex</a>;</code></td></tr><tr><td><code>pub use graph::<a class="trait" href="../../petgraph/graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>;</code></td></tr><tr><td><code>pub use graph::<a class="type" href="../../petgraph/graph/type.DefaultIx.html" title="type petgraph::graph::DefaultIx">DefaultIx</a>;</code></td></tr><tr><td><code>pub use graph::<a class="fn" href="../../petgraph/graph/fn.node_index.html" title="fn petgraph::graph::node_index">node_index</a>;</code></td></tr><tr><td><code>pub use graph::<a class="fn" href="../../petgraph/graph/fn.edge_index.html" title="fn petgraph::graph::edge_index">edge_index</a>;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.EdgeIndices.html"
title='struct petgraph::stable_graph::EdgeIndices'>EdgeIndices</a></td>
<td class='docblock-short'>
<p>Iterator over the edge indices of a graph.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.EdgeReference.html"
title='struct petgraph::stable_graph::EdgeReference'>EdgeReference</a></td>
<td class='docblock-short'>
<p>Reference to a <code>StableGraph</code> edge.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.EdgeReferences.html"
title='struct petgraph::stable_graph::EdgeReferences'>EdgeReferences</a></td>
<td class='docblock-short'>
<p>Iterator over all edges of a graph.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Edges.html"
title='struct petgraph::stable_graph::Edges'>Edges</a></td>
<td class='docblock-short'>
<p>Iterator over the edges of from or to a node</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Neighbors.html"
title='struct petgraph::stable_graph::Neighbors'>Neighbors</a></td>
<td class='docblock-short'>
<p>Iterator over the neighbors of a node.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.NodeIndices.html"
title='struct petgraph::stable_graph::NodeIndices'>NodeIndices</a></td>
<td class='docblock-short'>
<p>Iterator over the node indices of a graph.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.NodeReferences.html"
title='struct petgraph::stable_graph::NodeReferences'>NodeReferences</a></td>
<td class='docblock-short'>
<p>Iterator over all nodes of a graph.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.StableGraph.html"
title='struct petgraph::stable_graph::StableGraph'>StableGraph</a></td>
<td class='docblock-short'>
<p><code>StableGraph&lt;N, E, Ty, Ix&gt;</code> is a graph datastructure using an adjacency
list representation.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.WalkNeighbors.html"
title='struct petgraph::stable_graph::WalkNeighbors'>WalkNeighbors</a></td>
<td class='docblock-short'>
<p>A “walker” object that can be used to step through the edge list of a node.</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.StableDiGraph.html"
title='type petgraph::stable_graph::StableDiGraph'>StableDiGraph</a></td>
<td class='docblock-short'>
<p>A <code>StableGraph</code> with directed edges.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.StableUnGraph.html"
title='type petgraph::stable_graph::StableUnGraph'>StableUnGraph</a></td>
<td class='docblock-short'>
<p>A <code>StableGraph</code> with undirected edges.</p>
</td>
</tr></table></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>