<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1><img style='margin:auto' alt='MAOOAM' src='https://raw.githubusercontent.com/Climdyn/MAOOAM/master/fortran/doc/MAOOAM_small.png' /></h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Local_Functions">Local Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/maooam.html">maooam</a></li>
  <li><a href="../modules/tl_ad_tensor.html">tl_ad_tensor</a></li>
  <li><a href="../modules/params.html">params</a></li>
  <li><a href="../modules/modeselection.html">modeselection</a></li>
  <li><a href="../modules/aotensor.html">aotensor</a></li>
  <li><a href="../modules/inprod_analytic.html">inprod_analytic</a></li>
  <li><a href="../modules/write_IC.html">write_IC</a></li>
  <li><a href="../modules/restore.html">restore</a></li>
  <li><a href="../modules/array.html">array</a></li>
  <li><a href="../modules/tensor.html">tensor</a></li>
  <li><a href="../modules/rk2.html">rk2</a></li>
  <li><a href="../modules/rk4.html">rk4</a></li>
  <li><a href="../modules/rk4_tl_ad.html">rk4_tl_ad</a></li>
  <li><a href="../modules/stat.html">stat</a></li>
  <li><a href="../modules/rand.html">rand</a></li>
  <li><strong>gz</strong></li>
</ul>
<h2>Topics</h2>
<ul class="">
  <li><a href="../topics/README.md.html">README</a></li>
  <li><a href="../topics/TL_AD.md.html">TL_AD</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>gz</code></h1>
<p>gz.lua is a very basic ffi binding to the functions gzopen, gzwrite and
 gzclose of zlib.</p>
<p>

</p>


<h2><a href="#Local_Functions">Local Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#gzopen">gzopen (fname, mode)</a></td>
	<td class="summary">Wrapper around gzopen</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#gzwrite">gzwrite (gzf, str)</a></td>
	<td class="summary">Wrapper around gzwrite</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#gzclose">gzclose (gzf)</a></td>
	<td class="summary">Wrapper around gzclose.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Local_Functions"></a>Local Functions</h2>

    <dl class="function">
    <dt>
    <a name = "gzopen"></a>
    <strong>gzopen (fname, mode)</strong>
    </dt>
    <dd>
    Wrapper around gzopen


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">fname</span>
         string containing filename
        </li>
        <li><span class="parameter">mode</span>
         string defining the open mode (read: "r", write: "w", binary:
 "b") Default: "wb"
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        a gzf object with write and close methods.
    </ol>




</dd>
    <dt>
    <a name = "gzwrite"></a>
    <strong>gzwrite (gzf, str)</strong>
    </dt>
    <dd>
    Wrapper around gzwrite


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">gzf</span>
         a gzf object (the result of gzopen)
        </li>
        <li><span class="parameter">str</span>
         a string to compress and write to gzf
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        the number of processed bytes (useful for assertions)
    </ol>




</dd>
    <dt>
    <a name = "gzclose"></a>
    <strong>gzclose (gzf)</strong>
    </dt>
    <dd>
    Wrapper around gzclose.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">gzf</span>
         a gzf object (the result of gzopen)
        </li>
    </ul>





</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
<i style="float:right;">Last updated 2017-01-05 15:53:41 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
