Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable GH pages #103

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Enable GH pages #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fef74a6
Add compiled Haddocks
uhbif19 Jun 9, 2024
52983ad
Remove `haddock` from `.gitignore`
uhbif19 Jun 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ cabal.project.local~
.HTF/
.ghc.environment.*
.vscode
haddocks
.direnv/
# Functions changed by runing local testnet
devnet/db
Expand Down
52 changes: 52 additions & 0 deletions docs/haddocks/array/Data-Array-IArray.html
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/haddocks/array/Data-Array-IO-Safe.html
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/haddocks/array/Data-Array-IO.html
View file
Open in desktop

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions docs/haddocks/array/Data-Array-MArray-Safe.html
View file
Open in desktop

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions docs/haddocks/array/Data-Array-MArray.html
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions docs/haddocks/array/Data-Array-ST-Safe.html
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions docs/haddocks/array/Data-Array-ST.html
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions docs/haddocks/array/Data-Array-Storable-Safe.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!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>Data.Array.Storable.Safe</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">array-0.5.5.0: Mutable and immutable arrays</span><ul class="links" id="page-menu"><li id="quick-jump-button"><a href="#">Quick Jump</a></li><li><a href="src/Data.Array.Storable.Safe.html">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) The University of Glasgow 2001</td></tr><tr><th>License</th><td>BSD-style (see the file libraries/base/LICENSE)</td></tr><tr><th>Maintainer</th><td>[email protected]</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>non-portable (uses Data.Array.MArray)</td></tr><tr><th>Safe Haskell</th><td>Trustworthy</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Data.Array.Storable.Safe</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">Arrays of <code>Storable</code> things.</a></li><li><a href="#g:2">Overloaded mutable array interface</a></li><li><a href="#g:3">Accessing the pointer to the array contents</a></li></ul></div></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A storable array is an IO-mutable array which stores its
contents in a contiguous memory block living in the C
heap. Elements are stored according to the class <code>Storable</code>.
You can obtain the pointer to the array contents to manipulate
elements from languages like C.</p><p>It is similar to <code><a href="Data-Array-IO.html#v:IOUArray" title="Data.Array.IO">IOUArray</a></code> but slower.
Its advantage is that it's compatible with C.</p><p>Safe API only of <a href="Data-Array-Storable.html">Data.Array.Storable</a>.</p><p><em>Since: array-0.4.0.0</em></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">data</span> <a href="#t:StorableArray">StorableArray</a> i e</li><li class="src short">module <a href="Data-Array-MArray-Safe.html">Data.Array.MArray.Safe</a></li><li class="src short"><a href="#v:withStorableArray">withStorableArray</a> :: <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; (<a href="../base-4.18.1.0/Foreign-Ptr.html#t:Ptr" title="Foreign.Ptr">Ptr</a> e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> a) -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> a</li><li class="src short"><a href="#v:touchStorableArray">touchStorableArray</a> :: <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> ()</li></ul></details></div><div id="interface"><a href="#g:1" id="g:1"><h1>Arrays of <code>Storable</code> things.</h1></a><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:StorableArray" class="def">StorableArray</a> i e <a href="src/Data.Array.Storable.Internals.html#StorableArray" class="link">Source</a> <a href="#t:StorableArray" class="selflink">#</a></p><div class="doc"><p>The array type</p></div><div class="subs instances"><h4 class="instances details-toggle-control details-toggle" data-details-id="i:StorableArray">Instances</h4><details id="i:StorableArray" 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:id:StorableArray:MArray:1"></span> <a href="../base-4.18.1.0/Foreign-Storable.html#t:Storable" title="Foreign.Storable">Storable</a> e =&gt; <a href="Data-Array-MArray.html#t:MArray" title="Data.Array.MArray">MArray</a> <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> e <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a></span> <a href="src/Data.Array.Storable.Internals.html#line-34" class="link">Source</a> <a href="#t:StorableArray" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:StorableArray:MArray:1"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="Data-Array-Storable-Internals.html">Data.Array.Storable.Internals</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:getBounds">getBounds</a> :: <a href="../base-4.18.1.0/Data-Ix.html#t:Ix" title="Data.Ix">Ix</a> i =&gt; <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> (i, i) <a href="src/Data.Array.Base.html#getBounds" class="link">Source</a> <a href="#v:getBounds" class="selflink">#</a></p><p class="src"><a href="#v:getNumElements">getNumElements</a> :: <a href="../base-4.18.1.0/Data-Ix.html#t:Ix" title="Data.Ix">Ix</a> i =&gt; <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="../base-4.18.1.0/Data-Int.html#t:Int" title="Data.Int">Int</a></p><p class="src"><a href="#v:newArray">newArray</a> :: <a href="../base-4.18.1.0/Data-Ix.html#t:Ix" title="Data.Ix">Ix</a> i =&gt; (i, i) -&gt; e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> (<a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e) <a href="src/Data.Array.Base.html#newArray" class="link">Source</a> <a href="#v:newArray" class="selflink">#</a></p><p class="src"><a href="#v:newArray_">newArray_</a> :: <a href="../base-4.18.1.0/Data-Ix.html#t:Ix" title="Data.Ix">Ix</a> i =&gt; (i, i) -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> (<a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e) <a href="src/Data.Array.Base.html#newArray_" class="link">Source</a> <a href="#v:newArray_" class="selflink">#</a></p><p class="src"><a href="#v:unsafeNewArray_">unsafeNewArray_</a> :: <a href="../base-4.18.1.0/Data-Ix.html#t:Ix" title="Data.Ix">Ix</a> i =&gt; (i, i) -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> (<a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e)</p><p class="src"><a href="#v:unsafeRead">unsafeRead</a> :: <a href="../base-4.18.1.0/Data-Ix.html#t:Ix" title="Data.Ix">Ix</a> i =&gt; <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; <a href="../base-4.18.1.0/Data-Int.html#t:Int" title="Data.Int">Int</a> -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> e</p><p class="src"><a href="#v:unsafeWrite">unsafeWrite</a> :: <a href="../base-4.18.1.0/Data-Ix.html#t:Ix" title="Data.Ix">Ix</a> i =&gt; <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; <a href="../base-4.18.1.0/Data-Int.html#t:Int" title="Data.Int">Int</a> -&gt; e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> ()</p></div></details></td></tr></table></details></div></div><a href="#g:2" id="g:2"><h1>Overloaded mutable array interface</h1></a><div class="doc"><p>Module <a href="Data-Array-MArray.html">Data.Array.MArray</a> provides the interface of storable arrays.
They are instances of class <code><a href="Data-Array-MArray.html#t:MArray" title="Data.Array.MArray">MArray</a></code> (with the <code><a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a></code> monad).</p></div><div class="top"><p class="src">module <a href="Data-Array-MArray-Safe.html">Data.Array.MArray.Safe</a></p></div><a href="#g:3" id="g:3"><h1>Accessing the pointer to the array contents</h1></a><div class="top"><p class="src"><a id="v:withStorableArray" class="def">withStorableArray</a> :: <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; (<a href="../base-4.18.1.0/Foreign-Ptr.html#t:Ptr" title="Foreign.Ptr">Ptr</a> e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> a) -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> a <a href="src/Data.Array.Storable.Internals.html#withStorableArray" class="link">Source</a> <a href="#v:withStorableArray" class="selflink">#</a></p><div class="doc"><p>The pointer to the array contents is obtained by <code><a href="Data-Array-Storable-Safe.html#v:withStorableArray" title="Data.Array.Storable.Safe">withStorableArray</a></code>.
The idea is similar to <code><a href="../base-4.18.1.0/Foreign-ForeignPtr-Safe.html#t:ForeignPtr" title="Foreign.ForeignPtr.Safe">ForeignPtr</a></code> (used internally here).
The pointer should be used only during execution of the <code><a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a></code> action
retured by the function passed as argument to <code><a href="Data-Array-Storable-Safe.html#v:withStorableArray" title="Data.Array.Storable.Safe">withStorableArray</a></code>.</p></div></div><div class="top"><p class="src"><a id="v:touchStorableArray" class="def">touchStorableArray</a> :: <a href="Data-Array-Storable-Safe.html#t:StorableArray" title="Data.Array.Storable.Safe">StorableArray</a> i e -&gt; <a href="../base-4.18.1.0/System-IO.html#t:IO" title="System.IO">IO</a> () <a href="src/Data.Array.Storable.Internals.html#touchStorableArray" class="link">Source</a> <a href="#v:touchStorableArray" class="selflink">#</a></p><div class="doc"><p>If you want to use it afterwards, ensure that you
<code><a href="Data-Array-Storable-Safe.html#v:touchStorableArray" title="Data.Array.Storable.Safe">touchStorableArray</a></code> after the last use of the pointer,
so the array is not freed too early.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.29.1</p></div></body></html>
Loading
Loading