|
|
<!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="Base trait for types that can be wrapped in a `NotZero`."><title>Zero in petgraph::matrix_graph - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../petgraph/index.html">petgraph</a><span class="version">0.6.4</span></h2></div><h2 class="location"><a href="#">Zero</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_zero">is_zero</a></li><li><a href="#tymethod.zero">zero</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Zero-for-f32">f32</a></li><li><a href="#impl-Zero-for-f64">f64</a></li><li><a href="#impl-Zero-for-i16">i16</a></li><li><a href="#impl-Zero-for-i32">i32</a></li><li><a href="#impl-Zero-for-i64">i64</a></li><li><a href="#impl-Zero-for-i8">i8</a></li><li><a href="#impl-Zero-for-isize">isize</a></li><li><a href="#impl-Zero-for-u16">u16</a></li><li><a href="#impl-Zero-for-u32">u32</a></li><li><a href="#impl-Zero-for-u64">u64</a></li><li><a href="#impl-Zero-for-u8">u8</a></li><li><a href="#impl-Zero-for-usize">usize</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In petgraph::matrix_graph</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../petgraph/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">petgraph</a>::<wbr><a href="index.html">matrix_graph</a>::<wbr><a class="trait" href="#">Zero</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/petgraph/matrix_graph.rs.html#147-153">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Zero {
|
|
|
// Required methods
|
|
|
fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self;
|
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.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>Base trait for types that can be wrapped in a <a href="struct.NotZero.html"><code>NotZero</code></a>.</p>
|
|
|
<p>Implementors must provide a singleton object that will be used to mark empty edges in a
|
|
|
<a href="struct.MatrixGraph.html"><code>MatrixGraph</code></a>.</p>
|
|
|
<p>Note that this trait is already implemented for the base numeric types.</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.zero" class="method"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#149">source</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section></summary><div class="docblock"><p>Return the singleton object which can be used as a sentinel value.</p>
|
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_zero" class="method"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#152">source</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return true if <code>self</code> is equal to the sentinel value.</p>
|
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</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-Zero-for-f32" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#180">source</a><a href="#impl-Zero-for-f32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="method.zero" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#180">source</a><a href="#method.zero" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#180">source</a><a href="#method.is_zero" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-f64" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#180">source</a><a href="#impl-Zero-for-f64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.f64.html">f64</a></h3></section></summary><div class="impl-items"><section id="method.zero-1" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#180">source</a><a href="#method.zero-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-1" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#180">source</a><a href="#method.is_zero-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-i8" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#impl-Zero-for-i8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="method.zero-2" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.zero-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-2" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.is_zero-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-i16" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#impl-Zero-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="method.zero-3" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.zero-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-3" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.is_zero-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-i32" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#impl-Zero-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i32.html">i32</a></h3></section></summary><div class="impl-items"><section id="method.zero-4" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.zero-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-4" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.is_zero-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-i64" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#impl-Zero-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="method.zero-5" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.zero-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-5" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.is_zero-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-isize" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#impl-Zero-for-isize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.isize.html">isize</a></h3></section></summary><div class="impl-items"><section id="method.zero-6" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.zero-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-6" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#179">source</a><a href="#method.is_zero-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-u8" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#impl-Zero-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.zero-7" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.zero-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-7" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.is_zero-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-u16" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#impl-Zero-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="method.zero-8" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.zero-8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-8" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.is_zero-8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-u32" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#impl-Zero-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="method.zero-9" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.zero-9" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-9" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.is_zero-9" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-u64" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#impl-Zero-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u64.html">u64</a></h3></section></summary><div class="impl-items"><section id="method.zero-10" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.zero-10" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-10" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.is_zero-10" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Zero-for-usize" class="impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#impl-Zero-for-usize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Zero.html" title="trait petgraph::matrix_graph::Zero">Zero</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a></h3></section></summary><div class="impl-items"><section id="method.zero-11" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.zero-11" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self</h4></section><section id="method.is_zero-11" class="method trait-impl"><a class="src rightside" href="../../src/petgraph/matrix_graph.rs.html#178">source</a><a href="#method.is_zero-11" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_zero" class="fn">is_zero</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.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/matrix_graph/trait.Zero.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |