add doc for nerv.Network; remove the generated HTML doc

author: Determinant <ted.sybil@gmail.com> 2016-04-19 16:03:58 +0800
committer: Determinant <ted.sybil@gmail.com> 2016-04-19 16:03:58 +0800
commit: bfe8469abcab65a8bed43e549e42e5d3a5cfec14 (patch)
tree: 36ccb02087aeff02370108c0408e19052e544ede /nerv/doc/lua/modules
parent: 8f6eb50628cadbd0e831d72c4528400b94431ee6 (diff)
3 files changed, 0 insertions, 982 deletions
diff --git a/nerv/doc/lua/modules/layer.affine.html b/nerv/doc/lua/modules/layer.affine.html
deleted file mode 100644
index 817fc37..0000000
--- a/nerv/doc/lua/modules/layer.affine.html
+++ /dev/null
@@ -1,145 +0,0 @@
-<!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>NERV documentation</title>
-    <link rel="stylesheet" href="../ldoc_pale.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>NERV</h1>
-
-<ul>
-  <li><a href="../index.html">Index</a></li>
-</ul>
-
-<h2>Contents</h2>
-<ul>
-<li><a href="#Class_nerv_MatrixParam">Class nerv.MatrixParam </a></li>
-<li><a href="#Class_nerv_AffineLayer">Class nerv.AffineLayer </a></li>
-</ul>
-
-
-<h2>Modules</h2>
-<ul class="$(kind=='Topics' and '' or 'nowrap'">
-  <li><a href="../modules/nerv.html">nerv</a></li>
-  <li><strong>layer.affine</strong></li>
-  <li><a href="../modules/matrix.html">matrix</a></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>layer.affine</code></h1>
-<p>Parameter and layer classes related to linear transform.</p>
-<p></p>
-
-
-<h2><a href="#Class_nerv_MatrixParam">Class nerv.MatrixParam </a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#MatrixParam:read">MatrixParam:read (handle)</a></td>
-	<td class="summary">Read from a file handle.</td>
-	</tr>
-</table>
-<h2><a href="#Class_nerv_AffineLayer">Class nerv.AffineLayer </a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#AffineLayer:__init">AffineLayer:__init (id, global_conf, layer_conf)</a></td>
-	<td class="summary">The constructor.</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header has-description"><a name="Class_nerv_MatrixParam"></a>Class nerv.MatrixParam </h2>
-
-          <div class="section-description">
-          A parameter that consists of a single matrix
-          </div>
-    <dl class="function">
-    <dt>
-    <a name = "MatrixParam:read"></a>
-    <strong>MatrixParam:read (handle)</strong>
-    </dt>
-    <dd>
-    Read from a file handle.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">handle</span>
-         the file handle
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header has-description"><a name="Class_nerv_AffineLayer"></a>Class nerv.AffineLayer </h2>
-
-          <div class="section-description">
-          A fully-connected linear transform layer.
-          </div>
-    <dl class="function">
-    <dt>
-    <a name = "AffineLayer:__init"></a>
-    <strong>AffineLayer:__init (id, global_conf, layer_conf)</strong>
-    </dt>
-    <dd>
-    The constructor.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">id</span>
-
-        </li>
-        <li><span class="parameter">global_conf</span>
-
-        </li>
-        <li><span class="parameter">layer_conf</span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-
-
-</div> <!-- id="content" -->
-</div> <!-- id="main" -->
-<div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
-<i style="float:right;">Last updated 2016-01-15 14:56:30 </i>
-</div> <!-- id="about" -->
-</div> <!-- id="container" -->
-</body>
-</html>
diff --git a/nerv/doc/lua/modules/matrix.html b/nerv/doc/lua/modules/matrix.html
deleted file mode 100644
index 2840e59..0000000
--- a/nerv/doc/lua/modules/matrix.html
+++ /dev/null
@@ -1,409 +0,0 @@
-<!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>NERV documentation</title>
-    <link rel="stylesheet" href="../ldoc_pale.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>NERV</h1>
-
-<ul>
-  <li><a href="../index.html">Index</a></li>
-</ul>
-
-<h2>Contents</h2>
-<ul>
-<li><a href="#Class_nerv_Matrix">Class nerv.Matrix </a></li>
-<li><a href="#Class_nerv_CuMatrixFloat">Class nerv.CuMatrixFloat </a></li>
-<li><a href="#Class_nerv_CuMatrixDouble">Class nerv.CuMatrixDouble </a></li>
-<li><a href="#Class_nerv_MMatrix">Class nerv.MMatrix </a></li>
-</ul>
-
-
-<h2>Modules</h2>
-<ul class="$(kind=='Topics' and '' or 'nowrap'">
-  <li><a href="../modules/nerv.html">nerv</a></li>
-  <li><a href="../modules/layer.affine.html">layer.affine</a></li>
-  <li><strong>matrix</strong></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>matrix</code></h1>
-<p>Implements a fraction of matrix operations (methods) in Lua, while
- others are implemented in C extension.</p>
-<p></p>
-    <h3>Info:</h3>
-    <ul>
-        <li><strong>Author</strong>: Ted Yin <ted.sybil@gmail.com></li>
-    </ul>
-
-
-<h2><a href="#Class_nerv_Matrix">Class nerv.Matrix </a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#nerv.Matrix:__tostring__">nerv.Matrix:__tostring__ ()</a></td>
-	<td class="summary">Convert the matrix object to a string.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.Matrix:generate">nerv.Matrix:generate (gen)</a></td>
-	<td class="summary">Assign each element in a matrix using the value returned by a callback <code>gen</code>.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.Matrix:create">nerv.Matrix:create (nrow, ncol)</a></td>
-	<td class="summary">Create a fresh new matrix of the same matrix type (as <code>self</code>).</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.Matrix:__add__">nerv.Matrix:__add__ (b)</a></td>
-	<td class="summary">Operator overloading of <code>+</code>.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.Matrix:__sub__">nerv.Matrix:__sub__ (b)</a></td>
-	<td class="summary">Operator overloading of <code>-</code>.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.Matrix:__mul__">nerv.Matrix:__mul__ (b)</a></td>
-	<td class="summary">Operator overloading of <code>*</code>.</td>
-	</tr>
-</table>
-<h2><a href="#Class_nerv_CuMatrixFloat">Class nerv.CuMatrixFloat </a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#nerv.CuMatrixFloat.new_from_host">nerv.CuMatrixFloat.new_from_host (mat)</a></td>
-	<td class="summary">Create a CUDA matrix copy of the host matrix (in memory)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.CuMatrixFloat:new_to_host">nerv.CuMatrixFloat:new_to_host ()</a></td>
-	<td class="summary">Create a host matrix copy of the CUDA matrix</td>
-	</tr>
-</table>
-<h2><a href="#Class_nerv_CuMatrixDouble">Class nerv.CuMatrixDouble </a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#nerv.CuMatrixDouble.new_from_host">nerv.CuMatrixDouble.new_from_host (mat)</a></td>
-	<td class="summary">Create a CUDA matrix copy of the host matrix (in memory)</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.CuMatrixDouble:new_to_host">nerv.CuMatrixDouble:new_to_host ()</a></td>
-	<td class="summary">Create a host matrix copy of the CUDA matrix</td>
-	</tr>
-</table>
-<h2><a href="#Class_nerv_MMatrix">Class nerv.MMatrix </a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#nerv.MMatrix:copy_toh">nerv.MMatrix:copy_toh (b, ...)</a></td>
-	<td class="summary">A wrapper function for <code>copy_fromh</code></td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.MMatrix.print_profile">nerv.MMatrix.print_profile ()</a></td>
-	<td class="summary">Print profiling info of host matrices</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#nerv.MMatrix.clear_profile">nerv.MMatrix.clear_profile ()</a></td>
-	<td class="summary">Clear profiling info of host matrices</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header has-description"><a name="Class_nerv_Matrix"></a>Class nerv.Matrix </h2>
-
-          <div class="section-description">
-          The base class for all matrices.
-          </div>
-    <dl class="function">
-    <dt>
-    <a name = "nerv.Matrix:__tostring__"></a>
-    <strong>nerv.Matrix:__tostring__ ()</strong>
-    </dt>
-    <dd>
-    Convert the matrix object to a string.
-
-
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.Matrix:generate"></a>
-    <strong>nerv.Matrix:generate (gen)</strong>
-    </dt>
-    <dd>
-    Assign each element in a matrix using the value returned by a callback <code>gen</code>.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">gen</span>
-         the callback used to generated the values in the matrix, to which
- the indices of row and column will be passed (e.g., <code>gen(i, j)</code>)
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.Matrix:create"></a>
-    <strong>nerv.Matrix:create (nrow, ncol)</strong>
-    </dt>
-    <dd>
-    Create a fresh new matrix of the same matrix type (as <code>self</code>).
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">nrow</span>
-         optional, the number of rows in the created matrix if specified,
- otherwise <code>self:nrow()</code> will be used
-        </li>
-        <li><span class="parameter">ncol</span>
-         optional, the number of columns in the created matrix if specified,
- otherwise <code>self:ncol()</code> will be used
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.Matrix:__add__"></a>
-    <strong>nerv.Matrix:__add__ (b)</strong>
-    </dt>
-    <dd>
-    Operator overloading of <code>+</code>.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">b</span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.Matrix:__sub__"></a>
-    <strong>nerv.Matrix:__sub__ (b)</strong>
-    </dt>
-    <dd>
-    Operator overloading of <code>-</code>.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">b</span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.Matrix:__mul__"></a>
-    <strong>nerv.Matrix:__mul__ (b)</strong>
-    </dt>
-    <dd>
-    Operator overloading of <code>*</code>.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">b</span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header has-description"><a name="Class_nerv_CuMatrixFloat"></a>Class nerv.CuMatrixFloat </h2>
-
-          <div class="section-description">
-          CUDA float matrices
-          </div>
-    <dl class="function">
-    <dt>
-    <a name = "nerv.CuMatrixFloat.new_from_host"></a>
-    <strong>nerv.CuMatrixFloat.new_from_host (mat)</strong>
-    </dt>
-    <dd>
-    Create a CUDA matrix copy of the host matrix (in memory)
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">mat</span>
-         the host matrix
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.CuMatrixFloat:new_to_host"></a>
-    <strong>nerv.CuMatrixFloat:new_to_host ()</strong>
-    </dt>
-    <dd>
-    Create a host matrix copy of the CUDA matrix
-
-
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header has-description"><a name="Class_nerv_CuMatrixDouble"></a>Class nerv.CuMatrixDouble </h2>
-
-          <div class="section-description">
-          CUDA double matrices
-          </div>
-    <dl class="function">
-    <dt>
-    <a name = "nerv.CuMatrixDouble.new_from_host"></a>
-    <strong>nerv.CuMatrixDouble.new_from_host (mat)</strong>
-    </dt>
-    <dd>
-    Create a CUDA matrix copy of the host matrix (in memory)
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">mat</span>
-         the host matrix
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.CuMatrixDouble:new_to_host"></a>
-    <strong>nerv.CuMatrixDouble:new_to_host ()</strong>
-    </dt>
-    <dd>
-    Create a host matrix copy of the CUDA matrix
-
-
-
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header has-description"><a name="Class_nerv_MMatrix"></a>Class nerv.MMatrix </h2>
-
-          <div class="section-description">
-          The base class for all host (in-memory) matrices
-          </div>
-    <dl class="function">
-    <dt>
-    <a name = "nerv.MMatrix:copy_toh"></a>
-    <strong>nerv.MMatrix:copy_toh (b, ...)</strong>
-    </dt>
-    <dd>
-    A wrapper function for <code>copy_fromh</code>
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">b</span>
-
-        </li>
-        <li><span class="parameter">...</span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.MMatrix.print_profile"></a>
-    <strong>nerv.MMatrix.print_profile ()</strong>
-    </dt>
-    <dd>
-    Print profiling info of host matrices
-
-
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "nerv.MMatrix.clear_profile"></a>
-    <strong>nerv.MMatrix.clear_profile ()</strong>
-    </dt>
-    <dd>
-    Clear profiling info of host matrices
-
-
-
-
-
-
-
-</dd>
-</dl>
-
-
-</div> <!-- id="content" -->
-</div> <!-- id="main" -->
-<div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
-<i style="float:right;">Last updated 2016-01-15 14:56:30 </i>
-</div> <!-- id="about" -->
-</div> <!-- id="container" -->
-</body>
-</html>
diff --git a/nerv/doc/lua/modules/nerv.html b/nerv/doc/lua/modules/nerv.html
deleted file mode 100644
index 91baf9e..0000000
--- a/nerv/doc/lua/modules/nerv.html
+++ /dev/null
@@ -1,428 +0,0 @@
-<!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>NERV documentation</title>
-    <link rel="stylesheet" href="../ldoc_pale.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>NERV</h1>
-
-<ul>
-  <li><a href="../index.html">Index</a></li>
-</ul>
-
-<h2>Contents</h2>
-<ul>
-<li><a href="#Functions">Functions</a></li>
-</ul>
-
-
-<h2>Modules</h2>
-<ul class="$(kind=='Topics' and '' or 'nowrap'">
-  <li><strong>nerv</strong></li>
-  <li><a href="../modules/layer.affine.html">layer.affine</a></li>
-  <li><a href="../modules/matrix.html">matrix</a></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>nerv</code></h1>
-<p>NERV: a Lua-based toolkit for high-performance deep learning.</p>
-<p>
- This file contains misc utility functions of NERV and finally initializes
- NERV by including <code>init.lua</code> of other basic modules.</p>
-    <h3>Info:</h3>
-    <ul>
-        <li><strong>Author</strong>: Ted Yin <ted.sybil@gmail.com></li>
-    </ul>
-
-
-<h2><a href="#Functions">Functions</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#error_method_not_implemented">error_method_not_implemented ()</a></td>
-	<td class="summary">Dummy function.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#sprintf">sprintf (fmt, ...)</a></td>
-	<td class="summary">Format a string just like <a href="../modules/nerv.html#sprintf">sprintf</a> in C.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#printf">printf (fmt, ...)</a></td>
-	<td class="summary">Print a formatted string to stdout.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#error">error (fmt, ...)</a></td>
-	<td class="summary">Raise an global error with the formatted message.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#info">info (fmt, ...)</a></td>
-	<td class="summary">Print a notification message that begins with "info" and a timestamp.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#warning">warning (fmt, ...)</a></td>
-	<td class="summary">Print a warning message that begins with "warning" and a timestamp.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#class">class (tname, parenttname)</a></td>
-	<td class="summary">Create a class (Torch-compatible).</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#table.tostring">table.tostring (tbl)</a></td>
-	<td class="summary">Get the string representation of a table, which can be executed as a valid
- piece of Lua code.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#get_type">get_type (tname)</a></td>
-	<td class="summary">Get the class by name.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#is_type">is_type (obj, tname)</a></td>
-	<td class="summary">Check if the object is of the certain class.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#dirname">dirname (filename)</a></td>
-	<td class="summary">Strip last component from file name.</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#include">include (filename)</a></td>
-	<td class="summary">Include a script file (chunk) into the current script.</td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "error_method_not_implemented"></a>
-    <strong>error_method_not_implemented ()</strong>
-    </dt>
-    <dd>
-    Dummy function.
- Display a friendly error message when user attempts to invoke a
- non-implemented function.
-
-
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "sprintf"></a>
-    <strong>sprintf (fmt, ...)</strong>
-    </dt>
-    <dd>
-    Format a string just like <a href="../modules/nerv.html#sprintf">sprintf</a> in C.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">fmt</span>
-         the format string
-        </li>
-        <li><span class="parameter">...</span>
-         args, the data to be formatted
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-        the formatted string
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "printf"></a>
-    <strong>printf (fmt, ...)</strong>
-    </dt>
-    <dd>
-    Print a formatted string to stdout.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">fmt</span>
-         the format string
-        </li>
-        <li><span class="parameter">...</span>
-         args, the data to be formatted
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "error"></a>
-    <strong>error (fmt, ...)</strong>
-    </dt>
-    <dd>
-    Raise an global error with the formatted message.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">fmt</span>
-         the format string
-        </li>
-        <li><span class="parameter">...</span>
-         args, the data to be formatted
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "info"></a>
-    <strong>info (fmt, ...)</strong>
-    </dt>
-    <dd>
-    Print a notification message that begins with "info" and a timestamp.
- Instead of using <a href="../modules/nerv.html#printf">nerv.printf</a>, normal users should use this to print any
- notification information.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">fmt</span>
-         the format string
-        </li>
-        <li><span class="parameter">...</span>
-         args, the data to be formatted
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "warning"></a>
-    <strong>warning (fmt, ...)</strong>
-    </dt>
-    <dd>
-    Print a warning message that begins with "warning" and a timestamp.
- Instead of using <a href="../modules/nerv.html#printf">nerv.printf</a>, normal users should use this to print any
- warnings.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">fmt</span>
-         the format string
-        </li>
-        <li><span class="parameter">...</span>
-         args, the data to be formatted
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "class"></a>
-    <strong>class (tname, parenttname)</strong>
-    </dt>
-    <dd>
-    Create a class (Torch-compatible).
- Use this to create a class in NERV.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">tname</span>
-         the class name
-        </li>
-        <li><span class="parameter">parenttname</span>
-         the parent class name (from which it inherits)
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-        the created class
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "table.tostring"></a>
-    <strong>table.tostring (tbl)</strong>
-    </dt>
-    <dd>
-    Get the string representation of a table, which can be executed as a valid
- piece of Lua code.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">tbl</span>
-         the table
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-        the string representation which will result in a Lua table entity
- when evaluated
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "get_type"></a>
-    <strong>get_type (tname)</strong>
-    </dt>
-    <dd>
-    Get the class by name.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">tname</span>
-         the name of the class
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-        the class entity
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "is_type"></a>
-    <strong>is_type (obj, tname)</strong>
-    </dt>
-    <dd>
-    Check if the object is of the certain class.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">obj</span>
-         the object ("class instance")
-        </li>
-        <li><span class="parameter">tname</span>
-         the class name ("type name")
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "dirname"></a>
-    <strong>dirname (filename)</strong>
-    </dt>
-    <dd>
-    Strip last component from file name.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">filename</span>
-         the path to a file
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-        the path to the containing directory
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "include"></a>
-    <strong>include (filename)</strong>
-    </dt>
-    <dd>
-    Include a script file (chunk) into the current script.
- An analogy to <code>#include</code> in C. Note that the effect is the same as executing
- <code>dofile(filename)</code> at the current line.
-
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">filename</span>
-         the path to a file
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-        all values returned by the chunk
-    </ol>
-
-
-
-
-</dd>
-</dl>
-
-
-</div> <!-- id="content" -->
-</div> <!-- id="main" -->
-<div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
-<i style="float:right;">Last updated 2016-01-15 14:56:30 </i>
-</div> <!-- id="about" -->
-</div> <!-- id="container" -->
-</body>
-</html>
author	Determinant <ted.sybil@gmail.com>	2016-04-19 16:03:58 +0800
committer	Determinant <ted.sybil@gmail.com>	2016-04-19 16:03:58 +0800
commit	bfe8469abcab65a8bed43e549e42e5d3a5cfec14 (patch)
tree	36ccb02087aeff02370108c0408e19052e544ede /nerv/doc/lua/modules
parent	8f6eb50628cadbd0e831d72c4528400b94431ee6 (diff)