Files
phy/petgraph/graph/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

4 lines
9.5 KiB
HTML
Raw Permalink 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="`Graph&#60;N, E, Ty, Ix&#62;` is a graph datastructure using an adjacency list representation."><title>petgraph::graph - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="petgraph" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../petgraph/index.html">petgraph</a><span class="version">0.6.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module graph</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate petgraph</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">petgraph</a></span><h1>Module <span>graph</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/petgraph/lib.rs.html#161">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>Graph&lt;N, E, Ty, Ix&gt;</code> is a graph datastructure using an adjacency list representation.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Edge.html" title="struct petgraph::graph::Edge">Edge</a></div><div class="desc docblock-short">The graphs edge type.</div></li><li><div class="item-name"><a class="struct" href="struct.EdgeIndex.html" title="struct petgraph::graph::EdgeIndex">Edge<wbr>Index</a></div><div class="desc docblock-short">Edge identifier.</div></li><li><div class="item-name"><a class="struct" href="struct.EdgeIndices.html" title="struct petgraph::graph::EdgeIndices">Edge<wbr>Indices</a></div><div class="desc docblock-short">Iterator over the edge indices of a graph.</div></li><li><div class="item-name"><a class="struct" href="struct.EdgeReference.html" title="struct petgraph::graph::EdgeReference">Edge<wbr>Reference</a></div><div class="desc docblock-short">Reference to a <code>Graph</code> edge.</div></li><li><div class="item-name"><a class="struct" href="struct.EdgeReferences.html" title="struct petgraph::graph::EdgeReferences">Edge<wbr>References</a></div><div class="desc docblock-short">Iterator over all edges of a graph.</div></li><li><div class="item-name"><a class="struct" href="struct.EdgeWeightsMut.html" title="struct petgraph::graph::EdgeWeightsMut">Edge<wbr>Weights<wbr>Mut</a></div><div class="desc docblock-short">Iterator yielding mutable access to all edge weights.</div></li><li><div class="item-name"><a class="struct" href="struct.Edges.html" title="struct petgraph::graph::Edges">Edges</a></div><div class="desc docblock-short">Iterator over the edges of from or to a node</div></li><li><div class="item-name"><a class="struct" href="struct.EdgesConnecting.html" title="struct petgraph::graph::EdgesConnecting">Edges<wbr>Connecting</a></div><div class="desc docblock-short">Iterator over the multiple directed edges connecting a source node to a target node</div></li><li><div class="item-name"><a class="struct" href="struct.Externals.html" title="struct petgraph::graph::Externals">Externals</a></div><div class="desc docblock-short">An iterator over either the nodes without edges to them or from them.</div></li><li><div class="item-name"><a class="struct" href="struct.Frozen.html" title="struct petgraph::graph::Frozen">Frozen</a></div><div class="desc docblock-short"><code>Frozen</code> is a graph wrapper.</div></li><li><div class="item-name"><a class="struct" href="struct.Graph.html" title="struct petgraph::graph::Graph">Graph</a></div><div class="desc docblock-short"><code>Graph&lt;N, E, Ty, Ix&gt;</code> is a graph datastructure using an adjacency list representation.</div></li><li><div class="item-name"><a class="struct" href="struct.Neighbors.html" title="struct petgraph::graph::Neighbors">Neighbors</a></div><div class="desc docblock-short">Iterator over the neighbors of a node.</div></li><li><div class="item-name"><a class="struct" href="struct.Node.html" title="struct petgraph::graph::Node">Node</a></div><div class="desc docblock-short">The graphs node type.</div></li><li><div class="item-name"><a class="struct" href="struct.NodeIndex.html" title="struct petgraph::graph::NodeIndex">Node<wbr>Index</a></div><div class="desc docblock-short">Node identifier.</div></li><li><div class="item-name"><a class="struct" href="struct.NodeIndices.html" title="struct petgraph::graph::NodeIndices">Node<wbr>Indices</a></div><div class="desc docblock-short">Iterator over the node indices of a graph.</div></li><li><div class="item-name"><a class="struct" href="struct.NodeReferences.html" title="struct petgraph::graph::NodeReferences">Node<wbr>References</a></div><div class="desc docblock-short">Iterator over all nodes of a graph.</div></li><li><div class="item-name"><a class="struct" href="struct.NodeWeightsMut.html" title="struct petgraph::graph::NodeWeightsMut">Node<wbr>Weights<wbr>Mut</a></div><div class="desc docblock-short">Iterator yielding mutable access to all node weights.</div></li><li><div class="item-name"><a class="struct" href="struct.WalkNeighbors.html" title="struct petgraph::graph::WalkNeighbors">Walk<wbr>Neighbors</a></div><div class="desc docblock-short">A “walker” object that can be used to step through the edge list of a node.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.GraphIndex.html" title="trait petgraph::graph::GraphIndex">Graph<wbr>Index</a></div><div class="desc docblock-short">A <code>GraphIndex</code> is a node or edge index.</div></li><li><div class="item-name"><a class="trait" href="trait.IndexType.html" title="trait petgraph::graph::IndexType">Index<wbr>Type</a></div><div class="desc docblock-short">Trait for the unsigned integer type used for node and edge indices.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.edge_index.html" title="fn petgraph::graph::edge_index">edge_<wbr>index</a></div><div class="desc docblock-short">Short version of <code>EdgeIndex::new</code></div></li><li><div class="item-name"><a class="fn" href="fn.node_index.html" title="fn petgraph::graph::node_index">node_<wbr>index</a></div><div class="desc docblock-short">Short version of <code>NodeIndex::new</code></div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.DefaultIx.html" title="type petgraph::graph::DefaultIx">Default<wbr>Ix</a></div><div class="desc docblock-short">The default integer type for graph indices.
<code>u32</code> is the default to reduce the size of the graphs data and improve
performance in the common case.</div></li><li><div class="item-name"><a class="type" href="type.DiGraph.html" title="type petgraph::graph::DiGraph">DiGraph</a></div><div class="desc docblock-short">A <code>Graph</code> with directed edges.</div></li><li><div class="item-name"><a class="type" href="type.UnGraph.html" title="type petgraph::graph::UnGraph">UnGraph</a></div><div class="desc docblock-short">A <code>Graph</code> with undirected edges.</div></li></ul></section></div></main></body></html>