qminer
Version:
A C++ based data analytics platform for processing large-scale real-time streams containing structured and unstructured data
360 lines (356 loc) • 14.7 kB
HTML
<html>
<head>
<meta name="generator" content="JSDoc 3">
<meta charset="utf-8">
<title>Class: MDS</title>
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
<link href="css/baseline.css" rel="stylesheet">
</head>
<body onload="prettyPrint()">
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content">
<a href="index.html" class="jsdoc-navbar-package-name">QMiner JavaScript API v9.4.0</a>
</div>
</div>
</nav>
<div id="jsdoc-body-container">
<div id="jsdoc-content">
<div id="jsdoc-content-container">
<div id="jsdoc-main" role="main">
<header class="page-header">
<div class="symbol-detail-labels"><span class="label label-kind">class</span> <span class="label label-static">static</span></div>
<h1><small><a href="module-analytics.html">analytics</a>.<wbr></small><span class="symbol-name">MDS</span></h1>
<p class="source-link">Source: <a href="analyticsdoc.js.html#source-line-1589">analyticsdoc.<wbr>js:1589</a></p>
<div class="symbol-classdesc">
<p>Scales a higher level vectors into a 2D vector space such that the distances between vectors are preserved as well as possible.</p>
</div>
<dl class="dl-compact">
</dl>
</header>
<section id="summary">
<div class="summary-callout">
<h2 class="summary-callout-heading">Methods</h2>
<div class="summary-content">
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-analytics.MDS.html#fitTransform">fitTransform(mat[, callback])</a></dt>
<dd>
</dd>
<dt><a href="module-analytics.MDS.html#getParams">getParams()</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-analytics.MDS.html#save">save(fout)</a></dt>
<dd>
</dd>
<dt><a href="module-analytics.MDS.html#setParams">setParams(params)</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
</div>
</div>
</div>
</section>
<section>
<h2 id="MDS">new <span class="symbol-name">MDS</span><span class="signature"><span class="signature-params">([arg])</span></span></h2>
<p>Multidimensional Scaling</p>
<section>
<h3>
Example
</h3>
<div>
<pre class="prettyprint"><code>// import analytics module
var analytics = require('qminer').analytics;
// construct a MDS instance
var mds = new analytics.MDS({ maxStep: 300, distType: 'Cos' });
// create the multidimensional matrix
var mat = new la.Matrix({ rows: 50, cols: 10, random: true });
// get the 2d representation of mat
var mat2d = mds.fitTransform(mat);</code></pre>
</div>
</section>
<section>
<h3>Parameter</h3>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>arg</p>
</td>
<td>
<p>(<a href="module-analytics.html#~MDSParam">module:analytics~MDSParam</a> or <a href="module-fs.FIn.html">module:fs.FIn</a>)</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>Construction arguments. There are two ways of constructing:
<br>1. Using the <a href="module-analytics.html#~MDSParam">module:analytics~MDSParam</a> object,
<br>2. using the file input stream <a href="module-fs.FIn.html">module:fs.FIn</a>.
</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
</dl>
</section>
<section>
<h2>Methods</h2>
<section>
<h3 id="fitTransform"><span class="symbol-name">fitTransform</span><span class="signature"><span class="signature-params">(mat[, callback])</span> → <span class="signature-returns"> <a href="module-la.Matrix.html">module:la.Matrix</a></span></span></h3>
<p>Get the MDS of the given matrix.</p>
<section>
<h4>
Examples
</h4>
<div>
<p>Asynchronous function</p>
<pre class="prettyprint"><code>// import the modules
var analytics = require('qminer').analytics;
var la = require('qminer').la;
// create a MDS instance
var mds = new analytics.MDS();
// create the multidimensional matrix
var mat = new la.Matrix({ rows: 50, cols: 10, random: true });
// get the 2d representation of mat
mds.fitTransformAsync(mat, function (err, res) {
if (err) throw err;
// successful calculation
var mat2d = res;
});</code></pre>
</div>
<div>
<p>Synchronous function</p>
<pre class="prettyprint"><code>// import the modules
var analytics = require('qminer').analytics;
var la = require('qminer').la;
// create a MDS instance
var mds = new analytics.MDS();
// create the multidimensional matrix
var mat = new la.Matrix({ rows: 50, cols: 10, random: true });
// get the 2d representation of mat
var mat2d = mds.fitTransform(mat);</code></pre>
</div>
</section>
<section>
<h4>Parameters</h4>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>mat</p>
</td>
<td>
<p>(<a href="module-la.Matrix.html">module:la.Matrix</a> or <a href="module-la.SparseMatrix.html">module:la.SparseMatrix</a>)</p>
</td>
<td>
<p> </p>
</td>
<td>
<p>The multidimensional matrix.</p>
</td>
</tr>
<tr>
<td>
<p>callback</p>
</td>
<td>
<p>function()</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>The callback function receiving the error parameter (<code>err</code>) and the result parameter (<code>res</code>).
<i>Only for the asynchronous function.</i>
</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-la.Matrix.html">module:la.Matrix</a></code>B The matrix of dimensions <code>mat.cols</code> x 2, where the i-th row of the matrix is the 2D representation
of the i-th column of <code>mat</code>.</p>
</dd>
</dl>
<h3 id="getParams"><span class="symbol-name">getParams</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> <a href="module-analytics.html#~MDSParam">module:analytics~MDSParam</a></span></span></h3>
<p>Get the parameters.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import analytics module
var analytics = require('qminer').analytics;
// create a MDS instance
var mds = new analytics.MDS();
// get the (default) parameters of the instance
// returns { maxStep: 5000, maxSecs: 300, minDiff: 1e-4, distType: "Euclid" }
var params = mds.getParams();</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-analytics.html#~MDSParam">module:analytics~MDSParam</a></code>B The constructor parameters.</p>
</dd>
</dl>
<h3 id="save"><span class="symbol-name">save</span><span class="signature"><span class="signature-params">(fout)</span> → <span class="signature-returns"> <a href="module-fs.FOut.html">module:fs.FOut</a></span></span></h3>
<p>Save the MDS model.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import modules
var analytics = require('qminer').analytics;
var fs = require('qminer').fs;
// create a MDS instance
var mds = new analytics.MDS({ iter: 200, MaxStep: 10 });
// create the file output stream
var fout = new fs.openWrite('MDS.bin');
// save the MDS instance
mds.save(fout);
fout.close();
// load the MDS instance
var fin = fs.openRead('MDS.bin');
var mds2 = new analytics.MDS(fin);</code></pre>
</div>
</section>
<section>
<h4>Parameter</h4>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>fout</p>
</td>
<td>
<p><a href="module-fs.FOut.html">module:fs.FOut</a></p>
</td>
<td>
<p> </p>
</td>
<td>
<p>The output stream.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-fs.FOut.html">module:fs.FOut</a></code>B The output stram <code>fout</code>.</p>
</dd>
</dl>
<h3 id="setParams"><span class="symbol-name">setParams</span><span class="signature"><span class="signature-params">(params)</span> → <span class="signature-returns"> <a href="module-analytics.MDS.html">module:analytics.MDS</a></span></span></h3>
<p>Set the parameters.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import analytics module
var analytics = require('qminer').analytics;
// create a MDS instance
var mds = new analytics.MDS();
// get the (default) parameters of the instance
// returns { maxStep: 5000, maxSecs: 300, minDiff: 1e-4, distType: "Euclid" }
var params = mds.getParams();</code></pre>
</div>
</section>
<section>
<h4>Parameter</h4>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>params</p>
</td>
<td>
<p><a href="module-analytics.html#~MDSParam">module:analytics~MDSParam</a></p>
</td>
<td>
<p> </p>
</td>
<td>
<p>The constructor parameters.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-analytics.MDS.html">module:analytics.MDS</a></code>B Self. The model parameters have been updated.</p>
</dd>
</dl>
</section>
</section>
</div>
</div>
<nav id="jsdoc-toc-nav" role="navigation"></nav>
</div>
</div>
<footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container">
<p>
</p>
</div>
</footer>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tree.jquery.js"></script>
<script src="scripts/prettify.js"></script>
<script src="scripts/jsdoc-toc.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/scrollanchor.js"></script>
</body>
</html>