qminer/nodedoc/ladoc_module.js

A C++ based data analytics platform for processing large-scale real-time streams containing structured and unstructured data

/**
 * Copyright (c) 2015, Jozef Stefan Institute, Quintelligence d.o.o. and contributors
 * All rights reserved.
 *
 * This source code is licensed under the FreeBSD license found in the
 * LICENSE file in the root directory of this source tree.
 */
/**
* Linear algebra module.
* @module la
* @example
* // import la module
* var la = require('qminer').la;
* // create a random matrix
* var mat = new la.Matrix({ rows: 10, cols: 5, random: true });
* // create a vector
* var vec = new la.Vector([1, 2, 3, 0, -1]);
* // multiply the matrix and vector
* var vec2 = mat.multiply(vec);
* // calculate the svd decomposition of the matrix
* var svd = la.svd(mat, 3);
*/
/**
    * Computes the truncated SVD decomposition.
    * @param {module:la.Matrix | module:la.SparseMatrix} mat - The matrix.
    * @param {number} k - The number of singular vectors to be computed.
    * @param {Object} [json] - The JSON object.
    * @param {number} [json.iter = 100] - The number of iterations used for the algorithm.
    * @param {number} [json.tol = 1e-6] - The tolerance number.
    * @param {function} [callback] - The callback function, that takes the error parameters (err) and the result parameter (res).
    * <i>Only for the asynchronous function.</i>
    * @returns {Object} The JSON object `svdRes` which contains the SVD decomposition U*S*V^T matrices:
    * <br>`svdRes.U` - The dense matrix of the decomposition. Type {@link module:la.Matrix}.
    * <br>`svdRes.V` - The dense matrix of the decomposition. Type {@link module:la.Matrix}.
    * <br>`svdRes.s` - The vector containing the singular values of the decomposition. Type {@link module:la.Vector}.
    * @example <caption>Asynchronous function</caption>
    * // import the modules
    * var la = require('qminer').la;
    * // create a random matrix
    * var A = new la.Matrix({ rows: 10, cols: 5, random: true });
    * // set the parameters for the calculation
    * var k = 2; // number of singular vectors
    * var param = { iter: 1000, tol: 1e-4 };
    * // calculate the svd
    * la.svd(A, k, param, function (err, result) {
    *    if (err) { console.log(err); }
    *    // successful calculation
    *    var U = result.U;
    *    var V = result.V;
    *    var s = result.s;
    * });
    * @example <caption>Synchronous function</caption>
    * // import the modules
    * var la = require('qminer').la;
    * // create a random matrix
    * var A = new la.Matrix({ rows: 10, cols: 5, random: true });
    * // set the parameters for the calculation
    * var k = 2; // number of singular vectors
    * var param = { iter: 1000, tol: 1e-4 };
    * // calculate the svd
    * var result = la.svd(A, k, param);
    * // successful calculation
    * var U = result.U;
    * var V = result.V;
    * var s = result.s;
    */
 exports.prototype.svd = function (mat, k, json) { return { U: Object.create(require('qminer').la.Matrix.prototype), V: Object.create(require('qminer').la.Matrix.prototype), s: Object.create(require('qminer').la.Vector.prototype) } }
/**
    * Computes the QR decomposition.
    * @param {module:la.Matrix} mat - The matrix.
    * @param {number} [tol = 1e-6] - The tolerance number.
    * @returns {Object} A JSON object `qrRes` which contains the decomposition matrices:
    * <br>`qrRes.Q` - The orthogonal matrix Q of the QR decomposition. Type {@link module:la.Matrix}.
    * <br>`qrRes.R` - The upper triangular matrix R of the QR decomposition. Type {@link module:la.Matrix}.
    * @example
    * // import la module
    * var la = require('qminer').la;
    * // create a random matrix
    * var mat = new la.Matrix({ rows: 10, cols: 5, random: true });
    * // calculate the QR decomposition of mat
    * var qrRes = la.qr(mat);
    */
 exports.prototype.qr = function (mat, tol) { return { Q: Object.create(require('qminer').la.Matrix.prototype), R: Object.create(require('qminer').la.Matrix.prototype) } }