typescript-closure-tools

/// <reference path="../../../globals.d.ts" /> /// <reference path="./size.d.ts" /> declare module goog.math { class Matrix extends Matrix__Class { } /** Fake class which should be extended to avoid inheriting static properties */ class Matrix__Class { /** * Class for representing and manipulating matrices. * * The entry that lies in the i-th row and the j-th column of a matrix is * typically referred to as the i,j entry of the matrix. * * The m-by-n matrix A would have its entries referred to as: * [ a0,0 a0,1 a0,2 ... a0,j ... a0,n ] * [ a1,0 a1,1 a1,2 ... a1,j ... a1,n ] * [ a2,0 a2,1 a2,2 ... a2,j ... a2,n ] * [ . . . . . ] * [ . . . . . ] * [ . . . . . ] * [ ai,0 ai,1 ai,2 ... ai,j ... ai,n ] * [ . . . . . ] * [ . . . . . ] * [ . . . . . ] * [ am,0 am,1 am,2 ... am,j ... am,n ] * * @param {goog.math.Matrix|Array.<Array.<number>>|goog.math.Size|number} m * A matrix to copy, a 2D-array to take as a template, a size object for * dimensions, or the number of rows. * @param {number=} opt_n Number of columns of the matrix (only applicable if * the first argument is also numeric). * @constructor * @final */ constructor(m: goog.math.Matrix|number[][]|goog.math.Size|number, opt_n?: number); /** * Returns a new matrix that is the sum of this and the provided matrix. * @param {goog.math.Matrix} m The matrix to add to this one. * @return {!goog.math.Matrix} Resultant sum. */ add(m: goog.math.Matrix): goog.math.Matrix; /** * Appends the given matrix to the right side of this matrix. * @param {goog.math.Matrix} m The matrix to augment this matrix with. * @return {!goog.math.Matrix} A new matrix with additional columns on the * right. */ appendColumns(m: goog.math.Matrix): goog.math.Matrix; /** * Appends the given matrix to the bottom of this matrix. * @param {goog.math.Matrix} m The matrix to augment this matrix with. * @return {!goog.math.Matrix} A new matrix with added columns on the bottom. */ appendRows(m: goog.math.Matrix): goog.math.Matrix; /** * Returns whether the given matrix equals this matrix. * @param {goog.math.Matrix} m The matrix to compare to this one. * @param {number=} opt_tolerance The tolerance when comparing array entries. * @return {boolean} Whether the given matrix equals this matrix. */ equals(m: goog.math.Matrix, opt_tolerance?: number): boolean; /** * Returns the determinant of this matrix. The determinant of a matrix A is * often denoted as |A| and can only be applied to a square matrix. * @return {number} The determinant of this matrix. */ getDeterminant(): number; /** * Returns the inverse of this matrix if it exists or null if the matrix is * not invertible. * @return {goog.math.Matrix} A new matrix which is the inverse of this matrix. */ getInverse(): goog.math.Matrix; /** * Transforms this matrix into reduced row echelon form. * @return {!goog.math.Matrix} A new matrix reduced row echelon form. */ getReducedRowEchelonForm(): goog.math.Matrix; /** * @return {!goog.math.Size} The dimensions of the matrix. */ getSize(): goog.math.Size; /** * Return the transpose of this matrix. For an m-by-n matrix, the transpose * is the n-by-m matrix which results from turning rows into columns and columns * into rows * @return {!goog.math.Matrix} A new matrix A^T. */ getTranspose(): goog.math.Matrix; /** * Retrieves the value of a particular coordinate in the matrix or null if the * requested coordinates are out of range. * @param {number} i The i index of the coordinate. * @param {number} j The j index of the coordinate. * @return {?number} The value at the specified coordinate. */ getValueAt(i: number, j: number): number; /** * @return {boolean} Whether the horizontal and vertical dimensions of this * matrix are the same. */ isSquare(): boolean; /** * Sets the value at a particular coordinate (if the coordinate is within the * bounds of the matrix). * @param {number} i The i index of the coordinate. * @param {number} j The j index of the coordinate. * @param {number} value The new value for the coordinate. */ setValueAt(i: number, j: number, value: number): void; /** * Performs matrix or scalar multiplication on a matrix and returns the * resultant matrix. * * Matrix multiplication is defined between two matrices only if the number of * columns of the first matrix is the same as the number of rows of the second * matrix. If A is an m-by-n matrix and B is an n-by-p matrix, then their * product AB is an m-by-p matrix * * Scalar multiplication returns a matrix of the same size as the original, * each value multiplied by the given value. * * @param {goog.math.Matrix|number} m Matrix/number to multiply the matrix by. * @return {!goog.math.Matrix} Resultant product. */ multiply(m: goog.math.Matrix|number): goog.math.Matrix; /** * Returns a new matrix that is the difference of this and the provided matrix. * @param {goog.math.Matrix} m The matrix to subtract from this one. * @return {!goog.math.Matrix} Resultant difference. */ subtract(m: goog.math.Matrix): goog.math.Matrix; /** * @return {!Array.<!Array.<number>>} A 2D internal array representing this * matrix. Not a clone. */ toArray(): number[][]; } } declare module goog.math.Matrix { /** * Creates a square identity matrix. i.e. for n = 3: * <pre> * [ 1 0 0 ] * [ 0 1 0 ] * [ 0 0 1 ] * </pre> * @param {number} n The size of the square identity matrix. * @return {!goog.math.Matrix} Identity matrix of width and height {@code n}. */ function createIdentityMatrix(n: number): goog.math.Matrix; /** * Calls a function for each cell in a matrix. * @param {goog.math.Matrix} matrix The matrix to iterate over. * @param {Function} fn The function to call for every element. This function * takes 4 arguments (value, i, j, and the matrix) * and the return value is irrelevant. * @param {Object=} opt_obj The object to be used as the value of 'this' * within {@code fn}. */ function forEach(matrix: goog.math.Matrix, fn: Function, opt_obj?: Object): void; /** * Tests whether an array is a valid matrix. A valid array is an array of * arrays where all arrays are of the same length and all elements are numbers. * @param {Array} arr An array to test. * @return {boolean} Whether the array is a valid matrix. */ function isValidArray(arr: any[]): boolean; /** * Calls a function for every cell in a matrix and inserts the result into a * new matrix of equal dimensions. * @param {goog.math.Matrix} matrix The matrix to iterate over. * @param {Function} fn The function to call for every element. This function * takes 4 arguments (value, i, j and the matrix) * and should return something. The result will be inserted * into a new matrix. * @param {Object=} opt_obj The object to be used as the value of 'this' * within {@code fn}. * @return {!goog.math.Matrix} A new matrix with the results from {@code fn}. */ function map(matrix: goog.math.Matrix, fn: Function, opt_obj?: Object): goog.math.Matrix; }