Class Index | File Index

Classes


Built-In Namespace _global_

Field Summary
Field Attributes Field Name and Description
 
eye
Alias for dentity(), see identity
 
Returned identity matrix of given size, see Matrix#Identity
 
constant ( = 10000.
 
constant ( = 1e-8)
 
constant ( = 1e-32)
 
constant ( = 0 )
 
constant ( = 1 )
 
constant ( = 2 )
 
mat
Returns new Matrix object from given array
 
Alias for dentity(), see identity
 
vec
Returns new Vector object from given array
Method Summary
Method Attributes Method Name and Description
 
Alias for canMultiplyMat(), see Vector#canMultiplyMat
 
eigSolve(params, method)
Eigenvalues and eigenvectors solver.
 
linSolve(a, rhs, saveOrig, method, precompDecomps)
Linear system equation solver.
 
ones(nRows, nCols)
Returns new Vector or Matrix full of given size full of ones
 
range(a, b, c)
Returns sequence (array) with start, stop, step.
 
zeros(nRows, nCols)
Returns new Vector or Matrix full of given size full of zeros
Field Detail
eye
Alias for dentity(), see identity
Defined in: jsmatrix.src.js.

{Matrix} identity
Returned identity matrix of given size, see Matrix#Identity
Defined in: jsmatrix.src.js.
m = identity(3); // m = Matrix([[1,0,0],[0,1,0],[0,0,1]])

JSM_ROUNDFACTOR
constant ( = 10000.)
Defined in: jsmatrix.src.js.

JSM_TOL
constant ( = 1e-8)
Defined in: jsmatrix.src.js.

JSM_TOL2
constant ( = 1e-32)
Defined in: jsmatrix.src.js.

JSM_X
constant ( = 0 )
Defined in: jsmatrix.src.js.

JSM_Y
constant ( = 1 )
Defined in: jsmatrix.src.js.

JSM_Z
constant ( = 2 )
Defined in: jsmatrix.src.js.

{Matrix} mat
Returns new Matrix object from given array
Defined in: jsmatrix.src.js.
m = mat([[1,2,3],[4,5,6],[7,8,9]]) // m = Matrix([[1,2,3],[4,5,6],[7,8,9]])

unitMatrix
Alias for dentity(), see identity
Defined in: jsmatrix.src.js.

{Vector} vec
Returns new Vector object from given array
Defined in: jsmatrix.src.js.
v = vec([1,2,3,4]) // v = Vector([1,2,3,4])
Method Detail
canMultiplyMatFromLeft()
Alias for canMultiplyMat(), see Vector#canMultiplyMat
Defined in: jsmatrix.src.js.

{[[floats]|[Vectors]]} eigSolve(params, method)
Eigenvalues and eigenvectors solver. Returns first nEigModes eigenvales (lambda) and eigenvectors (phi) of problem mat1*phi=lambda*mat2*phi. See Matrix#eig for input description. Eigenvectors are normalized with respect to mat2
Defined in: jsmatrix.src.js.
Parameters:
{Object} params
object of parameters
{Matrix} params.mat1
{Matrix} params.mat2 Optional, Default: Matrix.Identity
{int} params.nEigModes Optional, Default: 1
{int} method Optional, Default: "default"
{bool} params.highest Optional, Default: false
{int} params.maxiter Optional, Default: 1000
Returns:
{[[floats]|[Vectors]]} [[lambda1,lambda2,...,lambdaN],[phi1,phi2,...,phiN]], lambdai is i-th eigenvale, phii is i-th eigenvector. N = nEigModes

{Vector|[Vectors]|Matrix} linSolve(a, rhs, saveOrig, method, precompDecomps)
Linear system equation solver. Returns vector x as a solution of a*ret=rhs, see Matrix#linSolve for input desription
Defined in: jsmatrix.src.js.
Parameters:
{Matrix} a
{Vector|[Vectors]|Matrix} rhs
{bool} saveOrig Optional, Default: true
{int} method Optional, Default: "default"
{[Matrices]} precompDecomps Optional
Returns:
{Vector|[Vectors]|Matrix} solution x of a*x=rhs

{Matrix|Vector} ones(nRows, nCols)
Returns new Vector or Matrix full of given size full of ones
Defined in: jsmatrix.src.js.
m = zeros(2,3); // m = Matrix([[1,1,1],[1,1,1]])
v = zeros(4) // v = Vector([1,1,1,1])
Parameters:
{int} nRows
number of rows of returned object
{int} nCols Optional
if specified, new Matrix of size (nRows,nCols) is returned, new vector of size nRows otherwise
Returns:
{Matrix|Vector} new Matrix or Vector object

{[floats]} range(a, b, c)
Returns sequence (array) with start, stop, step. Inspired by Python syntax
Defined in: jsmatrix.src.js.
r = range(8);     // r = [0,1,2,3,4,5,6,7]
r = range(2,8);   // r = [2,3,4,5,7]
r = range(2,8,2); // r = [2,4,6]
Parameters:
{float|int} a
start/stop (according to b, see example)
{float|int} b Optional
stop
{float|int} c Optional, Default: 1
step
Returns:
{[floats]} array containing given sequence

{Matrix|Vector} zeros(nRows, nCols)
Returns new Vector or Matrix full of given size full of zeros
Defined in: jsmatrix.src.js.
m = zeros(2,3); // m = Matrix([[0,0,0],[0,0,0]])
v = zeros(4) // v = Vector([0,0,0,0])
Parameters:
{int} nRows
number of rows of returned object
{int} nCols Optional
if specified, new Matrix of size (nRows,nCols) is returned, new vector of size nRows otherwise
Returns:
{Matrix|Vector} new Matrix or Vector object

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Dec 12 2012 09:21:38 GMT+0100 (CET)