apatite/docs/Apatite/LinearAlgebra/Matrix/LupDecomposition.html

250 lines
6.2 KiB
HTML
Raw Normal View History

2019-07-10 01:18:01 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
2019-07-10 02:08:46 +00:00
<link href="../../../css/style.css" rel="stylesheet" type="text/css">
2019-07-10 01:18:01 +00:00
2019-07-10 02:08:46 +00:00
<script type="text/javascript" src="../../../js/doc.js"></script>
2019-07-10 01:18:01 +00:00
<script type="text/javascript">
2019-07-10 02:08:46 +00:00
CrystalDoc.base_path = "../../../";
2019-07-10 01:18:01 +00:00
</script>
<meta id="repository-name" content="github.com/watzon/apatite">
2019-07-10 02:08:46 +00:00
<title>Apatite::LinearAlgebra::Matrix::LupDecomposition - github.com/watzon/apatite</title>
2019-07-10 01:18:01 +00:00
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
2019-07-10 02:08:46 +00:00
<a href="../../../index.html">README</a>
2019-07-10 01:18:01 +00:00
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/apatite/Apatite" data-name="apatite">
2019-07-10 02:08:46 +00:00
<a href="../../../Apatite.html">Apatite</a>
2019-07-10 01:18:01 +00:00
<ul>
2019-07-10 02:08:46 +00:00
<li class="parent open current" data-id="github.com/watzon/apatite/Apatite/LinearAlgebra" data-name="apatite::linearalgebra">
<a href="../../../Apatite/LinearAlgebra.html">LinearAlgebra</a>
2019-07-10 01:18:01 +00:00
<ul>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ErrDimensionMismatch" data-name="apatite::linearalgebra::errdimensionmismatch">
2019-07-10 02:08:46 +00:00
<a href="../../../Apatite/LinearAlgebra/ErrDimensionMismatch.html">ErrDimensionMismatch</a>
2019-07-10 01:18:01 +00:00
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ErrNotRegular" data-name="apatite::linearalgebra::errnotregular">
2019-07-10 02:08:46 +00:00
<a href="../../../Apatite/LinearAlgebra/ErrNotRegular.html">ErrNotRegular</a>
2019-07-10 01:18:01 +00:00
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ErrOperationNotDefined" data-name="apatite::linearalgebra::erroperationnotdefined">
2019-07-10 02:08:46 +00:00
<a href="../../../Apatite/LinearAlgebra/ErrOperationNotDefined.html">ErrOperationNotDefined</a>
2019-07-10 01:18:01 +00:00
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Error" data-name="apatite::linearalgebra::error">
2019-07-10 02:08:46 +00:00
<a href="../../../Apatite/LinearAlgebra/Error.html">Error</a>
2019-07-10 01:18:01 +00:00
</li>
2019-07-10 02:08:46 +00:00
<li class="parent open current" data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix" data-name="apatite::linearalgebra::matrix(t)">
<a href="../../../Apatite/LinearAlgebra/Matrix.html">Matrix</a>
2019-07-10 01:18:01 +00:00
2019-07-10 02:08:46 +00:00
<ul>
2019-07-10 01:18:01 +00:00
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix/EigenvalueDecomposition" data-name="apatite::linearalgebra::matrix::eigenvaluedecomposition">
<a href="../../../Apatite/LinearAlgebra/Matrix/EigenvalueDecomposition.html">EigenvalueDecomposition</a>
2019-07-10 01:18:01 +00:00
</li>
2019-07-10 02:08:46 +00:00
<li class=" current" data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix/LupDecomposition" data-name="apatite::linearalgebra::matrix::lupdecomposition">
<a href="../../../Apatite/LinearAlgebra/Matrix/LupDecomposition.html">LupDecomposition</a>
2019-07-10 01:18:01 +00:00
</li>
</ul>
</li>
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/NDArray" data-name="apatite::linearalgebra::ndarray">
<a href="../../../Apatite/LinearAlgebra/NDArray.html">NDArray</a>
2019-07-10 01:18:01 +00:00
2019-07-10 02:08:46 +00:00
</li>
2019-07-10 01:18:01 +00:00
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Vector" data-name="apatite::linearalgebra::vector(t)">
<a href="../../../Apatite/LinearAlgebra/Vector.html">Vector</a>
2019-07-10 01:18:01 +00:00
</li>
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ZeroVectorError" data-name="apatite::linearalgebra::zerovectorerror">
<a href="../../../Apatite/LinearAlgebra/ZeroVectorError.html">ZeroVectorError</a>
2019-07-10 01:18:01 +00:00
</li>
</ul>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/apatite/Array" data-name="array(t)">
2019-07-10 02:08:46 +00:00
<a href="../../../Array.html">Array</a>
2019-07-10 01:18:01 +00:00
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
2019-07-10 02:08:46 +00:00
<span class="kind">class</span> Apatite::LinearAlgebra::Matrix::LupDecomposition
2019-07-10 01:18:01 +00:00
</h1>
2019-07-10 02:08:46 +00:00
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../../Apatite/LinearAlgebra/Matrix/LupDecomposition.html">Apatite::LinearAlgebra::Matrix::LupDecomposition</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
2019-07-10 01:18:01 +00:00
<h2>Overview</h2>
<p>For an m-by-n matrix A with m >= n, the LU decomposition is an m-by-n
unit lower triangular matrix L, an n-by-n upper triangular matrix U,
and a m-by-m permutation matrix P so that L<em>U = P</em>A.
If m &lt; n, then L is m-by-m and U is m-by-n.</p>
<p>The LUP decomposition with pivoting always exists, even if the matrix is
singular, so the constructor will never fail. The primary use of the
LU decomposition is in the solution of square systems of simultaneous
linear equations. This will fail if singular? returns true.</p>
<h2>Defined in:</h2>
2019-07-10 02:45:49 +00:00
<a href="https://github.com/watzon/apatite/blob/fd6da99f9d1de3a90a6315a813fcb7206a053d9a/src/apatite/linear_algebra/matrix/lup_decomposition.cr#L12" target="_blank">
2019-07-10 01:18:01 +00:00
apatite/linear_algebra/matrix/lup_decomposition.cr
</a>
<br/>
<h2>Constructors</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new%28matrix%29-class-method" class="signature"><strong>.new</strong>(matrix)</a>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Constructor Detail</h2>
<div class="entry-detail" id="new(matrix)-class-method">
<div class="signature">
def self.<strong>new</strong>(matrix)
<a class="method-permalink" href="#new%28matrix%29-class-method">#</a>
</div>
<br/>
<div>
2019-07-10 02:45:49 +00:00
[<a href="https://github.com/watzon/apatite/blob/fd6da99f9d1de3a90a6315a813fcb7206a053d9a/src/apatite/linear_algebra/matrix/lup_decomposition.cr#L13" target="_blank">View source</a>]
2019-07-10 01:18:01 +00:00
</div>
</div>
</div>
</body>
</html>