diff options
Diffstat (limited to 'nerv/doc/lua/modules/matrix.html')
| -rw-r--r-- | nerv/doc/lua/modules/matrix.html | 409 |
1 files changed, 409 insertions, 0 deletions
diff --git a/nerv/doc/lua/modules/matrix.html b/nerv/doc/lua/modules/matrix.html new file mode 100644 index 0000000..2840e59 --- /dev/null +++ b/nerv/doc/lua/modules/matrix.html @@ -0,0 +1,409 @@ +<!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> |