270 lines
12 KiB
HTML
270 lines
12 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 `petgraph` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, petgraph">
|
|||
|
|
|
|||
|
|
<title>petgraph - 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'>Crate petgraph</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'petgraph', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>petgraph</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#2-225' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p><strong>petgraph</strong> is a graph data structure library.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p><a href="./graph/struct.Graph.html"><code>Graph</code></a> which is an adjacency list graph with
|
|||
|
|
arbitrary associated data.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><a href="./stable_graph/struct.StableGraph.html"><code>StableGraph</code></a> is similar
|
|||
|
|
to <code>Graph</code>, but it keeps indices stable across removals.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><a href="./graphmap/struct.GraphMap.html"><code>GraphMap</code></a> is an adjacency list graph
|
|||
|
|
which is backed by a hash table and the node identifiers are the keys
|
|||
|
|
into the table.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Optional crate feature: <code>"serde-1"</code>, see the Readme for more information.</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.Graph.html" title="struct petgraph::graph::Graph">Graph</a>;</code></td></tr><tr><td><code>pub use Direction::<a class="enum" href="../petgraph/enum.Direction.html" title="enum petgraph::Direction">Outgoing</a>;</code></td></tr><tr><td><code>pub use Direction::<a class="enum" href="../petgraph/enum.Direction.html" title="enum petgraph::Direction">Incoming</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="algo/index.html"
|
|||
|
|
title='mod petgraph::algo'>algo</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Graph algorithms.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="csr/index.html"
|
|||
|
|
title='mod petgraph::csr'>csr</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Compressed Sparse Row (CSR) is a sparse adjacency matrix graph.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="data/index.html"
|
|||
|
|
title='mod petgraph::data'>data</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Graph traits for associated data and graph construction.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="dot/index.html"
|
|||
|
|
title='mod petgraph::dot'>dot</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Simple graphviz dot file format output.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="graph/index.html"
|
|||
|
|
title='mod petgraph::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="mod" href="graphmap/index.html"
|
|||
|
|
title='mod petgraph::graphmap'>graphmap</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p><code>GraphMap<N, E, Ty></code> is a graph datastructure where node values are mapping
|
|||
|
|
keys.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="prelude/index.html"
|
|||
|
|
title='mod petgraph::prelude'>prelude</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Commonly used items.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="stable_graph/index.html"
|
|||
|
|
title='mod petgraph::stable_graph'>stable_graph</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p><code>StableGraph</code> keeps indices stable across removals.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="unionfind/index.html"
|
|||
|
|
title='mod petgraph::unionfind'>unionfind</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p><code>UnionFind<K></code> is a disjoint-set data structure.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="visit/index.html"
|
|||
|
|
title='mod petgraph::visit'>visit</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Graph traits and graph traversals.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.Directed.html"
|
|||
|
|
title='enum petgraph::Directed'>Directed</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Marker type for a directed graph.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.Direction.html"
|
|||
|
|
title='enum petgraph::Direction'>Direction</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Edge direction.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.Undirected.html"
|
|||
|
|
title='enum petgraph::Undirected'>Undirected</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Marker type for an undirected graph.</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.EdgeType.html"
|
|||
|
|
title='trait petgraph::EdgeType'>EdgeType</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A graph's edge type determines whether is has directed edges or not.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.IntoWeightedEdge.html"
|
|||
|
|
title='trait petgraph::IntoWeightedEdge'>IntoWeightedEdge</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Convert an element like <code>(i, j)</code> or <code>(i, j, w)</code> into
|
|||
|
|
a triple of source, target, edge weight.</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>
|