Skip to content

Commit

Permalink
deploy documentation for 853b61c
Browse files Browse the repository at this point in the history
  • Loading branch information
the-blarney-fairy committed May 20, 2024
0 parents commit f766f8e
Show file tree
Hide file tree
Showing 69 changed files with 2,847 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Blarney-Backend-NewSMT.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions Blarney-BitPat.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>Blarney.BitPat</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">blarney-0.1.0.0</span><ul class="links" id="page-menu"><li><a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/BitPat.hs">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th valign="top">Copyright</th><td>(c) Matthew Naylor 2019</td></tr><tr><th>License</th><td>MIT</td></tr><tr><th>Maintainer</th><td>mattfn@gmail.com</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Safe Haskell</th><td>Safe-Inferred</td></tr><tr><th>Language</th><td>GHC2021</td></tr></table><p class="caption">Blarney.BitPat</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Inspired by Morten Rhiger's &quot;Type-Safe Pattern Combinators&quot;.</p></div></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">type</span> <a href="#t:BP">BP</a> n t0 t1 = <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; t0 -&gt; (<a href="Blarney.html#t:Bit" title="Blarney">Bit</a> 1, t1)</li><li class="src short"><a href="#v:literal">literal</a> :: <span class="keyword">forall</span> n t. <a href="file:///usr/local/.ghcup/ghc/9.2.1/share/doc/ghc-9.2.1/html/libraries/base-4.16.0.0/GHC-TypeLits.html#t:KnownNat" title="GHC.TypeLits">KnownNat</a> n =&gt; <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n t t</li><li class="src short"><a href="#v:variable">variable</a> :: <span class="keyword">forall</span> n t. <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n (<a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; t) t</li><li class="src short"><a href="#v:-60--35--62-">(&lt;#&gt;)</a> :: <a href="file:///usr/local/.ghcup/ghc/9.2.1/share/doc/ghc-9.2.1/html/libraries/base-4.16.0.0/GHC-TypeLits.html#t:KnownNat" title="GHC.TypeLits">KnownNat</a> n0 =&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n0 t0 t1 -&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n1 t1 t2 -&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> (n0 <a href="file:///usr/local/.ghcup/ghc/9.2.1/share/doc/ghc-9.2.1/html/libraries/base-4.16.0.0/GHC-TypeLits.html#t:-43-" title="GHC.TypeLits">+</a> n1) t0 t2</li><li class="src short"><a href="#v:-61--61--62-">(==&gt;)</a> :: <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n t (<a href="Blarney.html#t:Action" title="Blarney">Action</a> ()) -&gt; t -&gt; <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; <a href="Blarney.html#t:Action" title="Blarney">Action</a> ()</li><li class="src short"><a href="#v:match">match</a> :: <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; [<a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; <a href="Blarney.html#t:Action" title="Blarney">Action</a> ()] -&gt; <a href="Blarney.html#t:Action" title="Blarney">Action</a> ()</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:BP" class="def">BP</a> n t0 t1 = <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; t0 -&gt; (<a href="Blarney.html#t:Bit" title="Blarney">Bit</a> 1, t1) <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/BitPat.hs#L36" class="link">Source</a> <a href="#t:BP" class="selflink">#</a></p><div class="doc"><p>Bit pattern</p></div></div><div class="top"><p class="src"><a id="v:literal" class="def">literal</a> :: <span class="keyword">forall</span> n t. <a href="file:///usr/local/.ghcup/ghc/9.2.1/share/doc/ghc-9.2.1/html/libraries/base-4.16.0.0/GHC-TypeLits.html#t:KnownNat" title="GHC.TypeLits">KnownNat</a> n =&gt; <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n t t <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/BitPat.hs#L39" class="link">Source</a> <a href="#v:literal" class="selflink">#</a></p><div class="doc"><p>Bit pattern to match literal</p></div></div><div class="top"><p class="src"><a id="v:variable" class="def">variable</a> :: <span class="keyword">forall</span> n t. <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n (<a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; t) t <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/BitPat.hs#L43" class="link">Source</a> <a href="#v:variable" class="selflink">#</a></p><div class="doc"><p>Bit pattern to bind a variable</p></div></div><div class="top"><p class="src"><a id="v:-60--35--62-" class="def">(&lt;#&gt;)</a> :: <a href="file:///usr/local/.ghcup/ghc/9.2.1/share/doc/ghc-9.2.1/html/libraries/base-4.16.0.0/GHC-TypeLits.html#t:KnownNat" title="GHC.TypeLits">KnownNat</a> n0 =&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n0 t0 t1 -&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n1 t1 t2 -&gt; <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> (n0 <a href="file:///usr/local/.ghcup/ghc/9.2.1/share/doc/ghc-9.2.1/html/libraries/base-4.16.0.0/GHC-TypeLits.html#t:-43-" title="GHC.TypeLits">+</a> n1) t0 t2 <span class="fixity">infixl 9</span><span class="rightedge"></span> <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/BitPat.hs#L48" class="link">Source</a> <a href="#v:-60--35--62-" class="selflink">#</a></p><div class="doc"><p>Sequentially combine bit patterns</p></div></div><div class="top"><p class="src"><a id="v:-61--61--62-" class="def">(==&gt;)</a> :: <a href="Blarney-BitPat.html#t:BP" title="Blarney.BitPat">BP</a> n t (<a href="Blarney.html#t:Action" title="Blarney">Action</a> ()) -&gt; t -&gt; <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; <a href="Blarney.html#t:Action" title="Blarney">Action</a> () <span class="fixity">infix 7</span><span class="rightedge"></span> <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/BitPat.hs#L54" class="link">Source</a> <a href="#v:-61--61--62-" class="selflink">#</a></p><div class="doc"><p>A case alternative (pattern plus a right-hand-side)</p></div></div><div class="top"><p class="src"><a id="v:match" class="def">match</a> :: <a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; [<a href="Blarney.html#t:Bit" title="Blarney">Bit</a> n -&gt; <a href="Blarney.html#t:Action" title="Blarney">Action</a> ()] -&gt; <a href="Blarney.html#t:Action" title="Blarney">Action</a> () <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/BitPat.hs#L58" class="link">Source</a> <a href="#v:match" class="selflink">#</a></p><div class="doc"><p>Match case subject against set of a case alternatives</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.26.0</p></div></body></html>
32 changes: 32 additions & 0 deletions Blarney-BitScan.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions Blarney-ClientServer.html

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions Blarney-Connectable.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>Blarney.Connectable</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">blarney-0.1.0.0</span><ul class="links" id="page-menu"><li><a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/Connectable.hs">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th valign="top">Copyright</th><td>(c) Alexandre Joannou 2019</td></tr><tr><th>License</th><td>MIT</td></tr><tr><th>Maintainer</th><td>alexandre.joannou@gmail.com</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Safe Haskell</th><td>Safe-Inferred</td></tr><tr><th>Language</th><td>GHC2021</td></tr></table><p class="caption">Blarney.Connectable</p></div><div id="table-of-contents"><div id="contents-list"><p class="caption" onclick="window.scrollTo(0,0)">Contents</p><ul><li><a href="#g:1">Connectable class</a></li></ul></div></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The <code><a href="Blarney-Connectable.html#t:Connectable" title="Blarney.Connectable">Connectable</a></code> class provides a standard way to connect hardware modules</p></div></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">class</span> <a href="#t:Connectable">Connectable</a> a b <span class="keyword">where</span><ul class="subs"><li><a href="#v:makeConnection">makeConnection</a> :: a -&gt; b -&gt; <a href="Blarney.html#t:Module" title="Blarney">Module</a> ()</li></ul></li></ul></details></div><div id="interface"><a href="#g:1" id="g:1"><h1>Connectable class</h1></a><div class="top"><p class="src"><span class="keyword">class</span> <a id="t:Connectable" class="def">Connectable</a> a b <span class="keyword">where</span> <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/Connectable.hs#L23" class="link">Source</a> <a href="#t:Connectable" class="selflink">#</a></p><div class="doc"><p><code><a href="Blarney-Connectable.html#t:Connectable" title="Blarney.Connectable">Connectable</a></code> class</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a id="v:makeConnection" class="def">makeConnection</a> <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/Connectable.hs#L23" class="link">Source</a> <a href="#v:makeConnection" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: a</td><td class="doc"><p>First interface to connect</p></td></tr><tr><td class="src">-&gt; b</td><td class="doc"><p>Second interface to connect</p></td></tr><tr><td class="src">-&gt; <a href="Blarney.html#t:Module" title="Blarney">Module</a> ()</td><td class="doc"><p><code><a href="Blarney.html#t:Module" title="Blarney">Module</a></code> with no interface, implementing the
connection</p></td></tr></table></div><div class="doc"><p>Connects two interfaces that can be connected</p></div></div><div class="subs instances"><h4 class="instances details-toggle-control details-toggle" data-details-id="i:Connectable">Instances</h4><details id="i:Connectable" open="open"><summary class="hide-when-js-enabled">Instances details</summary><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:ic:Connectable:Connectable:1"></span> <a href="Blarney-Connectable.html#t:Connectable" title="Blarney.Connectable">Connectable</a> (<a href="Blarney-SourceSink.html#t:Source" title="Blarney.SourceSink">Source</a> t) (<a href="Blarney-SourceSink.html#t:Sink" title="Blarney.SourceSink">Sink</a> t)</span> <a href="#t:Connectable" class="selflink">#</a></td><td class="doc"><p><code><a href="Blarney-Connectable.html#t:Connectable" title="Blarney.Connectable">Connectable</a></code> instance for <code><a href="Blarney-SourceSink.html#t:Source" title="Blarney.SourceSink">Source</a></code> <code>t</code> and <code><a href="Blarney-SourceSink.html#t:Sink" title="Blarney.SourceSink">Sink</a></code> <code>t</code></p></td></tr><tr><td colspan="2"><details id="i:ic:Connectable:Connectable:1"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="Blarney-SourceSink.html">Blarney.SourceSink</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:makeConnection">makeConnection</a> :: <a href="Blarney-SourceSink.html#t:Source" title="Blarney.SourceSink">Source</a> t -&gt; <a href="Blarney-SourceSink.html#t:Sink" title="Blarney.SourceSink">Sink</a> t -&gt; <a href="Blarney.html#t:Module" title="Blarney">Module</a> () <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/Connectable.hs#L25" class="link">Source</a> <a href="#v:makeConnection" class="selflink">#</a></p></div></details></td></tr><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:ic:Connectable:Connectable:2"></span> <a href="Blarney-Connectable.html#t:Connectable" title="Blarney.Connectable">Connectable</a> (<a href="Blarney-ClientServer.html#t:Client" title="Blarney.ClientServer">Client</a> req_t resp_t) (<a href="Blarney-ClientServer.html#t:Server" title="Blarney.ClientServer">Server</a> req_t resp_t)</span> <a href="#t:Connectable" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:ic:Connectable:Connectable:2"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="Blarney-ClientServer.html">Blarney.ClientServer</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:makeConnection">makeConnection</a> :: <a href="Blarney-ClientServer.html#t:Client" title="Blarney.ClientServer">Client</a> req_t resp_t -&gt; <a href="Blarney-ClientServer.html#t:Server" title="Blarney.ClientServer">Server</a> req_t resp_t -&gt; <a href="Blarney.html#t:Module" title="Blarney">Module</a> () <a href="https://github.com/blarney-lang/blarney/tree/853b61c60bc7e1c0239e9699a53537264375926e/Haskell/Blarney/Connectable.hs#L25" class="link">Source</a> <a href="#v:makeConnection" class="selflink">#</a></p></div></details></td></tr></table></details></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.26.0</p></div></body></html>
Loading

0 comments on commit f766f8e

Please sign in to comment.