simon/sidekick
1
0
Fork 0
mirror of https://github.com/c-cube/sidekick.git synced 2026-01-21 08:46:44 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
sidekick/dev/sidekick/Sidekick_cc/Plugin/Make/index.html
c-cube 2c7065e7fd deploy: eff6016151
2023-12-27 22:31:52 +00:00

2 lines
6.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (sidekick.Sidekick_cc.Plugin.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><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">sidekick</a> &#x00BB; <a href="../../index.html">Sidekick_cc</a> &#x00BB; <a href="../index.html">Plugin</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Plugin.Make</span></code></h1><p>Create a plugin builder from the given per-class monoid</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-M"><a href="#argument-1-M" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-M/index.html">M</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec module anchored" id="module-M"><a href="#module-M" class="anchor"></a><code><span><span class="keyword">module</span> M</span><span> = <a href="argument-1-M/index.html">M</a></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-DYN_PL_FOR_M"><a href="#module-type-DYN_PL_FOR_M" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-DYN_PL_FOR_M/index.html">DYN_PL_FOR_M</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><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="keyword">module</span> <a href="module-type-DYN_PL_FOR_M/index.html">DYN_PL_FOR_M</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_and_setup"><a href="#val-create_and_setup" class="anchor"></a><code><span><span class="keyword">val</span> create_and_setup : <span><span class="optlabel">?size</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../../CC/index.html#type-t">CC.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Create a new monoid state</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mem"><a href="#val-mem" class="anchor"></a><code><span><span class="keyword">val</span> mem : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../E_node/index.html#type-t">E_node.t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Does the CC.E_node.t have a monoid value?</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">&#45;&gt;</span></span> <span><a href="../../E_node/index.html#type-t">E_node.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="argument-1-M/index.html#type-t">M.t</a> option</span></span></code></div><div class="spec-doc"><p>Get monoid value for this CC.E_node.t, if any</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iter_all"><a href="#val-iter_all" class="anchor"></a><code><span><span class="keyword">val</span> iter_all : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="../../CC/index.html#type-repr">CC.repr</a> * <a href="argument-1-M/index.html#type-t">M.t</a>)</span> <span class="xref-unresolved">Iter</span>.t</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../Sidekick_sigs/module-type-BACKTRACKABLE0/index.html">Sidekick_sigs.BACKTRACKABLE0</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../Sidekick_sigs/module-type-BACKTRACKABLE0/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-n_levels"><a href="#val-n_levels" class="anchor"></a><code><span><span class="keyword">val</span> n_levels : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Number of levels</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-push_level"><a href="#val-push_level" class="anchor"></a><code><span><span class="keyword">val</span> push_level : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Push a backtracking point</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pop_levels"><a href="#val-pop_levels" class="anchor"></a><code><span><span class="keyword">val</span> pop_levels : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>pop_levels st n</code> removes <code>n</code> levels</p></div></div></details></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../Sidekick_sigs/module-type-PRINT/index.html">Sidekick_sigs.PRINT</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../Sidekick_sigs/module-type-PRINT/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="#type-t">t</a> <a href="../../../Sidekick_sigs/index.html#type-printer">Sidekick_sigs.printer</a></span></span></code></div></div></details></div></div></body></html>
Reference in a new issue View git blame Copy permalink