Skip to content

Commit

Permalink
all the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
awalterschulze committed Apr 4, 2018
1 parent 467921c commit fcf7b74
Show file tree
Hide file tree
Showing 24 changed files with 806 additions and 502 deletions.
9 changes: 8 additions & 1 deletion docs/Exprs-Compare.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Exprs-Contains.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!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" /><title>Exprs.Contains</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Exprs.Contains.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">katydid-0.3.0.0: A haskell implementation of Katydid</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Exprs.Contains</p></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:mkContainsExpr" class="def">mkContainsExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a> <a href="src/Exprs.Contains.html#mkContainsExpr" class="link">Source</a> <a href="#v:mkContainsExpr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:containsStringExpr" class="def">containsStringExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/Exprs.Contains.html#containsStringExpr" class="link">Source</a> <a href="#v:containsStringExpr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:containsExpr" class="def">containsExpr</a> :: <a href="../base-4.10.0.0/Data-Eq.html#t:Eq">Eq</a> a =&gt; <a href="Expr.html#t:Expr">Expr</a> a -&gt; <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/Exprs.Contains.html#containsExpr" class="link">Source</a> <a href="#v:containsExpr" class="selflink">#</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Exprs.Contains.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">katydid-0.3.0.0: A haskell implementation of Katydid</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Exprs.Contains</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module contains the Relapse contains expressions.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:mkContainsExpr">mkContainsExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a></li><li class="src short"><a href="#v:containsStringExpr">containsStringExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:containsExpr">containsExpr</a> :: <a href="../base-4.10.0.0/Data-Eq.html#t:Eq">Eq</a> a =&gt; <a href="Expr.html#t:Expr">Expr</a> a -&gt; <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:mkContainsExpr" class="def">mkContainsExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a> <a href="src/Exprs.Contains.html#mkContainsExpr" class="link">Source</a> <a href="#v:mkContainsExpr" class="selflink">#</a></p><div class="doc"><p>mkContainsExpr dynamically creates a contains expression, if the two input types are:</p><ul><li>String and String where the second string is the possible substring.</li><li>A List of :Strings, Ints or Uints paired with a String, Int or Uint respectively.</li></ul></div></div><div class="top"><p class="src"><a id="v:containsStringExpr" class="def">containsStringExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/Exprs.Contains.html#containsStringExpr" class="link">Source</a> <a href="#v:containsStringExpr" class="selflink">#</a></p><div class="doc"><p>containsStringExpr creates a contains expression that returns true if the second string is a substring of the first.</p></div></div><div class="top"><p class="src"><a id="v:containsExpr" class="def">containsExpr</a> :: <a href="../base-4.10.0.0/Data-Eq.html#t:Eq">Eq</a> a =&gt; <a href="Expr.html#t:Expr">Expr</a> a -&gt; <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Bool.html#t:Bool">Bool</a> <a href="src/Exprs.Contains.html#containsExpr" class="link">Source</a> <a href="#v:containsExpr" class="selflink">#</a></p><div class="doc"><p>containsExpr creates a contains expression that returns true if the first argument is an element in the second list argument.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html>
4 changes: 3 additions & 1 deletion docs/Exprs-Elem.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<!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" /><title>Exprs.Elem</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Exprs.Elem.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">katydid-0.3.0.0: A haskell implementation of Katydid</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Exprs.Elem</p></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:mkElemExpr" class="def">mkElemExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a> <a href="src/Exprs.Elem.html#mkElemExpr" class="link">Source</a> <a href="#v:mkElemExpr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:elemExpr" class="def">elemExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> a <a href="src/Exprs.Elem.html#elemExpr" class="link">Source</a> <a href="#v:elemExpr" class="selflink">#</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Exprs.Elem.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">katydid-0.3.0.0: A haskell implementation of Katydid</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Exprs.Elem</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module contains the Relapse elem expression.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:mkElemExpr">mkElemExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a></li><li class="src short"><a href="#v:elemExpr">elemExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> a</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:mkElemExpr" class="def">mkElemExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a> <a href="src/Exprs.Elem.html#mkElemExpr" class="link">Source</a> <a href="#v:mkElemExpr" class="selflink">#</a></p><div class="doc"><p>mkElemExpr dynamically creates an elem expression, if the first argument is a list and the second an int index.</p></div></div><div class="top"><p class="src"><a id="v:elemExpr" class="def">elemExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> a <a href="src/Exprs.Elem.html#elemExpr" class="link">Source</a> <a href="#v:elemExpr" class="selflink">#</a></p><div class="doc"><p>elemExpr creates an expression that returns an element from the list at the specified index.
Trimming this function would cause it to become non generic.
It is not necessary to trim each function, since it is just an optimization.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html>
2 changes: 1 addition & 1 deletion docs/Exprs-Length.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!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" /><title>Exprs.Length</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Exprs.Length.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">katydid-0.3.0.0: A haskell implementation of Katydid</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Exprs.Length</p></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:mkLengthExpr" class="def">mkLengthExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a> <a href="src/Exprs.Length.html#mkLengthExpr" class="link">Source</a> <a href="#v:mkLengthExpr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:lengthListExpr" class="def">lengthListExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Exprs.Length.html#lengthListExpr" class="link">Source</a> <a href="#v:lengthListExpr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:lengthStringExpr" class="def">lengthStringExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Exprs.Length.html#lengthStringExpr" class="link">Source</a> <a href="#v:lengthStringExpr" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:lengthBytesExpr" class="def">lengthBytesExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Exprs.Length.html#lengthBytesExpr" class="link">Source</a> <a href="#v:lengthBytesExpr" class="selflink">#</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Exprs.Length.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">katydid-0.3.0.0: A haskell implementation of Katydid</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Exprs.Length</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module contains the Relapse length expressions.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:mkLengthExpr">mkLengthExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a></li><li class="src short"><a href="#v:lengthListExpr">lengthListExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:lengthStringExpr">lengthStringExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:lengthBytesExpr">lengthBytesExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:mkLengthExpr" class="def">mkLengthExpr</a> :: [<a href="Expr.html#t:AnyExpr">AnyExpr</a>] -&gt; <a href="../mtl-2.2.1/Control-Monad-Except.html#t:Except">Except</a> <a href="../base-4.10.0.0/Data-String.html#t:String">String</a> <a href="Expr.html#t:AnyExpr">AnyExpr</a> <a href="src/Exprs.Length.html#mkLengthExpr" class="link">Source</a> <a href="#v:mkLengthExpr" class="selflink">#</a></p><div class="doc"><p>mkLengthExpr dynamically creates a length expression, if the single argument is a list, string or bytes.</p></div></div><div class="top"><p class="src"><a id="v:lengthListExpr" class="def">lengthListExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> [a] -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Exprs.Length.html#lengthListExpr" class="link">Source</a> <a href="#v:lengthListExpr" class="selflink">#</a></p><div class="doc"><p>lengthListExpr creates a length expression, that returns the length of a list.</p></div></div><div class="top"><p class="src"><a id="v:lengthStringExpr" class="def">lengthStringExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../text-1.2.2.2/Data-Text.html#t:Text">Text</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Exprs.Length.html#lengthStringExpr" class="link">Source</a> <a href="#v:lengthStringExpr" class="selflink">#</a></p><div class="doc"><p>lengthStringExpr creates a length expression, that returns the length of a string.</p></div></div><div class="top"><p class="src"><a id="v:lengthBytesExpr" class="def">lengthBytesExpr</a> :: <a href="Expr.html#t:Expr">Expr</a> <a href="../bytestring-0.10.8.2/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; <a href="Expr.html#t:Expr">Expr</a> <a href="../base-4.10.0.0/Data-Int.html#t:Int">Int</a> <a href="src/Exprs.Length.html#lengthBytesExpr" class="link">Source</a> <a href="#v:lengthBytesExpr" class="selflink">#</a></p><div class="doc"><p>lengthBytesExpr creates a length expression, that returns the length of bytes.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.18.1</p></div></body></html>
Loading

0 comments on commit fcf7b74

Please sign in to comment.