25 lines
16 KiB
HTML
25 lines
16 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="The graph’s `NodeId`s map to indices"><title>NodeIndexable in petgraph::visit - 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="#">Node<wbr>Indexable</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.from_index" title="from_index">from_index</a></li><li><a href="#tymethod.node_bound" title="node_bound">node_bound</a></li><li><a href="#tymethod.to_index" title="to_index">to_index</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-NodeIndexable-for-%26G" title="&'a G">&'a G</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In petgraph::<wbr>visit</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">visit</a></span><h1>Trait <span class="trait">NodeIndexable</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/visit/mod.rs.html#337-350">Source</a> </span></div><pre class="rust item-decl"><code>pub trait NodeIndexable: <a class="trait" href="trait.GraphBase.html" title="trait petgraph::visit::GraphBase">GraphBase</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.node_bound" class="fn">node_bound</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.to_index" class="fn">to_index</a>(&self, a: Self::<a class="associatedtype" href="trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.from_index" class="fn">from_index</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> Self::<a class="associatedtype" href="trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The graph’s <code>NodeId</code>s map to indices</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.node_bound" class="method"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#344">Source</a><h4 class="code-header">fn <a href="#tymethod.node_bound" class="fn">node_bound</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Return an upper bound of the node indices in the graph
|
||
(suitable for the size of a bitmap).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.to_index" class="method"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#346">Source</a><h4 class="code-header">fn <a href="#tymethod.to_index" class="fn">to_index</a>(&self, a: Self::<a class="associatedtype" href="trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Convert <code>a</code> to an integer index.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.from_index" class="method"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#348">Source</a><h4 class="code-header">fn <a href="#tymethod.from_index" class="fn">from_index</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> Self::<a class="associatedtype" href="trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a></h4></section></summary><div class="docblock"><p>Convert <code>i</code> to a node index. <code>i</code> must be a valid value in the graph.</p>
|
||
</div></details></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-NodeIndexable-for-%26G" class="impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#352">Source</a><a href="#impl-NodeIndexable-for-%26G" class="anchor">§</a><h3 class="code-header">impl<'a, G> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a G</a><div class="where">where
|
||
G: <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a>,</div></h3></section></summary><div class="impl-items"><section id="method.node_bound" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#352">Source</a><a href="#method.node_bound" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.node_bound" class="fn">node_bound</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section><section id="method.to_index" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#352">Source</a><a href="#method.to_index" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.to_index" class="fn">to_index</a>(&self, a: Self::<a class="associatedtype" href="trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section><section id="method.from_index" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#352">Source</a><a href="#method.from_index" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_index" class="fn">from_index</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> Self::<a class="associatedtype" href="trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a></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-NodeIndexable-for-Frozen%3C'a,+G%3E" class="impl"><a class="src rightside" href="../../src/petgraph/graph_impl/frozen.rs.html#104">Source</a><a href="#impl-NodeIndexable-for-Frozen%3C'a,+G%3E" class="anchor">§</a><h3 class="code-header">impl<'a, G> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="../graph/struct.Frozen.html" title="struct petgraph::graph::Frozen">Frozen</a><'a, G><div class="where">where
|
||
G: <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a>,</div></h3></section><section id="impl-NodeIndexable-for-List%3CE,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/adj.rs.html#578-590">Source</a><a href="#impl-NodeIndexable-for-List%3CE,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl<E, Ix: <a class="trait" href="../graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="../adj/struct.List.html" title="struct petgraph::adj::List">List</a><E, Ix></h3></section><section id="impl-NodeIndexable-for-Reversed%3CG%3E" class="impl"><a class="src rightside" href="../../src/petgraph/visit/reversed.rs.html#176">Source</a><a href="#impl-NodeIndexable-for-Reversed%3CG%3E" class="anchor">§</a><h3 class="code-header">impl<G> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="struct.Reversed.html" title="struct petgraph::visit::Reversed">Reversed</a><G><div class="where">where
|
||
G: <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a>,</div></h3></section><section id="impl-NodeIndexable-for-EdgeFiltered%3CG,+F%3E" class="impl"><a class="src rightside" href="../../src/petgraph/visit/filter.rs.html#581">Source</a><a href="#impl-NodeIndexable-for-EdgeFiltered%3CG,+F%3E" class="anchor">§</a><h3 class="code-header">impl<G, F> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="struct.EdgeFiltered.html" title="struct petgraph::visit::EdgeFiltered">EdgeFiltered</a><G, F><div class="where">where
|
||
G: <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a>,</div></h3></section><section id="impl-NodeIndexable-for-NodeFiltered%3CG,+F%3E" class="impl"><a class="src rightside" href="../../src/petgraph/visit/filter.rs.html#350">Source</a><a href="#impl-NodeIndexable-for-NodeFiltered%3CG,+F%3E" class="anchor">§</a><h3 class="code-header">impl<G, F> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="struct.NodeFiltered.html" title="struct petgraph::visit::NodeFiltered">NodeFiltered</a><G, F><div class="where">where
|
||
G: <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a>,</div></h3></section><section id="impl-NodeIndexable-for-Csr%3CN,+E,+Ty,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/csr.rs.html#632-646">Source</a><a href="#impl-NodeIndexable-for-Csr%3CN,+E,+Ty,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl<N, E, Ty, Ix> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="../csr/struct.Csr.html" title="struct petgraph::csr::Csr">Csr</a><N, E, Ty, Ix><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-NodeIndexable-for-Graph%3CN,+E,+Ty,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/graph_impl/mod.rs.html#2182-2199">Source</a><a href="#impl-NodeIndexable-for-Graph%3CN,+E,+Ty,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl<N, E, Ty, Ix> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="../graph/struct.Graph.html" title="struct petgraph::graph::Graph">Graph</a><N, E, Ty, Ix><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-NodeIndexable-for-StableGraph%3CN,+E,+Ty,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/graph_impl/stable_graph/mod.rs.html#1853-1868">Source</a><a href="#impl-NodeIndexable-for-StableGraph%3CN,+E,+Ty,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl<N, E, Ty, Ix> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="../stable_graph/struct.StableGraph.html" title="struct petgraph::stable_graph::StableGraph">StableGraph</a><N, E, Ty, Ix><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-NodeIndexable-for-GraphMap%3CN,+E,+Ty,+S%3E" class="impl"><a class="src rightside" href="../../src/petgraph/graphmap.rs.html#1193-1214">Source</a><a href="#impl-NodeIndexable-for-GraphMap%3CN,+E,+Ty,+S%3E" class="anchor">§</a><h3 class="code-header">impl<N, E, Ty, S> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="../graphmap/struct.GraphMap.html" title="struct petgraph::graphmap::GraphMap">GraphMap</a><N, E, Ty, S><div class="where">where
|
||
N: <a class="trait" href="../graphmap/trait.NodeTrait.html" title="trait petgraph::graphmap::NodeTrait">NodeTrait</a>,
|
||
Ty: <a class="trait" href="../trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>,
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section><section id="impl-NodeIndexable-for-MatrixGraph%3CN,+E,+Ty,+Null,+Ix%3E" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#1229-1243">Source</a><a href="#impl-NodeIndexable-for-MatrixGraph%3CN,+E,+Ty,+Null,+Ix%3E" class="anchor">§</a><h3 class="code-header">impl<N, E, Ty: <a class="trait" href="../trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>, Null: <a class="trait" href="../matrix_graph/trait.Nullable.html" title="trait petgraph::matrix_graph::Nullable">Nullable</a><Wrapped = E>, Ix: <a class="trait" href="../graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>> <a class="trait" href="trait.NodeIndexable.html" title="trait petgraph::visit::NodeIndexable">NodeIndexable</a> for <a class="struct" href="../matrix_graph/struct.MatrixGraph.html" title="struct petgraph::matrix_graph::MatrixGraph">MatrixGraph</a><N, E, Ty, Null, Ix></h3></section></div><script src="../../trait.impl/petgraph/visit/trait.NodeIndexable.js" async></script></section></div></main></body></html> |