mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-25 19:39:32 +01:00
20 lines
33 KiB
HTML
20 lines
33 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="API documentation for the Rust `Gcd` trait in crate `gcd`."><title>Gcd in gcd - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="gcd" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../gcd/index.html">gcd</a><span class="version">2.3.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Gcd</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.gcd" title="gcd">gcd</a></li><li><a href="#tymethod.gcd_binary" title="gcd_binary">gcd_binary</a></li><li><a href="#tymethod.gcd_euclid" title="gcd_euclid">gcd_euclid</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Gcd-for-NonZero%3Cu128%3E" title="NonZeroU128">NonZeroU128</a></li><li><a href="#impl-Gcd-for-NonZero%3Cu16%3E" title="NonZeroU16">NonZeroU16</a></li><li><a href="#impl-Gcd-for-NonZero%3Cu32%3E" title="NonZeroU32">NonZeroU32</a></li><li><a href="#impl-Gcd-for-NonZero%3Cu64%3E" title="NonZeroU64">NonZeroU64</a></li><li><a href="#impl-Gcd-for-NonZero%3Cu8%3E" title="NonZeroU8">NonZeroU8</a></li><li><a href="#impl-Gcd-for-NonZero%3Cusize%3E" title="NonZeroUsize">NonZeroUsize</a></li><li><a href="#impl-Gcd-for-u128" title="u128">u128</a></li><li><a href="#impl-Gcd-for-u16" title="u16">u16</a></li><li><a href="#impl-Gcd-for-u32" title="u32">u32</a></li><li><a href="#impl-Gcd-for-u64" title="u64">u64</a></li><li><a href="#impl-Gcd-for-u8" title="u8">u8</a></li><li><a href="#impl-Gcd-for-usize" title="usize">usize</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate gcd</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">gcd</a></span><h1>Trait <span class="trait">Gcd</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/gcd/lib.rs.html#4-30">so
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.gcd" class="fn">gcd</a>(self, other: Self) -> Self;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.gcd_binary" class="fn">gcd_binary</a>(self, other: Self) -> Self;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.gcd_euclid" class="fn">gcd_euclid</a>(self, other: Self) -> Self;
|
||
|
|
}</code></pre><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.gcd" class="method"><a class="src rightside" href="../src/gcd/lib.rs.html#21">source</a><h4 class="code-header">fn <a href="#tymethod.gcd" class="fn">gcd</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Determine <a href="https://en.wikipedia.org/wiki/Greatest_common_divisor">greatest common divisor</a>
|
||
|
|
using <a href="#method.gcd_binary"><code>gcd_binary</code></a>.</p>
|
||
|
|
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gcd::Gcd;
|
||
|
|
|
||
|
|
<span class="macro">assert_eq!</span>(<span class="number">0</span>, <span class="number">0u8</span>.gcd(<span class="number">0</span>));
|
||
|
|
<span class="macro">assert_eq!</span>(<span class="number">10</span>, <span class="number">10u8</span>.gcd(<span class="number">0</span>));
|
||
|
|
<span class="macro">assert_eq!</span>(<span class="number">10</span>, <span class="number">0u8</span>.gcd(<span class="number">10</span>));
|
||
|
|
<span class="macro">assert_eq!</span>(<span class="number">10</span>, <span class="number">10u8</span>.gcd(<span class="number">20</span>));
|
||
|
|
<span class="macro">assert_eq!</span>(<span class="number">44</span>, <span class="number">2024u32</span>.gcd(<span class="number">748</span>));</code></pre></div>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.gcd_binary" class="method"><a class="src rightside" href="../src/gcd/lib.rs.html#25">source</a><h4 class="code-header">fn <a href="#tymethod.gcd_binary" class="fn">gcd_binary</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Determine <a href="https://en.wikipedia.org/wiki/Greatest_common_divisor">greatest common divisor</a>
|
||
|
|
using the <a href="https://en.wikipedia.org/wiki/Binary_GCD_algorithm">Binary GCD algorithm</a>.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.gcd_euclid" class="method"><a class="src rightside" href="../src/gcd/lib.rs.html#29">source</a><h4 class="code-header">fn <a href="#tymethod.gcd_euclid" class="fn">gcd_euclid</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Determine <a href="https://en.wikipedia.org/wiki/Greatest_common_divisor">greatest common divisor</a>
|
||
|
|
using the <a href="https://en.wikipedia.org/wiki/Euclidean_algorithm">Euclidean algorithm</a>.</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.83.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-Gcd-for-u8" class="impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#impl-Gcd-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Gcd.html" title="trait gcd::Gcd">Gcd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.gcd" class="method trait-impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#method.gcd" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.gcd" class="fn">gcd</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a></h4></section><section id="method.gcd_binary" class="method trait-impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#method.gcd_binary" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.gcd_binary" class="fn">gcd_binary</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a></h4></section><section id="method.gcd_euclid" class="method trait-impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#method.gcd_euclid" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.gcd_euclid" class="fn">gcd_euclid</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Gcd-for-u16" class="impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#impl-Gcd-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Gcd.html" title="trait gcd::Gcd">Gcd</a> for <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="method.gcd-1" class="method trait-impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#method.gcd-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.gcd" class="fn">gcd</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u16.html">u16</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u16.html">u16</a></h4></section><section id="method.gcd_binary-1" class="method trait-impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#method.gcd_binary-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.gcd_binary" class="fn">gcd_binary</a>(self, v: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u16.html">u16</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u16.html">u16</a></h4></section><section id="method.gcd_euclid-1" class="method trait-impl"><a class="src rightside" href="../src/gcd/lib.rs.html#106-113">source</a><a href="#method.gcd_euclid-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.gcd_euclid" class="fn">gcd_euclid</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u16.html">u16</a>)
|