12 lines
9.4 KiB
HTML
12 lines
9.4 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="A mapping for storing the visited status for NodeId `N`."><title>VisitMap 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="#">Visit<wbr>Map</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_visited" title="is_visited">is_visited</a></li><li><a href="#tymethod.visit" title="visit">visit</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-VisitMap%3CIx%3E-for-FixedBitSet" title="FixedBitSet">FixedBitSet</a></li><li><a href="#impl-VisitMap%3CN%3E-for-HashSet%3CN,+S%3E" title="HashSet<N, S>">HashSet<N, S></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">VisitMap</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#393-401">Source</a> </span></div><pre class="rust item-decl"><code>pub trait VisitMap<N> {
|
|
// Required methods
|
|
fn <a href="#tymethod.visit" class="fn">visit</a>(&mut self, a: N) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.is_visited" class="fn">is_visited</a>(&self, a: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&N</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A mapping for storing the visited status for NodeId <code>N</code>.</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.visit" class="method"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#397">Source</a><h4 class="code-header">fn <a href="#tymethod.visit" class="fn">visit</a>(&mut self, a: N) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Mark <code>a</code> as visited.</p>
|
|
<p>Return <strong>true</strong> if this is the first visit, false otherwise.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_visited" class="method"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#400">Source</a><h4 class="code-header">fn <a href="#tymethod.is_visited" class="fn">is_visited</a>(&self, a: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&N</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return whether <code>a</code> has been visited before.</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-VisitMap%3CIx%3E-for-FixedBitSet" class="impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#403-413">Source</a><a href="#impl-VisitMap%3CIx%3E-for-FixedBitSet" class="anchor">§</a><h3 class="code-header">impl<Ix> <a class="trait" href="trait.VisitMap.html" title="trait petgraph::visit::VisitMap">VisitMap</a><Ix> for <a class="struct" href="../../fixedbitset/struct.FixedBitSet.html" title="struct fixedbitset::FixedBitSet">FixedBitSet</a><div class="where">where
|
|
Ix: <a class="trait" href="../graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>,</div></h3></section></summary><div class="impl-items"><section id="method.visit" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#407-409">Source</a><a href="#method.visit" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.visit" class="fn">visit</a>(&mut self, x: Ix) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section><section id="method.is_visited" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#410-412">Source</a><a href="#method.is_visited" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_visited" class="fn">is_visited</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Ix</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-VisitMap%3CN%3E-for-HashSet%3CN,+S%3E" class="impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#415-426">Source</a><a href="#impl-VisitMap%3CN%3E-for-HashSet%3CN,+S%3E" class="anchor">§</a><h3 class="code-header">impl<N, S> <a class="trait" href="trait.VisitMap.html" title="trait petgraph::visit::VisitMap">VisitMap</a><N> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/std/collections/hash/set/struct.HashSet.html" title="struct std::collections::hash::set::HashSet">HashSet</a><N, S><div class="where">where
|
|
N: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</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></summary><div class="impl-items"><section id="method.visit-1" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#420-422">Source</a><a href="#method.visit-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.visit" class="fn">visit</a>(&mut self, x: N) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section><section id="method.is_visited-1" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/visit/mod.rs.html#423-425">Source</a><a href="#method.is_visited-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_visited" class="fn">is_visited</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&N</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/petgraph/visit/trait.VisitMap.js" data-ignore-extern-crates="fixedbitset,std" async></script></section></div></main></body></html> |