difftastic/rustdoc/libm/index.html

8 lines
19 KiB
HTML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="libm in pure Rust"><title>libm - 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="libm" 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="../crates.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 mod crate"><!--[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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../libm/index.html">libm</a><span class="version">0.2.8</span></h2></div><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section></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="../libm/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>Crate <a class="mod" href="#">libm</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/libm/lib.rs.html#1-59">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>libm in pure Rust</p>
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Libm.html" title="struct libm::Libm">Libm</a></div><div class="desc docblock-short">Generic helper for libm functions, abstracting over f32 and f64. <br/></div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.acos.html" title="fn libm::acos">acos</a></div><div class="desc docblock-short">Arccosine (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.acosf.html" title="fn libm::acosf">acosf</a></div><div class="desc docblock-short">Arccosine (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.acosh.html" title="fn libm::acosh">acosh</a></div><div class="desc docblock-short">Inverse hyperbolic cosine (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.acoshf.html" title="fn libm::acoshf">acoshf</a></div><div class="desc docblock-short">Inverse hyperbolic cosine (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.asin.html" title="fn libm::asin">asin</a></div><div class="desc docblock-short">Arcsine (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.asinf.html" title="fn libm::asinf">asinf</a></div><div class="desc docblock-short">Arcsine (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.asinh.html" title="fn libm::asinh">asinh</a></div><div class="desc docblock-short">Inverse hyperbolic sine (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.asinhf.html" title="fn libm::asinhf">asinhf</a></div><div class="desc docblock-short">Inverse hyperbolic sine (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.atan.html" title="fn libm::atan">atan</a></div><div class="desc docblock-short">Arctangent (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.atan2.html" title="fn libm::atan2">atan2</a></div><div class="desc docblock-short">Arctangent of y/x (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.atan2f.html" title="fn libm::atan2f">atan2f</a></div><div class="desc docblock-short">Arctangent of y/x (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.atanf.html" title="fn libm::atanf">atanf</a></div><div class="desc docblock-short">Arctangent (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.atanh.html" title="fn libm::atanh">atanh</a></div><div class="desc docblock-short">Inverse hyperbolic tangent (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.atanhf.html" title="fn libm::atanhf">atanhf</a></div><div class="desc docblock-short">Inverse hyperbolic tangent (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.cbrt.html" title="fn libm::cbrt">cbrt</a></div><div class="desc docblock-short">Computes the cube root of the argument.</div></li><li><div class="item-name"><a class="fn" href="fn.cbrtf.html" title="fn libm::cbrtf">cbrtf</a></div><div class="desc docblock-short">Cube root (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.ceil.html" title="fn libm::ceil">ceil</a></div><div class="desc docblock-short">Ceil (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.ceilf.html" title="fn libm::ceilf">ceilf</a></div><div class="desc docblock-short">Ceil (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.copysign.html" title="fn libm::copysign">copysign</a></div><div class="desc docblock-short">Sign of Y, magnitude of X (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.copysignf.html" title="fn libm::copysignf">copysignf</a></div><div class="desc docblock-short">Sign of Y, magnitude of X (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.cos.html" title="fn libm::cos">cos</a></div></li><li><div class="item-name"><a class="fn" href="fn.cosf.html" title="fn libm::cosf">cosf</a></div></li><li><div class="item-name"><a class="fn" href="fn.cosh.html" title="fn libm::cosh">cosh</a></div><div class="desc docblock-short">Hyperbolic cosine (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.coshf.html" title="fn libm::coshf">coshf</a></div><div class="desc docblock-short">Hyperbolic cosine (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.erf.html" title="fn libm::erf">erf</a></div><div class="desc docblock-short">Error function (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.erfc.html" title="fn libm::erfc">erfc</a></div><div class="desc docblock-short">Complementary error function (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.erfcf.html" title="fn libm::erfcf">erfcf</a></div><div class="desc docblock-short">Complementary error function (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.erff.html" title="fn libm::erff">erff</a></div><div class="desc docblock-short">Error function (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.exp.html" title="fn libm::exp">exp</a></div><div class="desc docblock-short">Exponential, base <em>e</em> (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.exp2.html" title="fn libm::exp2">exp2</a></div><div class="desc docblock-short">Exponential, base 2 (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.exp2f.html" title="fn libm::exp2f">exp2f</a></div><div class="desc docblock-short">Exponential, base 2 (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.exp10.html" title="fn libm::exp10">exp10</a></div></li><li><div class="item-name"><a class="fn" href="fn.exp10f.html" title="fn libm::exp10f">exp10f</a></div></li><li><div class="item-name"><a class="fn" href="fn.expf.html" title="fn libm::expf">expf</a></div><div class="desc docblock-short">Exponential, base <em>e</em> (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.expm1.html" title="fn libm::expm1">expm1</a></div><div class="desc docblock-short">Exponential, base <em>e</em>, of x-1 (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.expm1f.html" title="fn libm::expm1f">expm1f</a></div><div class="desc docblock-short">Exponential, base <em>e</em>, of x-1 (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.fabs.html" title="fn libm::fabs">fabs</a></div><div class="desc docblock-short">Absolute value (magnitude) (f64)
Calculates the absolute value (magnitude) of the argument <code>x</code>,
by direct manipulation of the bit representation of <code>x</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.fabsf.html" title="fn libm::fabsf">fabsf</a></div><div class="desc docblock-short">Absolute value (magnitude) (f32)
Calculates the absolute value (magnitude) of the argument <code>x</code>,
by direct manipulation of the bit representation of <code>x</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.fdim.html" title="fn libm::fdim">fdim</a></div><div class="desc docblock-short">Positive difference (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.fdimf.html" title="fn libm::fdimf">fdimf</a></div><div class="desc docblock-short">Positive difference (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.floor.html" title="fn libm::floor">floor</a></div><div class="desc docblock-short">Floor (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.floorf.html" title="fn libm::floorf">floorf</a></div><div class="desc docblock-short">Floor (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.fma.html" title="fn libm::fma">fma</a></div><div class="desc docblock-short">Floating multiply add (f64)</div></li><li><div class="item-name"><a class="fn" href="fn.fmaf.html" title="fn libm::fmaf">fmaf</a></div><div class="desc docblock-short">Floating multiply add (f32)</div></li><li><div class="item-name"><a class="fn" href="fn.fmax.html" title="fn libm::fmax">fmax</a></div></li><li><div class="item-name"><a class="fn" href="fn.fmaxf.html" title="fn libm::fmaxf">fmaxf</a></div></li><li><div class="item-name"><a class="fn" href="fn.fmin.html" title="fn libm::fmin">fmin</a></div></li><li><div class="item-name"><a class="fn" href="fn.fminf.html" title="fn libm::fminf">fminf</a></div></li><li><div class="item-name"><a class="fn" href="fn.fmod.html" title="fn libm::fmod">fmod</a></div></li><li><div class="item-name"><a class="fn" href="fn.fmodf.html" title="fn libm::fmodf">fmodf</a></div></li><li><div class="item-name"><a class="fn" href="fn.frexp.html" title="fn libm::frexp">frexp</a></div></li><li><div class="item-name"><a class="fn" href="fn.frexpf.html" title="fn libm::frexpf">frexpf</a></div></li><li><div class="item-name"><a class="fn" href="fn.hypot.html" title="fn libm::hypot">hypot</a></div></li><li><div class="item-name"><a class="fn" href="fn.hypotf.html" title="fn libm::hypotf">hypotf</a></div></li><li><div class="item-name"><a class="fn" href="fn.ilogb.html" title="fn libm::ilogb">ilogb</a></div></li><li><div class="item-name"><a class="fn" href="fn.ilogbf.html" title="fn libm::ilogbf">ilogbf</a></div></li><li><div class="item-name"><a class="fn" href="fn.j0.html" title="fn libm::j0">j0</a></div></li><li><div class="item-name"><a class="fn" href="fn.j0f.html" title="fn libm::j0f">j0f</a></div></li><li><div class="item-name"><a class="fn" href="fn.j1.html" title="fn libm::j1">j1</a></div></li><li><div class="item-name"><a class="fn" href="fn.j1f.html" title="fn libm::j1f">j1f</a></div></li><li><div class="item-name"><a class="fn" href="fn.jn.html" title="fn libm::jn">jn</a></div></li><li><div class="item-name"><a class="fn" href="fn.jnf.html" title="fn libm::jnf">jnf</a></div></li><li><div class="item-name"><a class="fn" href="fn.ldexp.html" title="fn libm::ldexp">ldexp</a></div></li><li><div class="item-name"><a class="fn" href="fn.ldexpf.html" title="fn libm::ldexpf">ldexpf</a></div></li><li><div class="item-name"><a class="fn" href="fn.lgamma.html" title="fn libm::lgamma">lgamma</a></div></li><li><div class="item-name"><a class="fn" href="fn.lgamma_r.html" title="fn libm::lgamma_r">lgamma_r</a></div></li><li><div class="item-name"><a class="fn" href="fn.lgammaf.html" title="fn libm::lgammaf">lgammaf</a></div></li><li><div class="item-name"><a class="fn" href="fn.lgammaf_r.html" title="fn libm::lgammaf_r">lgammaf_r</a></div></li><li><div class="item-name"><a class="fn" href="fn.log.html" title="fn libm::log">log</a></div></li><li><div class="item-name"><a class="fn" href="fn.log1p.html" title="fn libm::log1p">log1p</a></div></li><li><div class="item-name"><a class="fn" href="fn.log1pf.html" title="fn libm::log1pf">log1pf</a></div></li><li><div class="item-name"><a class="fn" href="fn.log2.html" title="fn libm::log2">log2</a></div></li><li><div class="item-name"><a class="fn" href="fn.log2f.html" title="fn libm::log2f">log2f</a></div></li><li><div class="item-name"><a class="fn" href="fn.log10.html" title="fn libm::log10">log10</a></div></li><li><div class="item-name"><a class="fn" href="fn.log10f.html" title="fn libm::log10f">log10f</a></div></li><li><div class="item-name"><a class="fn" href="fn.logf.html" title="fn libm::logf">logf</a></div></li><li><div class="item-name"><a class="fn" href="fn.modf.html" title="fn libm::modf">modf</a></div></li><li><div class="item-name"><a class="fn" href="fn.modff.html" title="fn libm::modff">modff</a></div></li><li><div class="item-name"><a class="fn" href="fn.nextafter.html" title="fn libm::nextafter">nextafter</a></div></li><li><div class="item-name"><a class="fn" href="fn.nextafterf.html" title="fn libm::nextafterf">nextafterf</a></div></li><li><div class="item-name"><a class="fn" href="fn.pow.html" title="fn libm::pow">pow</a></div></li><li><div class="item-name"><a class="fn" href="fn.powf.html" title="fn libm::powf">powf</a></div></li><li><div class="item-name"><a class="fn" href="fn.remainder.html" title="fn libm::remainder">remainder</a></div></li><li><div class="item-name"><a class="fn" href="fn.remainderf.html" title="fn libm::remainderf">remainderf</a></div></li><li><div class="item-name"><a class="fn" href="fn.remquo.html" title="fn libm::remquo">remquo</a></div></li><li><div class="item-name"><a class="fn" href="fn.remquof.html" title="fn libm::remquof">remquof</a></div></li><li><div class="item-name"><a class="fn" href="fn.rint.html" title="fn libm::rint">rint</a></div></li><li><div class="item-name"><a class="fn" href="fn.rintf.html" title="fn libm::rintf">rintf</a></div></li><li><div class="item-name"><a class="fn" href="fn.round.html" title="fn libm::round">round</a></div></li><li><div class="item-name"><a class="fn" href="fn.roundf.html" title="fn libm::roundf">roundf</a></div></li><li><div class="item-name"><a class="fn" href="fn.scalbn.html" title="fn libm::scalbn">scalbn</a></div></li><li><div class="item-name"><a class="fn" href="fn.scalbnf.html" title="fn libm::scalbnf">scalbnf</a></div></li><li><div class="item-name"><a class="fn" href="fn.sin.html" title="fn libm::sin">sin</a></div></li><li><div class="item-name"><a class="fn" href="fn.sincos.html" title="fn libm::sincos">sincos</a></div></li><li><div class="item-name"><a class="fn" href="fn.sincosf.html" title="fn libm::sincosf">sincosf</a></div></li><li><div class="item-name"><a class="fn" href="fn.sinf.html" title="fn libm::sinf">sinf</a></div></li><li><div class="item-name"><a class="fn" href="fn.sinh.html" title="fn libm::sinh">sinh</a></div></li><li><div class="item-name"><a class="fn" href="fn.sinhf.html" title="fn libm::sinhf">sinhf</a></div></li><li><div class="item-name"><a class="fn" href="fn.sqrt.html" title="fn libm::sqrt">sqrt</a></div></li><li><div class="item-name"><a class="fn" href="fn.sqrtf.html" title="fn libm::sqrtf">sqrtf</a></div></li><li><div class="item-name"><a class="fn" href="fn.tan.html" title="fn libm::tan">tan</a></div></li><li><div class="item-name"><a class="fn" href="fn.tanf.html" title="fn libm::tanf">tanf</a></div></li><li><div class="item-name"><a class="fn" href="fn.tanh.html" title="fn libm::tanh">tanh</a></div></li><li><div class="item-name"><a class="fn" href="fn.tanhf.html" title="fn libm::tanhf">tanhf</a></div></li><li><div class="item-name"><a class="fn" href="fn.tgamma.html" title="fn libm::tgamma">tgamma</a></div></li><li><div class="item-name"><a class="fn" href="fn.tgammaf.html" title="fn libm::tgammaf">tgammaf</a></div></li><li><div class="item-name"><a class="fn" href="fn.trunc.html" title="fn libm::trunc">trunc</a></div></li><li><div class="item-name"><a class="fn" href="fn.truncf.html" title="fn libm::truncf">truncf</a></div></li><li><div class="item-name"><a class="fn" href="fn.y0.html" title="fn libm::y0">y0</a></div></li><li><div class="item-name"><a class="fn" href="fn.y0f.html" title="fn libm::y0f">y0f</a></div></li><li><div class="item-name"><a class="fn" href="fn.y1.html" title="fn libm::y1">y1</a></div></li><li><div class="item-name"><a class="fn" href="fn.y1f.html" title="fn libm::y1f">y1f</a></div></li><li><div class="item-name"><a class="fn" href="fn.yn.html" title="fn libm::yn">yn</a></div></li><li><div class="item-name"><a class="fn" href="fn.ynf.html" title="fn libm::ynf">ynf</a></div></li></ul></section></div></main></body></html>