326 lines
No EOL
15 KiB
HTML
326 lines
No EOL
15 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 `graph` mod in crate `petgraph`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, graph">
|
||
|
||
<title>petgraph::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">☰</div>
|
||
|
||
<p class='location'>Module graph</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</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: '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=''>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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/petgraph/lib.rs.html#70-97' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p><code>Graph<N, E, Ty, Ix></code> is a graph datastructure using an adjacency list representation.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Edge.html"
|
||
title='struct petgraph::graph::Edge'>Edge</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The graph's edge type.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.EdgeIndex.html"
|
||
title='struct petgraph::graph::EdgeIndex'>EdgeIndex</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Edge identifier.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.EdgeIndices.html"
|
||
title='struct petgraph::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::graph::EdgeReference'>EdgeReference</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Reference to a <code>Graph</code> edge.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.EdgeReferences.html"
|
||
title='struct petgraph::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.EdgeWeightsMut.html"
|
||
title='struct petgraph::graph::EdgeWeightsMut'>EdgeWeightsMut</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Iterator yielding mutable access to all edge weights.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Edges.html"
|
||
title='struct petgraph::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.Externals.html"
|
||
title='struct petgraph::graph::Externals'>Externals</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An iterator over either the nodes without edges to them or from them.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Frozen.html"
|
||
title='struct petgraph::graph::Frozen'>Frozen</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>Frozen</code> is a graph wrapper.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Graph.html"
|
||
title='struct petgraph::graph::Graph'>Graph</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>Graph<N, E, Ty, Ix></code> is a graph datastructure using an adjacency list representation.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Neighbors.html"
|
||
title='struct petgraph::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.Node.html"
|
||
title='struct petgraph::graph::Node'>Node</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The graph's node type.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.NodeIndex.html"
|
||
title='struct petgraph::graph::NodeIndex'>NodeIndex</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Node identifier.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.NodeIndices.html"
|
||
title='struct petgraph::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::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.NodeWeightsMut.html"
|
||
title='struct petgraph::graph::NodeWeightsMut'>NodeWeightsMut</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Iterator yielding mutable access to all node weights.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.WalkNeighbors.html"
|
||
title='struct petgraph::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='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.GraphIndex.html"
|
||
title='trait petgraph::graph::GraphIndex'>GraphIndex</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A <code>GraphIndex</code> is a node or edge index.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.IndexType.html"
|
||
title='trait petgraph::graph::IndexType'>IndexType</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Trait for the unsigned integer type used for node and edge indices.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.edge_index.html"
|
||
title='fn petgraph::graph::edge_index'>edge_index</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Short version of <code>EdgeIndex::new</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.node_index.html"
|
||
title='fn petgraph::graph::node_index'>node_index</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Short version of <code>NodeIndex::new</code></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.DefaultIx.html"
|
||
title='type petgraph::graph::DefaultIx'>DefaultIx</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The default integer type for graph indices.
|
||
<code>u32</code> is the default to reduce the size of the graph's data and improve
|
||
performance in the common case.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.DiGraph.html"
|
||
title='type petgraph::graph::DiGraph'>DiGraph</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A <code>Graph</code> with directed edges.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.UnGraph.html"
|
||
title='type petgraph::graph::UnGraph'>UnGraph</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A <code>Graph</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>⏎</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> |