-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
3,019 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Countdown (multicore-bench.Multicore_bench.Countdown)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> » <a href="../index.html">Multicore_bench</a> » Countdown</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Countdown</span></code></h1><p>Scalable low-level countdown.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Represents a countdown counter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span class="label">n_domains</span>:int <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ~n_domains ()</code> returns a new countdown counter with initial value of <code>0</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-non_atomic_set"><a href="#val-non_atomic_set" class="anchor"></a><code><span><span class="keyword">val</span> non_atomic_set : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>non_atomic_set countdown count</code> sets the <code>count</code> of the <code>countdown</code>.</p><p>⚠️ This operation is not atomic. However, it is safe to call <code>non_atomic_set</code> with the same <code>countdown</code> and <code>count</code> in parallel, because the <code>countdown</code> will be initialized deterministically.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>get countdown</code> returns the count of the <code>countdown</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-alloc"><a href="#val-alloc" class="anchor"></a><code><span><span class="keyword">val</span> alloc : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span class="label">domain_index</span>:int <span class="arrow">-></span></span> <span><span class="label">batch</span>:int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>alloc countdown ~domain_index ~batch</code> tries to reduce the count of the <code>countdown</code> by at most <code>batch</code> (which must be positive) and returns the number by which the count was reduced or <code>0</code> in case the count was already <code>0</code>.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Countdown (multicore-bench.Multicore_bench.Countdown)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../'; | ||
| let search_urls = ['../../db.js','../../../sherlodoc.js']; | ||
| </script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> » <a href="../index.html">Multicore_bench</a> » Countdown</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Countdown</span></code></h1><p>Scalable low-level countdown.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Represents a countdown counter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span class="label">n_domains</span>:int <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ~n_domains ()</code> returns a new countdown counter with initial value of <code>0</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-non_atomic_set"><a href="#val-non_atomic_set" class="anchor"></a><code><span><span class="keyword">val</span> non_atomic_set : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>non_atomic_set countdown count</code> sets the <code>count</code> of the <code>countdown</code>.</p><p>⚠️ This operation is not atomic. However, it is safe to call <code>non_atomic_set</code> with the same <code>countdown</code> and <code>count</code> in parallel, because the <code>countdown</code> will be initialized deterministically.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>get countdown</code> returns the count of the <code>countdown</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-alloc"><a href="#val-alloc" class="anchor"></a><code><span><span class="keyword">val</span> alloc : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span class="label">domain_index</span>:int <span class="arrow">-></span></span> <span><span class="label">batch</span>:int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>alloc countdown ~domain_index ~batch</code> tries to reduce the count of the <code>countdown</code> by at most <code>batch</code> (which must be positive) and returns the number by which the count was reduced or <code>0</code> in case the count was already <code>0</code>.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Suite (multicore-bench.Multicore_bench.Suite)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> » <a href="../index.html">Multicore_bench</a> » Suite</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Suite</span></code></h1><p>Dealing with benchmark suites.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span><span class="label">budgetf</span>:float <span class="arrow">-></span></span> <span><a href="../Metric/index.html#type-t">Metric.t</a> list</span></span></code></div><div class="spec-doc"><p>Represents a benchmark suite, i.e. a function that produces a list of metric outputs for <a href="https://github.com/ocurrent/current-bench">current-bench</a>.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Suite (multicore-bench.Multicore_bench.Suite)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../'; | ||
| let search_urls = ['../../db.js','../../../sherlodoc.js']; | ||
| </script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">multicore-bench</a> » <a href="../index.html">Multicore_bench</a> » Suite</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Multicore_bench.Suite</span></code></h1><p>Dealing with benchmark suites.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span><span class="label">budgetf</span>:float <span class="arrow">-></span></span> <span><a href="../Metric/index.html#type-t">Metric.t</a> list</span></span></code></div><div class="spec-doc"><p>Represents a benchmark suite, i.e. a function that produces a list of metric outputs for <a href="https://github.com/ocurrent/current-bench">current-bench</a>.</p></div></div></div></body></html> |
Oops, something went wrong.