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

16 lines
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="Access node and edge weights (associated data)."><title>DataMap in petgraph::data - 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 trait"><!--[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="#">DataMap</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.edge_weight" title="edge_weight">edge_weight</a></li><li><a href="#tymethod.node_weight" title="node_weight">node_weight</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-DataMap-for-%26G" title="&#38;&#39;a G">&#38;&#39;a G</a></li><li><a href="#impl-DataMap-for-%26mut+G" title="&#38;&#39;a mut G">&#38;&#39;a mut G</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In petgraph::<wbr>data</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>::<wbr><a href="index.html">data</a></span><h1>Trait <span class="trait">DataMap</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/data.rs.html#12-20">Source</a> </span></div><pre class="rust item-decl"><code>pub trait DataMap: <a class="trait" href="../visit/trait.Data.html" title="trait petgraph::visit::Data">Data</a> {
// Required methods
fn <a href="#tymethod.node_weight" class="fn">node_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.NodeWeight" title="type petgraph::visit::Data::NodeWeight">NodeWeight</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.edge_weight" class="fn">edge_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.EdgeWeight" title="type petgraph::visit::Data::EdgeWeight">EdgeWeight</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Access node and edge weights (associated data).</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.node_weight" class="method"><a class="src rightside" href="../../src/petgraph/data.rs.html#17">Source</a><h4 class="code-header">fn <a href="#tymethod.node_weight" class="fn">node_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.NodeWeight" title="type petgraph::visit::Data::NodeWeight">NodeWeight</a>&gt;</h4></section><section id="tymethod.edge_weight" class="method"><a class="src rightside" href="../../src/petgraph/data.rs.html#18">Source</a><h4 class="code-header">fn <a href="#tymethod.edge_weight" class="fn">edge_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.EdgeWeight" title="type petgraph::visit::Data::EdgeWeight">EdgeWeight</a>&gt;</h4></section></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-DataMap-for-%26G" class="impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#28">Source</a><a href="#impl-DataMap-for-%26G" class="anchor">§</a><h3 class="code-header">impl&lt;'a, G&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;'a G</a><div class="where">where
G: <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a>,</div></h3></section></summary><div class="impl-items"><section id="method.node_weight" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#28">Source</a><a href="#method.node_weight" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.node_weight" class="fn">node_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.NodeWeight" title="type petgraph::visit::Data::NodeWeight">NodeWeight</a>&gt;</h4></section><section id="method.edge_weight" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#28">Source</a><a href="#method.edge_weight" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.edge_weight" class="fn">edge_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.EdgeWeight" title="type petgraph::visit::Data::EdgeWeight">EdgeWeight</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-DataMap-for-%26mut+G" class="impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#29">Source</a><a href="#impl-DataMap-for-%26mut+G" class="anchor">§</a><h3 class="code-header">impl&lt;'a, G&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;'a mut G</a><div class="where">where
G: <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a>,</div></h3></section></summary><div class="impl-items"><section id="method.node_weight-1" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#29">Source</a><a href="#method.node_weight-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.node_weight" class="fn">node_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.NodeWeight" title="type petgraph::visit::Data::NodeWeight">NodeWeight</a>&gt;</h4></section><section id="method.edge_weight-1" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#29">Source</a><a href="#method.edge_weight-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.edge_weight" class="fn">edge_weight</a>(&amp;self, id: Self::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.EdgeId" title="type petgraph::visit::GraphBase::EdgeId">EdgeId</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Self::<a class="associatedtype" href="../visit/trait.Data.html#associatedtype.EdgeWeight" title="type petgraph::visit::Data::EdgeWeight">EdgeWeight</a>&gt;</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-DataMap-for-Frozen%3C'a,+G%3E" class="impl"><a class="src rightside" href="../../src/petgraph/graph_impl/frozen.rs.html#92">Source</a><a href="#impl-DataMap-for-Frozen%3C'a,+G%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, G&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="struct" href="../graph/struct.Frozen.html" title="struct petgraph::graph::Frozen">Frozen</a>&lt;'a, G&gt;<div class="where">where
G: <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a>,</div></h3></section><section id="impl-DataMap-for-List%3CE,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/adj.rs.html#594-609">Source</a><a href="#impl-DataMap-for-List%3CE,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl&lt;E, Ix: <a class="trait" href="../graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="struct" href="../adj/struct.List.html" title="struct petgraph::adj::List">List</a>&lt;E, Ix&gt;</h3></section><section id="impl-DataMap-for-Reversed%3CG%3E" class="impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#30">Source</a><a href="#impl-DataMap-for-Reversed%3CG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;G&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="struct" href="../visit/struct.Reversed.html" title="struct petgraph::visit::Reversed">Reversed</a>&lt;G&gt;<div class="where">where
G: <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a>,</div></h3></section><section id="impl-DataMap-for-NodeFiltered%3CG,+F%3E" class="impl"><a class="src rightside" href="../../src/petgraph/visit/filter.rs.html#325-341">Source</a><a href="#impl-DataMap-for-NodeFiltered%3CG,+F%3E" class="anchor">§</a><h3 class="code-header">impl&lt;G, F&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="struct" href="../visit/struct.NodeFiltered.html" title="struct petgraph::visit::NodeFiltered">NodeFiltered</a>&lt;G, F&gt;<div class="where">where
G: <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a>,
F: <a class="trait" href="../visit/trait.FilterNode.html" title="trait petgraph::visit::FilterNode">FilterNode</a>&lt;G::<a class="associatedtype" href="../visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>&gt;,</div></h3></section><section id="impl-DataMap-for-Graph%3CN,+E,+Ty,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#81-92">Source</a><a href="#impl-DataMap-for-Graph%3CN,+E,+Ty,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl&lt;N, E, Ty, Ix&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="struct" href="../graph/struct.Graph.html" title="struct petgraph::graph::Graph">Graph</a>&lt;N, E, Ty, Ix&gt;<div class="where">where
Ty: <a class="trait" href="../trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>,
Ix: <a class="trait" href="../graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>,</div></h3></section><section id="impl-DataMap-for-StableGraph%3CN,+E,+Ty,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#108-119">Source</a><a href="#impl-DataMap-for-StableGraph%3CN,+E,+Ty,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl&lt;N, E, Ty, Ix&gt; <a class="trait" href="trait.DataMap.html" title="trait petgraph::data::DataMap">DataMap</a> for <a class="struct" href="../stable_graph/struct.StableGraph.html" title="struct petgraph::stable_graph::StableGraph">StableGraph</a>&lt;N, E, Ty, Ix&gt;<div class="where">where
Ty: <a class="trait" href="../trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>,
Ix: <a class="trait" href="../graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>,</div></h3></section></div><script src="../../trait.impl/petgraph/data/trait.DataMap.js" async></script></section></div></main></body></html>