mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2bc9ebdc6b'
${ noResults }
Trac3r-rust/doc/num/traits/float/trait.FloatCore.html

493 lines
91 KiB
Raw Normal View History Unescape

add doc
5 years ago
<!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 `FloatCore` trait in crate `num`."><meta name="keywords" content="rust, rustlang, rust-lang, FloatCore"><title>num::traits::float::FloatCore - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../../num/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait FloatCore</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.classify">classify</a><a href="#tymethod.epsilon">epsilon</a><a href="#tymethod.infinity">infinity</a><a href="#tymethod.integer_decode">integer_decode</a><a href="#tymethod.max_value">max_value</a><a href="#tymethod.min_positive_value">min_positive_value</a><a href="#tymethod.min_value">min_value</a><a href="#tymethod.nan">nan</a><a href="#tymethod.neg_infinity">neg_infinity</a><a href="#tymethod.neg_zero">neg_zero</a><a href="#tymethod.to_degrees">to_degrees</a><a href="#tymethod.to_radians">to_radians</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.abs">abs</a><a href="#method.ceil">ceil</a><a href="#method.floor">floor</a><a href="#method.fract">fract</a><a href="#method.is_finite">is_finite</a><a href="#method.is_infinite">is_infinite</a><a href="#method.is_nan">is_nan</a><a href="#method.is_normal">is_normal</a><a href="#method.is_sign_negative">is_sign_negative</a><a href="#method.is_sign_positive">is_sign_positive</a><a href="#method.max">max</a><a href="#method.min">min</a><a href="#method.powi">powi</a><a href="#method.recip">recip</a><a href="#method.round">round</a><a href="#method.signum">signum</a><a href="#method.trunc">trunc</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-FloatCore-for-f32">f32</a><a href="#impl-FloatCore-for-f64">f64</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>num</a>::<wbr><a href='../index.html'>traits</a>::<wbr><a href='index.html'>float</a></p><script>window.sidebarCurrent = {name: 'FloatCore', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><spa
fn <a href='#tymethod.infinity' class='fnname'>infinity</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.neg_infinity' class='fnname'>neg_infinity</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.nan' class='fnname'>nan</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.neg_zero' class='fnname'>neg_zero</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.min_value' class='fnname'>min_value</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.min_positive_value' class='fnname'>min_positive_value</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.epsilon' class='fnname'>epsilon</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.max_value' class='fnname'>max_value</a>() -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.classify' class='fnname'>classify</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/num/enum.FpCategory.html" title="enum core::num::FpCategory">FpCategory</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.to_degrees' class='fnname'>to_degrees</a>(self) -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.to_radians' class='fnname'>to_radians</a>(self) -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.integer_decode' class='fnname'>integer_decode</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
fn <a href='#method.is_nan' class='fnname'>is_nan</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.is_infinite' class='fnname'>is_infinite</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.is_finite' class='fnname'>is_finite</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.is_normal' class='fnname'>is_normal</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.floor' class='fnname'>floor</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.ceil' class='fnname'>ceil</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.round' class='fnname'>round</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.trunc' class='fnname'>trunc</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.fract' class='fnname'>fract</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.abs' class='fnname'>abs</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.signum' class='fnname'>signum</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.is_sign_positive' class='fnname'>is_sign_positive</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.is_sign_negative' class='fnname'>is_sign_negative</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.min' class='fnname'>min</a>(self, other: Self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.max' class='fnname'>max</a>(self, other: Self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.recip' class='fnname'>recip</a>(self) -&gt; Self { ... }
<div class='item-spacer'></div> fn <a href='#method.powi' class='fnname'>powi</a>(self, exp: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; Self { ... }
}</pre></div><div class='docblock'><p>Generic trait for floating point numbers that works with <code>no_std</code>.</p>
<p>This trait implements a subset of the <code>Float</code> trait.</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.infinity' class='method'><code id='infinity.v'>fn <a href='#tymethod.infinity' class='fnname'>infinity</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns positive infinity.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">T</span>::<span class="ident">infinity</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">x</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">INFINITY</span>);</pre></div>
</div><h3 id='tymethod.neg_infinity' class='method'><code id='neg_infinity.v'>fn <a href='#tymethod.neg_infinity' class='fnname'>neg_infinity</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns negative infinity.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">T</span>::<span class="ident">neg_infinity</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">x</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">NEG_INFINITY</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>);</pre></div>
</div><h3 id='tymethod.nan' class='method'><code id='nan.v'>fn <a href='#tymethod.nan' class='fnname'>nan</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns NaN.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>() {
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">T</span>::<span class="ident">nan</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">n</span> <span class="op">!</span><span class="op">=</span> <span class="ident">n</span>);
}
<span class="ident">check</span>::<span class="op">&lt;</span><span class="ident">f32</span><span class="op">&gt;</span>();
<span class="ident">check</span>::<span class="op">&lt;</span><span class="ident">f64</span><span class="op">&gt;</span>();</pre></div>
</div><h3 id='tymethod.neg_zero' class='method'><code id='neg_zero.v'>fn <a href='#tymethod.neg_zero' class='fnname'>neg_zero</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns <code>-0.0</code>.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">n</span>: <span class="ident">T</span>) {
<span class="kw">let</span> <span class="ident">z</span> <span class="op">=</span> <span class="ident">T</span>::<span class="ident">neg_zero</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">z</span>.<span class="ident">is_zero</span>());
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">T</span>::<span class="ident">one</span>() <span class="op">/</span> <span class="ident">z</span> <span class="op">=</span><span class="op">=</span> <span class="ident">n</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">NEG_INFINITY</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>);</pre></div>
</div><h3 id='tymethod.min_value' class='method'><code id='min_value.v'>fn <a href='#tymethod.min_value' class='fnname'>min_value</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns the smallest finite value that this type can represent.</p>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">T</span>::<span class="ident">min_value</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">x</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MIN</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>);</pre></div>
</div><h3 id='tymethod.min_positive_value' class='method'><code id='min_positive_value.v'>fn <a href='#tymethod.min_positive_value' class='fnname'>min_positive_value</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns the smallest positive, normalized value that this type can represent.</p>
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">T</span>::<span class="ident">min_positive_value</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">x</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MIN_POSITIVE</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN_POSITIVE</span>);</pre></div>
</div><h3 id='tymethod.epsilon' class='method'><code id='epsilon.v'>fn <a href='#tymethod.epsilon' class='fnname'>epsilon</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns epsilon, a small positive value.</p>
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">T</span>::<span class="ident">epsilon</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">x</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">EPSILON</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">EPSILON</span>);</pre></div>
</div><h3 id='tymethod.max_value' class='method'><code id='max_value.v'>fn <a href='#tymethod.max_value' class='fnname'>max_value</a>() -&gt; Self</code></h3><div class='docblock'><p>Returns the largest finite value that this type can represent.</p>
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">T</span>::<span class="ident">max_value</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">x</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MAX</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MAX</span>);</pre></div>
</div><h3 id='tymethod.classify' class='method'><code id='classify.v'>fn <a href='#tymethod.classify' class='fnname'>classify</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/num/enum.FpCategory.html" title="enum core::num::FpCategory">FpCategory</a></code></h3><div class='docblock'><p>Returns the floating point category of the number. If only one property
is going to be tested, it is generally faster to use the specific
predicate instead.</p>
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">num</span>::<span class="ident">FpCategory</span>;
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">c</span>: <span class="ident">FpCategory</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">classify</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">c</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="ident">FpCategory</span>::<span class="ident">Infinite</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MAX</span>, <span class="ident">FpCategory</span>::<span class="ident">Normal</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NAN</span>, <span class="ident">FpCategory</span>::<span class="ident">Nan</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN_POSITIVE</span>, <span class="ident">FpCategory</span>::<span class="ident">Normal</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN_POSITIVE</span> <span class="op">/</span> <span class="number">2.0</span>, <span class="ident">FpCategory</span>::<span class="ident">Subnormal</span>);
<span class="ident">check</span>(<span class="number">0.0f64</span>, <span class="ident">FpCategory</span>::<span class="ident">Zero</span>);</pre></div>
</div><h3 id='tymethod.to_degrees' class='method'><code id='to_degrees.v'>fn <a href='#tymethod.to_degrees' class='fnname'>to_degrees</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Converts to degrees, assuming the number is in radians.</p>
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">rad</span>: <span class="ident">T</span>, <span class="ident">deg</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">rad</span>.<span class="ident">to_degrees</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">deg</span>);
}
<span class="ident">check</span>(<span class="number">0.0f32</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">consts</span>::<span class="ident">PI</span>, <span class="number">180.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">consts</span>::<span class="ident">FRAC_PI_4</span>, <span class="number">45.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">INFINITY</span>, <span class="ident">f64</span>::<span class="ident">INFINITY</span>);</pre></div>
</div><h3 id='tymethod.to_radians' class='method'><code id='to_radians.v'>fn <a href='#tymethod.to_radians' class='fnname'>to_radians</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Converts to radians, assuming the number is in degrees.</p>
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">deg</span>: <span class="ident">T</span>, <span class="ident">rad</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">deg</span>.<span class="ident">to_radians</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">rad</span>);
}
<span class="ident">check</span>(<span class="number">0.0f32</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="number">180.0</span>, <span class="ident">f32</span>::<span class="ident">consts</span>::<span class="ident">PI</span>);
<span class="ident">check</span>(<span class="number">45.0</span>, <span class="ident">f64</span>::<span class="ident">consts</span>::<span class="ident">FRAC_PI_4</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">INFINITY</span>, <span class="ident">f64</span>::<span class="ident">INFINITY</span>);</pre></div>
</div><h3 id='tymethod.integer_decode' class='method'><code id='integer_decode.v'>fn <a href='#tymethod.integer_decode' class='fnname'>integer_decode</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><div class='docblock'><p>Returns the mantissa, base 2 exponent, and sign as integers, respectively.
The original number can be recovered by <code>sign * mantissa * 2 ^ exponent</code>.</p>
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">m</span>: <span class="ident">u64</span>, <span class="ident">e</span>: <span class="ident">i16</span>, <span class="ident">s</span>:<span class="ident">i8</span>) {
<span class="kw">let</span> (<span class="ident">mantissa</span>, <span class="ident">exponent</span>, <span class="ident">sign</span>) <span class="op">=</span> <span class="ident">x</span>.<span class="ident">integer_decode</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mantissa</span>, <span class="ident">m</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">exponent</span>, <span class="ident">e</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">sign</span>, <span class="ident">s</span>);
}
<span class="ident">check</span>(<span class="number">2.0f32</span>, <span class="number">1</span> <span class="op">&lt;</span><span class="op">&lt;</span> <span class="number">23</span>, <span class="op">-</span><span class="number">22</span>, <span class="number">1</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">2.0f32</span>, <span class="number">1</span> <span class="op">&lt;</span><span class="op">&lt;</span> <span class="number">23</span>, <span class="op">-</span><span class="number">22</span>, <span class="op">-</span><span class="number">1</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="number">1</span> <span class="op">&lt;</span><span class="op">&lt;</span> <span class="number">23</span>, <span class="number">105</span>, <span class="number">1</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>, <span class="number">1</span> <span class="op">&lt;</span><span class="op">&lt;</span> <span class="number">52</span>, <span class="number">972</span>, <span class="op">-</span><span class="number">1</span>);</pre></div>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.is_nan' class='method'><code id='is_nan.v'>fn <a href='#method.is_nan' class='fnname'>is_nan</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns <code>true</code> if the number is NaN.</p>
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">p</span>: <span class="ident">bool</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_nan</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">p</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">NAN</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NAN</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="number">0.0f64</span>, <span class="bool-val">false</span>);</pre></div>
</div><h3 id='method.is_infinite' class='method'><code id='is_infinite.v'>fn <a href='#method.is_infinite' class='fnname'>is_infinite</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns <code>true</code> if the number is infinite.</p>
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">p</span>: <span class="ident">bool</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_infinite</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">p</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">NEG_INFINITY</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">NAN</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">INFINITY</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="number">0.0f64</span>, <span class="bool-val">false</span>);</pre></div>
</div><h3 id='method.is_finite' class='method'><code id='is_finite.v'>fn <a href='#method.is_finite' class='fnname'>is_finite</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns <code>true</code> if the number is neither infinite or NaN.</p>
<h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">p</span>: <span class="ident">bool</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_finite</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">p</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MAX</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN_POSITIVE</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NAN</span>, <span class="bool-val">false</span>);</pre></div>
</div><h3 id='method.is_normal' class='method'><code id='is_normal.v'>fn <a href='#method.is_normal' class='fnname'>is_normal</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns <code>true</code> if the number is neither zero, infinite, subnormal or NaN.</p>
<h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">p</span>: <span class="ident">bool</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_normal</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">p</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MAX</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN_POSITIVE</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="number">0.0f64</span>, <span class="bool-val">false</span>);</pre></div>
</div><h3 id='method.floor' class='method'><code id='floor.v'>fn <a href='#method.floor' class='fnname'>floor</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Returns the largest integer less than or equal to a number.</p>
<h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">floor</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="ident">f32</span>::<span class="ident">INFINITY</span>);
<span class="ident">check</span>(<span class="number">0.9f32</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">1.1f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.9f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.1f64</span>, <span class="op">-</span><span class="number">2.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="ident">f64</span>::<span class="ident">MIN</span>);</pre></div>
</div><h3 id='method.ceil' class='method'><code id='ceil.v'>fn <a href='#method.ceil' class='fnname'>ceil</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Returns the smallest integer greater than or equal to a number.</p>
<h1 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">ceil</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="ident">f32</span>::<span class="ident">INFINITY</span>);
<span class="ident">check</span>(<span class="number">0.9f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">1.1f32</span>, <span class="number">2.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.9f64</span>, <span class="op">-</span><span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.1f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="ident">f64</span>::<span class="ident">MIN</span>);</pre></div>
</div><h3 id='method.round' class='method'><code id='round.v'>fn <a href='#method.round' class='fnname'>round</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Returns the nearest integer to a number. Round half-way cases away from <code>0.0</code>.</p>
<h1 id="examples-18" class="section-header"><a href="#examples-18">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">round</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="ident">f32</span>::<span class="ident">INFINITY</span>);
<span class="ident">check</span>(<span class="number">0.4f32</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="number">0.5f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">0.6f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.4f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.5f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.6f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="ident">f64</span>::<span class="ident">MIN</span>);</pre></div>
</div><h3 id='method.trunc' class='method'><code id='trunc.v'>fn <a href='#method.trunc' class='fnname'>trunc</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Return the integer part of a number.</p>
<h1 id="examples-19" class="section-header"><a href="#examples-19">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">trunc</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="ident">f32</span>::<span class="ident">INFINITY</span>);
<span class="ident">check</span>(<span class="number">0.9f32</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">1.1f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.9f64</span>, <span class="op">-</span><span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.1f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="ident">f64</span>::<span class="ident">MIN</span>);</pre></div>
</div><h3 id='method.fract' class='method'><code id='fract.v'>fn <a href='#method.fract' class='fnname'>fract</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Returns the fractional part of a number.</p>
<h1 id="examples-20" class="section-header"><a href="#examples-20">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">fract</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MAX</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="number">0.75f32</span>, <span class="number">0.75</span>);
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="number">1.25f32</span>, <span class="number">0.25</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.75f64</span>, <span class="op">-</span><span class="number">0.75</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.25f64</span>, <span class="op">-</span><span class="number">0.25</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="number">0.0</span>);</pre></div>
</div><h3 id='method.abs' class='method'><code id='abs.v'>fn <a href='#method.abs' class='fnname'>abs</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Computes the absolute value of <code>self</code>. Returns <code>FloatCore::nan()</code> if the
number is <code>FloatCore::nan()</code>.</p>
<h1 id="examples-21" class="section-header"><a href="#examples-21">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">abs</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="ident">f32</span>::<span class="ident">INFINITY</span>);
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">0.0f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="ident">f64</span>::<span class="ident">MAX</span>);</pre></div>
</div><h3 id='method.signum' class='method'><code id='signum.v'>fn <a href='#method.signum' class='fnname'>signum</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Returns a number that represents the sign of <code>self</code>.</p>
<ul>
<li><code>1.0</code> if the number is positive, <code>+0.0</code> or <code>FloatCore::infinity()</code></li>
<li><code>-1.0</code> if the number is negative, <code>-0.0</code> or <code>FloatCore::neg_infinity()</code></li>
<li><code>FloatCore::nan()</code> if the number is <code>FloatCore::nan()</code></li>
</ul>
<h1 id="examples-22" class="section-header"><a href="#examples-22">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">signum</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">3.0f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">0.0f32</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">3.0f64</span>, <span class="op">-</span><span class="number">1.0</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN</span>, <span class="op">-</span><span class="number">1.0</span>);</pre></div>
</div><h3 id='method.is_sign_positive' class='method'><code id='is_sign_positive.v'>fn <a href='#method.is_sign_positive' class='fnname'>is_sign_positive</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns <code>true</code> if <code>self</code> is positive, including <code>+0.0</code> and
<code>FloatCore::infinity()</code>, and since Rust 1.20 also
<code>FloatCore::nan()</code>.</p>
<h1 id="examples-23" class="section-header"><a href="#examples-23">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">p</span>: <span class="ident">bool</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_sign_positive</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">p</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MAX</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="number">0.0f32</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN_POSITIVE</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="ident">f64</span>::<span class="ident">NAN</span>, <span class="bool-val">false</span>);</pre></div>
</div><h3 id='method.is_sign_negative' class='method'><code id='is_sign_negative.v'>fn <a href='#method.is_sign_negative' class='fnname'>is_sign_negative</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns <code>true</code> if <code>self</code> is negative, including <code>-0.0</code> and
<code>FloatCore::neg_infinity()</code>, and since Rust 1.20 also
<code>-FloatCore::nan()</code>.</p>
<h1 id="examples-24" class="section-header"><a href="#examples-24">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">p</span>: <span class="ident">bool</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">is_sign_negative</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">p</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">MAX</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="number">0.0f32</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>, <span class="bool-val">true</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">MIN_POSITIVE</span>, <span class="bool-val">false</span>);
<span class="ident">check</span>(<span class="ident">f64</span>::<span class="ident">NAN</span>, <span class="bool-val">false</span>);</pre></div>
</div><h3 id='method.min' class='method'><code id='min.v'>fn <a href='#method.min' class='fnname'>min</a>(self, other: Self) -&gt; Self</code></h3><div class='docblock'><p>Returns the minimum of the two numbers.</p>
<p>If one of the arguments is NaN, then the other argument is returned.</p>
<h1 id="examples-25" class="section-header"><a href="#examples-25">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>, <span class="ident">min</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">min</span>(<span class="ident">y</span>) <span class="op">=</span><span class="op">=</span> <span class="ident">min</span>);
}
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="number">2.0</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">NAN</span>, <span class="number">2.0</span>, <span class="number">2.0</span>);
<span class="ident">check</span>(<span class="number">1.0f64</span>, <span class="op">-</span><span class="number">2.0</span>, <span class="op">-</span><span class="number">2.0</span>);
<span class="ident">check</span>(<span class="number">1.0f64</span>, <span class="ident">f64</span>::<span class="ident">NAN</span>, <span class="number">1.0</span>);</pre></div>
</div><h3 id='method.max' class='method'><code id='max.v'>fn <a href='#method.max' class='fnname'>max</a>(self, other: Self) -&gt; Self</code></h3><div class='docblock'><p>Returns the maximum of the two numbers.</p>
<p>If one of the arguments is NaN, then the other argument is returned.</p>
<h1 id="examples-26" class="section-header"><a href="#examples-26">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>, <span class="ident">min</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">max</span>(<span class="ident">y</span>) <span class="op">=</span><span class="op">=</span> <span class="ident">min</span>);
}
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="number">2.0</span>, <span class="number">2.0</span>);
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="ident">f32</span>::<span class="ident">NAN</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="number">2.0</span>, <span class="number">2.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="ident">f64</span>::<span class="ident">NAN</span>, <span class="op">-</span><span class="number">1.0</span>);</pre></div>
</div><h3 id='method.recip' class='method'><code id='recip.v'>fn <a href='#method.recip' class='fnname'>recip</a>(self) -&gt; Self</code></h3><div class='docblock'><p>Returns the reciprocal (multiplicative inverse) of the number.</p>
<h1 id="examples-27" class="section-header"><a href="#examples-27">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">f32</span>, <span class="ident">f64</span>};
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">y</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">recip</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">y</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">y</span>.<span class="ident">recip</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">x</span>);
}
<span class="ident">check</span>(<span class="ident">f32</span>::<span class="ident">INFINITY</span>, <span class="number">0.0</span>);
<span class="ident">check</span>(<span class="number">2.0f32</span>, <span class="number">0.5</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.25f64</span>, <span class="op">-</span><span class="number">4.0</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">0.0f64</span>, <span class="ident">f64</span>::<span class="ident">NEG_INFINITY</span>);</pre></div>
</div><h3 id='method.powi' class='method'><code id='powi.v'>fn <a href='#method.powi' class='fnname'>powi</a>(self, exp: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; Self</code></h3><div class='docblock'><p>Raise a number to an integer power.</p>
<p>Using this function is generally faster than using <code>powf</code></p>
<h1 id="examples-28" class="section-header"><a href="#examples-28">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">float</span>::<span class="ident">FloatCore</span>;
<span class="kw">fn</span> <span class="ident">check</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">FloatCore</span><span class="op">&gt;</span>(<span class="ident">x</span>: <span class="ident">T</span>, <span class="ident">exp</span>: <span class="ident">i32</span>, <span class="ident">powi</span>: <span class="ident">T</span>) {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">powi</span>(<span class="ident">exp</span>) <span class="op">=</span><span class="op">=</span> <span class="ident">powi</span>);
}
<span class="ident">check</span>(<span class="number">9.0f32</span>, <span class="number">2</span>, <span class="number">81.0</span>);
<span class="ident">check</span>(<span class="number">1.0f32</span>, <span class="op">-</span><span class="number">2</span>, <span class="number">1.0</span>);
<span class="ident">check</span>(<span class="number">10.0f64</span>, <span class="number">20</span>, <span class="number">1e20</span>);
<span class="ident">check</span>(<span class="number">4.0f64</span>, <span class="op">-</span><span class="number">2</span>, <span class="number">0.0625</span>);
<span class="ident">check</span>(<span class="op">-</span><span class="number">1.0f64</span>, <span class="ident">std</span>::<span class="ident">i32</span>::<span class="ident">MIN</span>, <span class="number">1.0</span>);</pre></div>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-FloatCore-for-f32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num/traits/float/trait.FloatCore.html" title="trait num::traits::float::FloatCore">FloatCore</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-FloatCore-for-f32' class='anchor'></a><a class='srclink' href='../../../src/num_traits/float.rs.html#746-816' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.infinity' class="method hidden"><code id='infinity.v-1'>fn <a href='#method.infinity' class='fnname'>infinity</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.neg_infinity' class="method hidden"><code id='neg_infinity.v-1'>fn <a href='#method.neg_infinity' class='fnname'>neg_infinity</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.nan' class="method hidden"><code id='nan.v-1'>fn <a href='#method.nan' class='fnname'>nan</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.neg_zero' class="method hidden"><code id='neg_zero.v-1'>fn <a href='#method.neg_zero' class='fnname'>neg_zero</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.min_value' class="method hidden"><code id='min_value.v-1'>fn <a href='#method.min_value' class='fnname'>min_value</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.min_positive_value' class="method hidden"><code id='min_positive_value.v-1'>fn <a href='#method.min_positive_value' class='fnname'>min_positive_value</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.epsilon' class="method hidden"><code id='epsilon.v-1'>fn <a href='#method.epsilon' class='fnname'>epsilon</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.max_value' class="method hidden"><code id='max_value.v-1'>fn <a href='#method.max_value' class='fnname'>max_value</a>() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../src/num_traits/macros.rs.html#33-35' title='goto source code'>[src]</a></h4><h4 id='method.integer_decode' class="method hidden"><code id='integer_decode.v-1'>fn <a href='#method.integer_decode' class='fnname'>integer_decode</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclin
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../../implementors/num_traits/float/trait.FloatCore.js">
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "num";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>