<!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>
</<