docs/DimRed.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: DimRed</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: DimRed</h1>
<section>
<header>
<h2>DimRed</h2>
<div class="class-description">An object to track data and changes for dimensionality reduction</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="DimRed"><span class="type-signature"></span>new DimRed<span class="signature">(Mat)</span><span class="type-signature"></span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Mat</code></td>
<td class="type">
<span class="param-type">MiniMat</span>
</td>
<td class="description last">The data matrix to operate on</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".cgreat"><span class="type-signature">(static) </span>cgreat<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
<div class="description">
a static comparison function for array arithmetic, returns true if first param is greater than the second
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last">a number to compare</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last">a number to compare</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".cless"><span class="type-signature">(static) </span>cless<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
<div class="description">
a static comparison function for array arithmetic, returns true if first param is less than the second
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last">a number to compare</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last">a number to compare</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".mean"><span class="type-signature">(static) </span>mean<span class="signature">(arr)</span><span class="type-signature"></span></h4>
<div class="description">
a static mean function for array arithmetic, returns mean
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>arr</code></td>
<td class="type">
<span class="param-type">Array.<Object></span>
</td>
<td class="description last">an array of floats to find mean</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line37">line 37</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".missing"><span class="type-signature">(static) </span>missing<span class="signature">(arr)</span><span class="type-signature"></span></h4>
<div class="description">
Determine missing data ratio of an array for missing data filter
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>arr</code></td>
<td class="type">
<span class="param-type">Array.<Object></span>
</td>
<td class="description last">an array of floats to find missing data ratio of</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".radd"><span class="type-signature">(static) </span>radd<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
<div class="description">
a static add function for array arithmetic, returns sum
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last">a number to add</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="description last">a number to add</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".variance"><span class="type-signature">(static) </span>variance<span class="signature">(arr)</span><span class="type-signature"></span></h4>
<div class="description">
Determine variance of an array for low variance filter
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>arr</code></td>
<td class="type">
<span class="param-type">Array.<Object></span>
</td>
<td class="description last">an array of floats to find variance of</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="filter"><span class="type-signature"></span>filter<span class="signature">(fil_fcn<span class="signature-attributes">opt</span>, parameter<span class="signature-attributes">opt</span>, comparison<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
in place filter method with adjustable parameter
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fil_fcn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">a function to filter upon</td>
</tr>
<tr>
<td class="name"><code>parameter</code></td>
<td class="type">
<span class="param-type">parameter</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
1
</td>
<td class="description last">a paramater to compare the filter against</td>
</tr>
<tr>
<td class="name"><code>comparison</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">a function which returns true when data is desired to be kept, given filter(col) and the paramater</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line88">line 88</a>
</li></ul></dd>
</dl>
<h4 class="name" id="filter_promise"><span class="type-signature"></span>filter_promise<span class="signature">(fil_fcn<span class="signature-attributes">opt</span>, parameter<span class="signature-attributes">opt</span>, comparison<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
async manager for filter dimensionality reduction; returns a promise.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fil_fcn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">a function to filter upon</td>
</tr>
<tr>
<td class="name"><code>parameter</code></td>
<td class="type">
<span class="param-type">parameter</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
1
</td>
<td class="description last">a paramater to compare the filter against</td>
</tr>
<tr>
<td class="name"><code>comparison</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">a function which returns true when data is desired to be kept, given filter(col) and the paramater</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dimred.js.html">dimred.js</a>, <a href="dimred.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="DimRed.html">DimRed</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Feb 02 2017 11:47:18 GMT-0500 (EST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>