pumpkin/ramp/ll/limb/index.html

159 lines
6.6 KiB
HTML
Raw Normal View History

2016-05-10 15:03:32 -04:00
<!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 `limb` mod in crate `ramp`.">
<meta name="keywords" content="rust, rustlang, rust-lang, limb">
<title>ramp::ll::limb - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>ramp</a>::<wbr><a href='../index.html'>ll</a></p><script>window.sidebarCurrent = {name: 'limb', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content mod">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>ramp</a>::<wbr><a href='../index.html'>ll</a>::<wbr><a class='mod' href=''>limb</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
2016-05-10 23:34:09 -04:00
</span><a id='src-739' class='srclink' href='../../../src/ramp/ll/limb.rs.html#15-695' title='goto source code'>[src]</a></span></h1>
2016-05-10 15:03:32 -04:00
<h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.Limb.html'
title='ramp::ll::limb::Limb'>Limb</a></td>
<td class='docblock short'>
<p>Helper newtype for operations.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='fn' href='fn.add_2.html'
title='ramp::ll::limb::add_2'>add_2</a></td>
<td class='docblock short'>
<p>Performs the two-word addition (ah, al) + (bh, bl), ignoring any overflow.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='fn' href='fn.div.html'
title='ramp::ll::limb::div'>div</a></td>
<td class='docblock short'>
<p>Divides the two-limb numerator <code>(nh, nl)</code> by <code>d</code>, returning a single-limb
quotient, Q, and remainder, R, as (Q, R).</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='fn' href='fn.div_preinv.html'
title='ramp::ll::limb::div_preinv'>div_preinv</a></td>
<td class='docblock short'>
<p>Divides <code>(nh, nl)</code> by <code>d</code> using the inverted limb <code>dinv</code>. Returns the quotient, Q, and
remainder, R, as (Q, R);</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='fn' href='fn.sub_2.html'
title='ramp::ll::limb::sub_2'>sub_2</a></td>
<td class='docblock short'>
<p>Performs the two-word subtraction (ah, al) - (bh, bl), ignoring any borrow.</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class='type' href='type.BaseInt.html'
title='ramp::ll::limb::BaseInt'>BaseInt</a></td>
<td class='docblock short'>
</td>
</tr></table></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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "ramp";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>