linear-algebra.html

<!doctype html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<title>Linear Algebra - jStat Documentation</title>
	<link rel="stylesheet" href="assets/style.css" />
	<link rel="stylesheet" href="assets/sh.css" />
</head>
<body>
	<div id="container">
    <header>
      <h1>jStat v1.9.3 Documentation</h1>
      <div id="gtoc">
        <p><a href="index.html">Index</a> | <a href="all.html">View on single page</a></p>
      </div>
      <hr />
    </header>
	<div id="toc"><h2>Table Of Contents</h2><ul><li><a href="#linear_Algebra">Linear Algebra</a></li><li><a href="#instance_Functionality">Instance Functionality</a><ul><li><a href="#add">add( arg )</a></li><li><a href="#subtract">subtract( arg )</a></li><li><a href="#divide">divide( arg )</a></li><li><a href="#multiply">multiply( arg )</a></li><li><a href="#dot">dot( arg )</a></li><li><a href="#pow">pow( arg )</a></li><li><a href="#exp">exp()</a></li><li><a href="#log">log()</a></li><li><a href="#abs">abs()</a></li><li><a href="#norm">norm()</a></li><li><a href="#angle">angle( arg )</a></li></ul></li><li><a href="#static_Functionality">Static Functionality</a><ul><li><a href="#add">add( arr, arg )</a></li><li><a href="#subtract">subtract( arr, arg )</a></li><li><a href="#divide">divide( arr, arg )</a></li><li><a href="#multiply">multiply( arr, arg )</a></li><li><a href="#dot">dot( arr1, arr2 )</a></li><li><a href="#outer">outer( A, B )</a></li><li><a href="#pow">pow( arr, arg )</a></li><li><a href="#exp">exp( arr )</a></li><li><a href="#log">log( arr )</a></li><li><a href="#abs">abs( arr )</a></li><li><a href="#norm">norm( arr )</a></li><li><a href="#angle">angle( arr1, arr2 )</a></li><li><a href="#aug">aug( A, B )</a></li><li><a href="#det">det( A )</a></li><li><a href="#inv">inv( A )</a></li><li><a href="#gauss_elimination">gauss_elimination( A, B )</a></li><li><a href="#gauss_jordan">gauss_jordan( A, B )</a></li><li><a href="#lu">lu( A )</a></li><li><a href="#cholesky">cholesky( A )</a></li><li><a href="#gauss_jacobi">gauss_jacobi( A, b, x, r )</a></li><li><a href="#gauss_seidel">gauss_seidel( A, b, x, r )</a></li><li><a href="#sOR">SOR( A, b, x, r, w )</a></li><li><a href="#householder">householder( A )</a></li><li><a href="#qR">QR( A )</a></li><li><a href="#lstsq">lstsq( A, b )</a></li><li><a href="#jacobi">jacobi()</a></li><li><a href="#rungekutta">rungekutta()</a></li><li><a href="#romberg">romberg()</a></li><li><a href="#richardson">richardson()</a></li><li><a href="#simpson">simpson()</a></li><li><a href="#hermite">hermite()</a></li><li><a href="#lagrange">lagrange()</a></li><li><a href="#cubic_spline">cubic_spline()</a></li><li><a href="#gauss_quadrature">gauss_quadrature()</a></li><li><a href="#pCA">PCA()</a></li></ul></li></ul><hr /></div>
<h2 id="linear_Algebra">Linear Algebra</h2>

<h2 id="instance_Functionality">Instance Functionality</h2>

<h3 id="add">add( arg )</h3>

<p>Adds value to all entries.</p>

<pre><code>jStat([[1,2,3]]).add( 2 ) === [[3,4,5]];</code></pre>

<h3 id="subtract">subtract( arg )</h3>

<p>Subtracts all entries by value.</p>

<pre><code>jStat([[4,5,6]]).subtract( 2 ) === [[2,3,4]];</code></pre>

<h3 id="divide">divide( arg )</h3>

<p>Divides all entries by value.</p>

<pre><code>jStat([[2,4,6]]).divide( 2 ) === [[1,2,3]];</code></pre>

<h3 id="multiply">multiply( arg )</h3>

<p>Multiplies all entries by value.</p>

<pre><code>jStat([[1,2,3]]).multiply( 2 ) === [[2,4,6]];</code></pre>

<h3 id="dot">dot( arg )</h3>

<p>Takes dot product.</p>

<h3 id="pow">pow( arg )</h3>

<p>Raises all entries by value.</p>

<pre><code>jStat([[1,2,3]]).pow( 2 ) === [[1,4,9]];</code></pre>

<h3 id="exp">exp()</h3>

<p>Exponentiates all entries.</p>

<pre><code>jStat([[0,1]]).exp() === [[1, 2.718281828459045]]</code></pre>

<h3 id="log">log()</h3>

<p>Returns the natural logarithm of all entries.</p>

<pre><code>jStat([[1, 2.718281828459045]]).log() === [[0,1]];</code></pre>

<h3 id="abs">abs()</h3>

<p>Returns the absolute values of all entries.</p>

<pre><code>jStat([[1,-2,-3]]).abs() === [[1,2,3]];</code></pre>

<h3 id="norm">norm()</h3>

<p>Computes the norm of a vector. Note that if a matrix is passed, then the
first row of the matrix will be used as a vector for <code>norm()</code>.</p>

<h3 id="angle">angle( arg )</h3>

<p>Computes the angle between two vectors. Note that if a matrix is passed, then
the first row of the matrix will be used as the vector for <code>angle()</code>.</p>

<h2 id="static_Functionality">Static Functionality</h2>

<h3 id="add">add( arr, arg )</h3>

<p>Adds <code>arg</code> to all entries of <code>arr</code> array.</p>

<h3 id="subtract">subtract( arr, arg )</h3>

<p>Subtracts all entries of the <code>arr</code> array by <code>arg</code>.</p>

<h3 id="divide">divide( arr, arg )</h3>

<p>Divides all entries of the <code>arr</code> array by <code>arg</code>.</p>

<h3 id="multiply">multiply( arr, arg )</h3>

<p>Multiplies all entries of the <code>arr</code> array by <code>arg</code>.</p>

<h3 id="dot">dot( arr1, arr2 )</h3>

<p>Takes the dot product of the <code>arr1</code> and <code>arr2</code> arrays.</p>

<h3 id="outer">outer( A, B )</h3>

<p>Takes the outer product of the <code>A</code> and <code>B</code> arrays.</p>

<pre><code>outer([1,2,3],[4,5,6]) === [[4,5,6],[8,10,12],[12,15,18]]</code></pre>

<h3 id="pow">pow( arr, arg )</h3>

<p>Raises all entries of the <code>arr</code> array to the power of <code>arg</code>.</p>

<h3 id="exp">exp( arr )</h3>

<p>Exponentiates all entries in the <code>arr</code> array.</p>

<h3 id="log">log( arr )</h3>

<p>Returns the natural logarithm of all entries in the <code>arr</code> array</p>

<h3 id="abs">abs( arr )</h3>

<p>Returns the absolute values of all entries in the <code>arr</code> array</p>

<h3 id="norm">norm( arr )</h3>

<p>Computes the norm of the <code>arr</code> vector.</p>

<h3 id="angle">angle( arr1, arr2 )</h3>

<p>Computes the angle between the <code>arr1</code> and <code>arr2</code> vectors.</p>

<h3 id="aug">aug( A, B )</h3>

<p>Augments matrix <code>A</code> by matrix <code>B</code>. Note that this method returns a plain matrix,
not a jStat object.</p>

<h3 id="det">det( A )</h3>

<p>Calculates the determinant of matrix <code>A</code>.</p>

<h3 id="inv">inv( A )</h3>

<p>Returns the inverse of the matrix <code>A</code>.</p>

<h3 id="gauss_elimination">gauss_elimination( A, B )</h3>

<p>Performs Gaussian Elimination on matrix <code>A</code> augmented by matrix <code>B</code>.</p>

<h3 id="gauss_jordan">gauss_jordan( A, B )</h3>

<p>Performs Gauss-Jordan Elimination on matrix <code>A</code> augmented by matrix <code>B</code>.</p>

<h3 id="lu">lu( A )</h3>

<p>Perform the LU decomposition on matrix <code>A</code>.</p>

<p><code>A</code> -&gt; <code>[L,U]</code></p>

<p>st.</p>

<p><code>A = LU</code></p>

<p><code>L</code> is lower triangular matrix.</p>

<p><code>U</code> is upper triangular matrix.</p>

<h3 id="cholesky">cholesky( A )</h3>

<p>Performs the Cholesky decomposition on matrix <code>A</code>.</p>

<p><code>A</code> -&gt; <code>T</code></p>

<p>st.</p>

<p><code>A = TT&#39;</code></p>

<p><code>T</code> is lower triangular matrix.</p>

<h3 id="gauss_jacobi">gauss_jacobi( A, b, x, r )</h3>

<p>Solves the linear system <code>Ax = b</code> using the Gauss-Jacobi method with an initial guess of <code>r</code>.</p>

<h3 id="gauss_seidel">gauss_seidel( A, b, x, r )</h3>

<p>Solves the linear system <code>Ax = b</code> using the Gauss-Seidel method with an initial guess of <code>r</code>.</p>

<h3 id="sOR">SOR( A, b, x, r, w )</h3>

<p>Solves the linear system <code>Ax = b</code> using the sucessive over-relaxation method with an initial guess of <code>r</code> and parameter <code>w</code> (omega).</p>

<h3 id="householder">householder( A )</h3>

<p>Performs the householder transformation on the matrix <code>A</code>.</p>

<h3 id="qR">QR( A )</h3>

<p>Performs the Cholesky decomposition on matrix <code>A</code>.</p>

<p><code>A</code> -&gt; <code>[Q,R]</code></p>

<p><code>Q</code> is the orthogonal matrix.</p>

<p><code>R</code> is the upper triangular.</p>

<h3 id="lstsq">lstsq( A, b )</h3>

<p>Solves least squard problem for Ax=b as QR decomposition way.</p>

<p>If <code>b</code> is of the <code>[[b1], [b2], [b3]]</code> form, the method will return an array of the <code>[[x1], [x2], [x3]]</code> form solution.</p>

<p>Otherwise, if <code>b</code> is of the  <code>[b1, b2, b3]</code> form, the method will return an array of the <code>[x1,x2,x3]</code> form solution.</p>

<h3 id="jacobi">jacobi()</h3>

<h3 id="rungekutta">rungekutta()</h3>

<h3 id="romberg">romberg()</h3>

<h3 id="richardson">richardson()</h3>

<h3 id="simpson">simpson()</h3>

<h3 id="hermite">hermite()</h3>

<h3 id="lagrange">lagrange()</h3>

<h3 id="cubic_spline">cubic_spline()</h3>

<h3 id="gauss_quadrature">gauss_quadrature()</h3>

<h3 id="pCA">PCA()</h3>
	</div>
	<script src="assets/sh_main.js"></script>
	<script src="assets/sh_javascript.min.js"></script>
	<script src="//cdn.jsdelivr.net/npm/jstat@latest/dist/jstat.min.js"></script>
	<script>highlight(undefined, undefined, 'pre');</script>
</body>
</html>