HEX
Server: Apache
System: Windows NT MAGNETO-ARM 10.0 build 22000 (Windows 10) AMD64
User: Michel (0)
PHP: 7.4.7
Disabled: NONE
Upload Files
File: C:/Ruby27-x64/share/doc/ruby/html/LUSolve.html
<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>module LUSolve - RDoc Documentation</title>

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
  var index_rel_prefix = "./";
</script>

<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>

<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">




<body id="top" role="document" class="module">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="./index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="./table_of_contents.html#pages">Pages</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    
    
    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li ><a href="#method-i-ludecomp">#ludecomp</a>
    
    <li ><a href="#method-i-lusolve">#lusolve</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="module-LUSolve">
  <h1 id="module-LUSolve" class="module">
    module LUSolve
  </h1>

  <section class="description">
    
<p>Solves a*x = b for x, using LU decomposition.</p>

  </section>

  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Instance Methods</h3>
       </header>

    
      <div id="method-i-ludecomp" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">ludecomp</span><span
            class="method-args">(a,n,zero=0,one=1)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Performs LU decomposition of the n by n matrix a.</p>
          
          

          
          <div class="method-source-code" id="ludecomp-source">
            <pre><span class="ruby-comment"># File ext/bigdecimal/lib/bigdecimal/ludcmp.rb, line 11</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ludecomp</span>(<span class="ruby-identifier">a</span>,<span class="ruby-identifier">n</span>,<span class="ruby-identifier">zero</span>=<span class="ruby-value">0</span>,<span class="ruby-identifier">one</span>=<span class="ruby-value">1</span>)
  <span class="ruby-identifier">prec</span> = <span class="ruby-constant">BigDecimal</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-keyword">nil</span>)
  <span class="ruby-identifier">ps</span>     = []
  <span class="ruby-identifier">scales</span> = []
  <span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> <span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span>  <span class="ruby-comment"># pick up largest(abs. val.) element in each row.</span>
    <span class="ruby-identifier">ps</span> <span class="ruby-operator">&lt;&lt;=</span> <span class="ruby-identifier">i</span>
    <span class="ruby-identifier">nrmrow</span>  = <span class="ruby-identifier">zero</span>
    <span class="ruby-identifier">ixn</span> = <span class="ruby-identifier">i</span><span class="ruby-operator">*</span><span class="ruby-identifier">n</span>
    <span class="ruby-keyword">for</span> <span class="ruby-identifier">j</span> <span class="ruby-keyword">in</span> <span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span>
      <span class="ruby-identifier">biggst</span> = <span class="ruby-identifier">a</span>[<span class="ruby-identifier">ixn</span><span class="ruby-operator">+</span><span class="ruby-identifier">j</span>].<span class="ruby-identifier">abs</span>
      <span class="ruby-identifier">nrmrow</span> = <span class="ruby-identifier">biggst</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">biggst</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">nrmrow</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">nrmrow</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">zero</span> <span class="ruby-keyword">then</span>
      <span class="ruby-identifier">scales</span> <span class="ruby-operator">&lt;&lt;=</span> <span class="ruby-identifier">one</span>.<span class="ruby-identifier">div</span>(<span class="ruby-identifier">nrmrow</span>,<span class="ruby-identifier">prec</span>)
    <span class="ruby-keyword">else</span>
      <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Singular matrix&quot;</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">n1</span>          = <span class="ruby-identifier">n</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
  <span class="ruby-keyword">for</span> <span class="ruby-identifier">k</span> <span class="ruby-keyword">in</span> <span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n1</span> <span class="ruby-keyword">do</span> <span class="ruby-comment"># Gaussian elimination with partial pivoting.</span>
    <span class="ruby-identifier">biggst</span>  = <span class="ruby-identifier">zero</span>;
    <span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">k</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span>
      <span class="ruby-identifier">size</span> = <span class="ruby-identifier">a</span>[<span class="ruby-identifier">ps</span>[<span class="ruby-identifier">i</span>]<span class="ruby-operator">*</span><span class="ruby-identifier">n</span><span class="ruby-operator">+</span><span class="ruby-identifier">k</span>].<span class="ruby-identifier">abs</span><span class="ruby-operator">*</span><span class="ruby-identifier">scales</span>[<span class="ruby-identifier">ps</span>[<span class="ruby-identifier">i</span>]]
      <span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">biggst</span> <span class="ruby-keyword">then</span>
        <span class="ruby-identifier">biggst</span> = <span class="ruby-identifier">size</span>
        <span class="ruby-identifier">pividx</span>  = <span class="ruby-identifier">i</span>
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Singular matrix&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">biggst</span><span class="ruby-operator">&lt;=</span><span class="ruby-identifier">zero</span>
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">pividx</span><span class="ruby-operator">!=</span><span class="ruby-identifier">k</span> <span class="ruby-keyword">then</span>
      <span class="ruby-identifier">j</span> = <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">k</span>]
      <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">pividx</span>]
      <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">pividx</span>] = <span class="ruby-identifier">j</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">pivot</span>   = <span class="ruby-identifier">a</span>[<span class="ruby-identifier">ps</span>[<span class="ruby-identifier">k</span>]<span class="ruby-operator">*</span><span class="ruby-identifier">n</span><span class="ruby-operator">+</span><span class="ruby-identifier">k</span>]
    <span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> (<span class="ruby-identifier">k</span><span class="ruby-value">+1</span>)<span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span>
      <span class="ruby-identifier">psin</span> = <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">i</span>]<span class="ruby-operator">*</span><span class="ruby-identifier">n</span>
      <span class="ruby-identifier">a</span>[<span class="ruby-identifier">psin</span><span class="ruby-operator">+</span><span class="ruby-identifier">k</span>] = <span class="ruby-identifier">mult</span> = <span class="ruby-identifier">a</span>[<span class="ruby-identifier">psin</span><span class="ruby-operator">+</span><span class="ruby-identifier">k</span>].<span class="ruby-identifier">div</span>(<span class="ruby-identifier">pivot</span>,<span class="ruby-identifier">prec</span>)
      <span class="ruby-keyword">if</span> <span class="ruby-identifier">mult</span><span class="ruby-operator">!=</span><span class="ruby-identifier">zero</span> <span class="ruby-keyword">then</span>
        <span class="ruby-identifier">pskn</span> = <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">k</span>]<span class="ruby-operator">*</span><span class="ruby-identifier">n</span>
        <span class="ruby-keyword">for</span> <span class="ruby-identifier">j</span> <span class="ruby-keyword">in</span> (<span class="ruby-identifier">k</span><span class="ruby-value">+1</span>)<span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span>
          <span class="ruby-identifier">a</span>[<span class="ruby-identifier">psin</span><span class="ruby-operator">+</span><span class="ruby-identifier">j</span>] <span class="ruby-operator">-=</span> <span class="ruby-identifier">mult</span>.<span class="ruby-identifier">mult</span>(<span class="ruby-identifier">a</span>[<span class="ruby-identifier">pskn</span><span class="ruby-operator">+</span><span class="ruby-identifier">j</span>],<span class="ruby-identifier">prec</span>)
        <span class="ruby-keyword">end</span>
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Singular matrix&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">a</span>[<span class="ruby-identifier">ps</span>[<span class="ruby-identifier">n1</span>]<span class="ruby-operator">*</span><span class="ruby-identifier">n</span><span class="ruby-operator">+</span><span class="ruby-identifier">n1</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">zero</span>
  <span class="ruby-identifier">ps</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-lusolve" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">lusolve</span><span
            class="method-args">(a,b,ps,zero=0.0)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Solves a*x = b for x, using LU decomposition.</p>

<p>a is a matrix, b is a constant vector, x is the solution vector.</p>

<p>ps is the pivot, a vector which indicates the permutation of rows performed during LU decomposition.</p>
          
          

          
          <div class="method-source-code" id="lusolve-source">
            <pre><span class="ruby-comment"># File ext/bigdecimal/lib/bigdecimal/ludcmp.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">lusolve</span>(<span class="ruby-identifier">a</span>,<span class="ruby-identifier">b</span>,<span class="ruby-identifier">ps</span>,<span class="ruby-identifier">zero</span>=<span class="ruby-value">0.0</span>)
  <span class="ruby-identifier">prec</span> = <span class="ruby-constant">BigDecimal</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-keyword">nil</span>)
  <span class="ruby-identifier">n</span> = <span class="ruby-identifier">ps</span>.<span class="ruby-identifier">size</span>
  <span class="ruby-identifier">x</span> = []
  <span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> <span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span>
    <span class="ruby-identifier">dot</span> = <span class="ruby-identifier">zero</span>
    <span class="ruby-identifier">psin</span> = <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">i</span>]<span class="ruby-operator">*</span><span class="ruby-identifier">n</span>
    <span class="ruby-keyword">for</span> <span class="ruby-identifier">j</span> <span class="ruby-keyword">in</span> <span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">i</span> <span class="ruby-keyword">do</span>
      <span class="ruby-identifier">dot</span> = <span class="ruby-identifier">a</span>[<span class="ruby-identifier">psin</span><span class="ruby-operator">+</span><span class="ruby-identifier">j</span>].<span class="ruby-identifier">mult</span>(<span class="ruby-identifier">x</span>[<span class="ruby-identifier">j</span>],<span class="ruby-identifier">prec</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">dot</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">x</span> <span class="ruby-operator">&lt;&lt;=</span> <span class="ruby-identifier">b</span>[<span class="ruby-identifier">ps</span>[<span class="ruby-identifier">i</span>]] <span class="ruby-operator">-</span> <span class="ruby-identifier">dot</span>
  <span class="ruby-keyword">end</span>
  (<span class="ruby-identifier">n</span><span class="ruby-value">-1</span>).<span class="ruby-identifier">downto</span>(<span class="ruby-value">0</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">dot</span> = <span class="ruby-identifier">zero</span>
    <span class="ruby-identifier">psin</span> = <span class="ruby-identifier">ps</span>[<span class="ruby-identifier">i</span>]<span class="ruby-operator">*</span><span class="ruby-identifier">n</span>
    <span class="ruby-keyword">for</span> <span class="ruby-identifier">j</span> <span class="ruby-keyword">in</span> (<span class="ruby-identifier">i</span><span class="ruby-value">+1</span>)<span class="ruby-operator">...</span><span class="ruby-identifier">n</span> <span class="ruby-keyword">do</span>
      <span class="ruby-identifier">dot</span> = <span class="ruby-identifier">a</span>[<span class="ruby-identifier">psin</span><span class="ruby-operator">+</span><span class="ruby-identifier">j</span>].<span class="ruby-identifier">mult</span>(<span class="ruby-identifier">x</span>[<span class="ruby-identifier">j</span>],<span class="ruby-identifier">prec</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">dot</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">x</span>[<span class="ruby-identifier">i</span>]  = (<span class="ruby-identifier">x</span>[<span class="ruby-identifier">i</span>]<span class="ruby-operator">-</span><span class="ruby-identifier">dot</span>).<span class="ruby-identifier">div</span>(<span class="ruby-identifier">a</span>[<span class="ruby-identifier">psin</span><span class="ruby-operator">+</span><span class="ruby-identifier">i</span>],<span class="ruby-identifier">prec</span>)
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">x</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>

</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>