<!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 `fix` fn in crate `odds`.">
<meta name="keywords" content="rust, rustlang, rust-lang, fix">
<title>odds::fix - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc fn">
<!--[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'>odds</a></p><script>window.sidebarCurrent = {name: 'fix', ty: 'fn', 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">
<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>odds</a>::<wbr><a class="fn" href=''>fix</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'>−</span>]
</a>
</span><a class='srclink' href='../src/odds/fix.rs.html#72-76' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn fix<T, R, F>(init: T, closure: F) -> R <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html" title="trait core::ops::Fn">Fn</a>(<a class="struct" href="../odds/struct.Fix.html" title="struct odds::Fix">Fix</a><T, R>, T) -> R, </span></pre><div class='docblock'><p>Fixpoint combinator for rust closures, generalized over the return type.</p>
<p>This is a wrapper function that uses the <code>Fix</code> type. The recursive closure
has two arguments, <code>Fix</code> and the argument type <code>T</code>.</p>
<p>In <strong>Fix<T, R></strong>, <strong>T</strong> is the argument type, and <strong>R</strong> is the return type,
<strong>R</strong> defaults to <strong>T</strong>.</p>
<p>Calling the <code>Fix</code> value only supports function call notation with the nightly
channel and the crate feature ‘unstable’ enabled; use the .call() method otherwise.</p>
<p>This helper function makes the type inference work out well.</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">odds</span>::<span class="ident">fix</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">120</span>, <span class="ident">fix</span>(<span class="number">5</span>, <span class="op">|</span><span class="ident">f</span>, <span class="ident">x</span><span class="op">|</span> <span class="kw">if</span> <span class="ident">x</span> <span class="op">==</span> <span class="number">0</span> { <span class="number">1</span> } <span class="kw">else</span> { <span class="ident">x</span> <span class="op">*</span> <span class="ident">f</span>.<span class="ident">call</span>(<span class="ident">x</span> <span class="op">-</span> <span class="number">1</span>) }));
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> [<span class="bool-val">true</span>, <span class="bool-val">false</span>];
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">fix</span>(<span class="kw-2">&</span><span class="ident">data</span>[..], <span class="op">|</span><span class="ident">f</span>, <span class="ident">x</span><span class="op">|</span> {
<span class="ident">x</span>.<span class="ident">len</span>() <span class="op">==</span> <span class="number">0</span> <span class="op">||</span> <span class="ident">x</span>[<span class="number">0</span>] <span class="op">&&</span> <span class="ident">f</span>.<span class="ident">call</span>(<span class="kw-2">&</span><span class="ident">x</span>[<span class="number">1</span>..])
}));
</pre>
</div></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>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "odds";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>