Skip to content

Commit

Permalink
Update generated documentation for version 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Joott committed Mar 5, 2019
1 parent 6f04a0d commit 19529ed
Show file tree
Hide file tree
Showing 18 changed files with 2,050 additions and 0 deletions.
126 changes: 126 additions & 0 deletions Decoding.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Decoding</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content="F# port of the MSNumpress library."/>
<meta name="author" content="Jonathan Ott"/>

<script src="https://code.jquery.com/jquery-1.8.0.js"></script>
<script src="https://code.jquery.com/ui/1.8.23/jquery-ui.js"></script>
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet"/>
<meta http-equiv="X-UA-Compatible" content="IE=11" >
<script src="https://cdn.plot.ly/plotly-latest.min.js"></script>
<link type="text/css" rel="stylesheet" href="/MSNumpressFSharp/content/style.css" /> <!--/MSNumpressFSharp-->
<link type="text/css" rel="stylesheet" href="/MSNumpressFSharp/style/CSBstyles.css" /> <!--/MSNumpressFSharp-->
<script type="text/javascript" src="/MSNumpressFSharp/content/tips.js"></script> <!--/MSNumpressFSharp-->
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li><a href="http://fsharp.org">fsharp.org</a></li>
<li><a href="https://github.com/Joott/MSNumpressFSharp">github page</a></li>
</ul>
<h3 class="muted"><a href="/MSNumpressFSharp/index.html">MSNumpressFSharp</a></h3>
</div>
<hr />
<div class="row">
<div class="span9" id="main">

<h2><a name="Important-First-read-the-documentation-for-Encoding-The-output-of-the-encoding-function-is-used-in-the-decoding-function" class="anchor" href="#Important-First-read-the-documentation-for-Encoding-The-output-of-the-encoding-function-is-used-in-the-decoding-function">Important! First read the documentation for Encoding. The output of the encoding function is used in the decoding function.</a></h2>
<h3><a name="Numpress-Pic" class="anchor" href="#Numpress-Pic">Numpress Pic</a></h3>
<p>The decodePic function takes the byteArrayPic with the encoded bytes, the output of encodePic, which is
the number of encoded bytes and an empty float array with at least as many items as the original array.
The function modifies the float array and returns the number of decoded floats.</p>
<table class="pre"><tr><td class="lines"><pre class="fssnip"><span class="l">1: </span>
<span class="l">2: </span>
<span class="l">3: </span>
</pre></td>
<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs2', 2)" onmouseover="showTip(event, 'fs2', 2)" class="id">decodedDataPic</span><span class="pn">:</span> <span onmouseout="hideTip(event, 'fs3', 3)" onmouseover="showTip(event, 'fs3', 3)" class="vt">float</span><span class="pn">[</span><span class="pn">]</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs4', 4)" onmouseover="showTip(event, 'fs4', 4)" class="m">Array</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs5', 5)" onmouseover="showTip(event, 'fs5', 5)" class="id">zeroCreate</span> <span class="n">100</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs6', 6)" onmouseover="showTip(event, 'fs6', 6)" class="id">decodePic</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs1', 7)" onmouseover="showTip(event, 'fs1', 7)" class="fn">MSNumpressFSharp</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs7', 8)" onmouseover="showTip(event, 'fs7', 8)" class="m">Decode</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs8', 9)" onmouseover="showTip(event, 'fs8', 9)" class="id">decodePic</span> <span class="pn">(</span><span class="id">byteArrayPic</span><span class="pn">,</span> <span class="id">encodePic</span><span class="pn">,</span> <span onmouseout="hideTip(event, 'fs2', 10)" onmouseover="showTip(event, 'fs2', 10)" class="id">decodedDataPic</span><span class="pn">)</span>
</code></pre></td>
</tr>
</table>
<p>decodedDataPic now contains the decoded floats.</p>
<h3><a name="NumpressLin" class="anchor" href="#NumpressLin">NumpressLin</a></h3>
<p>The decodeLinear function takes the byteArrayLin with the encoded bytes, the output of encodeLin, which is
the number of encoded bytes and an empty float array with at least as many items as the original array.
The function modifies the float array and returns the number of decoded floats.</p>
<table class="pre"><tr><td class="lines"><pre class="fssnip"><span class="l">1: </span>
<span class="l">2: </span>
<span class="l">3: </span>
</pre></td>
<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs9', 11)" onmouseover="showTip(event, 'fs9', 11)" class="id">decodedDataLin</span><span class="pn">:</span> <span onmouseout="hideTip(event, 'fs3', 12)" onmouseover="showTip(event, 'fs3', 12)" class="vt">float</span><span class="pn">[</span><span class="pn">]</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs4', 13)" onmouseover="showTip(event, 'fs4', 13)" class="m">Array</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs5', 14)" onmouseover="showTip(event, 'fs5', 14)" class="id">zeroCreate</span> <span class="n">100</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs10', 15)" onmouseover="showTip(event, 'fs10', 15)" class="id">decodeLin</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs1', 16)" onmouseover="showTip(event, 'fs1', 16)" class="fn">MSNumpressFSharp</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs7', 17)" onmouseover="showTip(event, 'fs7', 17)" class="m">Decode</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs11', 18)" onmouseover="showTip(event, 'fs11', 18)" class="id">decodeLinear</span> <span class="pn">(</span><span class="id">byteArrayLin</span><span class="pn">,</span> <span class="id">encodeLin</span><span class="pn">,</span> <span onmouseout="hideTip(event, 'fs9', 19)" onmouseover="showTip(event, 'fs9', 19)" class="id">decodedDataLin</span><span class="pn">)</span>
</code></pre></td>
</tr>
</table>
<p>decodedDataLin now contains the decoded floats.</p>
<h3><a name="NumpressSlof" class="anchor" href="#NumpressSlof">NumpressSlof</a></h3>
<p>The decodeSlof function takes the byteArraySlof with the encoded bytes, the output of encodeLin, which is
the number of encoded bytes and an empty float array with at least as many items as the original array.
The function modifies the float array and returns the number of decoded floats.</p>
<table class="pre"><tr><td class="lines"><pre class="fssnip"><span class="l">1: </span>
<span class="l">2: </span>
<span class="l">3: </span>
</pre></td>
<td class="snippet"><pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs12', 20)" onmouseover="showTip(event, 'fs12', 20)" class="id">decodedDataSlof</span><span class="pn">:</span> <span onmouseout="hideTip(event, 'fs3', 21)" onmouseover="showTip(event, 'fs3', 21)" class="vt">float</span><span class="pn">[</span><span class="pn">]</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs4', 22)" onmouseover="showTip(event, 'fs4', 22)" class="m">Array</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs5', 23)" onmouseover="showTip(event, 'fs5', 23)" class="id">zeroCreate</span> <span class="n">100</span>

<span class="k">let</span> <span onmouseout="hideTip(event, 'fs10', 24)" onmouseover="showTip(event, 'fs10', 24)" class="id">decodeLin</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs1', 25)" onmouseover="showTip(event, 'fs1', 25)" class="fn">MSNumpressFSharp</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs7', 26)" onmouseover="showTip(event, 'fs7', 26)" class="m">Decode</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs11', 27)" onmouseover="showTip(event, 'fs11', 27)" class="id">decodeLinear</span> <span class="pn">(</span><span class="id">byteArraySlof</span><span class="pn">,</span> <span class="id">encodeSlof</span><span class="pn">,</span> <span onmouseout="hideTip(event, 'fs12', 28)" onmouseover="showTip(event, 'fs12', 28)" class="id">decodedDataSlof</span><span class="pn">)</span>
</code></pre></td>
</tr>
</table>
<p>decodedDataSlof now contains the decoded floats.</p>

<div class="tip" id="fs1">namespace MSNumpressFSharp</div>
<div class="tip" id="fs2">val decodedDataPic : float []</div>
<div class="tip" id="fs3">Multiple items<br />val float : value:&#39;T -&gt; float (requires member op_Explicit)<br /><br />--------------------<br />type float = System.Double<br /><br />--------------------<br />type float&lt;&#39;Measure&gt; = float</div>
<div class="tip" id="fs4">module Array<br /><br />from Microsoft.FSharp.Collections</div>
<div class="tip" id="fs5">val zeroCreate : count:int -&gt; &#39;T []</div>
<div class="tip" id="fs6">val decodePic : int</div>
<div class="tip" id="fs7">module Decode<br /><br />from MSNumpressFSharp</div>
<div class="tip" id="fs8">val decodePic : data:byte [] * dataSize:int * result:double [] -&gt; int</div>
<div class="tip" id="fs9">val decodedDataLin : float []</div>
<div class="tip" id="fs10">val decodeLin : int</div>
<div class="tip" id="fs11">val decodeLinear : data:byte [] * dataSize:int * result:double [] -&gt; int</div>
<div class="tip" id="fs12">val decodedDataSlof : float []</div>

</div>
<div class="span3">
<img src="/MSNumpressFSharp/img/logo.png" alt="F# Project" style="width:150px;margin:10px" />
<ul class="nav nav-list" id="menu" style="margin-top: 20px;">
<li class="nav-header">MSNumpressFSharp</li>
<li><a href="/MSNumpressFSharp/index.html">Home page</a></li>
<li class="divider"></li>
<li><a href="http://nuget.org/packages/MSNumpressFSharp">Get Library via NuGet</a></li>
<li><a href="https://github.com/Joott/MSNumpressFSharp">Source Code on GitHub</a></li>
<li><a href="/MSNumpressFSharp/license.html">License</a></li>
<li><a href="/MSNumpressFSharp/release-notes.html">Release Notes</a></li>

<li class="nav-header">Getting started</li>
<li><a href="/MSNumpressFSharp/tutorial.html">Sample tutorial</a></li>

<li class="nav-header">Documentation</li>
<li><a href="/MSNumpressFSharp/reference/index.html">API Reference</a></li>

<li class="nav-header">Encoding</li>
<li><a href="/MSNumpressFSharp/reference/index.html">API Reference</a></li>

<li class="nav-header">Decoding</li>
<li><a href="/MSNumpressFSharp/reference/index.html">API Reference</a></li>
</ul>
</div>
</div>
</div>
<a href="https://github.com/Joott/MSNumpressFSharp"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"/></a>
</body>
</html>
Loading

0 comments on commit 19529ed

Please sign in to comment.