<?xml-stylesheet type="text/xsl" href="../styles/pmathml.xsl"?>
<!-- saved from url=(0014)about:internet -->
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:dsi="http://www.w3.org/1999/xlink" xmlns:m="http://www.w3.org/1998/Math/MathML" xml:space="preserve"><head><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><title>F01LEF : NAG Library, Mark 22</title><link rel="stylesheet" href="../styles/libdoc.css" type="text/css"/><script type="text/javascript">
   function showLevel(_levelId){
    var thisLevel = document.getElementById(_levelId);
    var thisplus = document.getElementById( _levelId.concat('plus'));
    var thisminus = document.getElementById( _levelId.concat('minus'));
    if(thisLevel.style.display != "block"){
     thisLevel.style.display = "block";
     thisplus.style.display = "none";
     thisminus.style.display = "inline";
     }
    else{
     thisLevel.style.display = "none";
     thisminus.style.display = "none";
     thisplus.style.display = "inline";
     }
    }
  </script></head><body><hr/><div><a class="rout" href="../../pdf/F01/f01lef.pdf">F01LEF (PDF version)</a></div><div><a class="chap" href="f01conts.xml">F01 Chapter Contents</a></div><div><a class="chapint" href="f01intro.xml">F01 Chapter Introduction</a></div>
<div><a class="htmltoc" href="../FRONTMATTER/manconts.xml">NAG Library Manual</a></div><hr/><h1 class="libdoc">NAG Library Routine Document<br/><br/>F01LEF</h1><div class="paramtext"><div class="header"><b>Note:</b>&#160; before using this routine, please read the Users' Note for your implementation to check the interpretation of <span class="bitalic">bold italicised</span> terms and other implementation-dependent details.</div></div> 
<div class="htmltoc">
<h2 class="htmltoc"><span class="htmltochead" onclick="showLevel('htmltoc');"><span class="htmltocplus" id="htmltocplus">+</span><span class="htmltocminus" id="htmltocminus">&#8722;</span></span>&#160;Contents</h2>
<div class="htmltocitem" id="htmltoc">
<div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#purpose">1&#160;&#160;<b>Purpose</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#specification">2&#160;&#160;<b>Specification</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#description">3&#160;&#160;<b>Description</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#references">4&#160;&#160;<b>References</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#parameters">5&#160;&#160;<b>Parameters</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#errors">6&#160;&#160;<b>Error Indicators and Warnings</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#accuracy">7&#160;&#160;<b>Accuracy</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#fcomments">8&#160;&#160;<b>Further Comments</b></a>
</div><div class="htmltoc">
<span class="htmltoc" onclick="showLevel('tocexample');"><span class="htmltocplus" id="tocexampleplus">+</span><span class="htmltocminus" id="tocexampleminus">&#8722;</span></span>
<a class="htmltoc" href="#example">9&#160;&#160;<b>Example</b></a>
<div class="htmltocitem" id="tocexample">
<div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#examtext">9.1&#160;&#160;<b>Program Text</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#examdata">9.2&#160;&#160;<b>Program Data</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#examresults">9.3&#160;&#160;<b>Program Results</b></a>
</div>
</div>
</div>
</div>
</div><h2 class="standard"><a class="sec" name="purpose" id="purpose"/>1&#160;&#160;Purpose</h2>
<div class="paramtext">F01LEF computes an <m:math><m:mi>L</m:mi><m:mi>U</m:mi></m:math>&#160;factorization of a real tridiagonal matrix, using Gaussian elimination with partial pivoting.</div><h2 class="standard"><a class="sec" name="specification" id="specification"/>2&#160;&#160;Specification</h2>
<table class="fspec"><tr><td class="tdfspec1">SUBROUTINE&#160;F01LEF&#160;(</td><td class="tdfspec2"><a class="arg" href="#N">N</a>, <a class="arg" href="#A">A</a>, <a class="arg" href="#LAMBDA">LAMBDA</a>, <a class="arg" href="#B">B</a>, <a class="arg" href="#C">C</a>, <a class="arg" href="#TOL">TOL</a>, <a class="arg" href="#D">D</a>, <a class="arg" href="#IPIV">IPIV</a>, <a class="arg" href="#IFAIL">IFAIL</a>)</td></tr><tr><td class="tdfspec1">INTEGER</td><td class="tdfspec2">N, IPIV(N), IFAIL</td></tr><tr><td class="tdfspec1"><b><i>double&#160;precision</i></b></td><td class="tdfspec2">A(N), LAMBDA, B(N), C(N), TOL, D(N)</td></tr></table><h2 class="standard"><a class="sec" name="description" id="description"/>3&#160;&#160;Description</h2>
<div class="paramtext">The matrix <m:math><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:math>, where <m:math><m:mi>T</m:mi></m:math>&#160;is a real  <m:math><m:mi>n</m:mi></m:math>&#160;by <m:math><m:mi>n</m:mi></m:math>&#160;tridiagonal matrix, is factorized as

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
<m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi><m:mo>=</m:mo><m:mi>P</m:mi><m:mi>L</m:mi><m:mi>U</m:mi><m:mtext>,</m:mtext>
</m:math></td><td class="formula2"/></tr></table></div>

where <m:math><m:mi>P</m:mi></m:math>&#160;is a permutation matrix, <m:math><m:mi>L</m:mi></m:math>&#160;is a unit lower triangular matrix with at most one nonzero subdiagonal element per column, and <m:math><m:mi>U</m:mi></m:math>&#160;is an upper triangular matrix with at most two nonzero superdiagonal elements per column.</div><div class="paramtext">The factorization is obtained by Gaussian elimination with partial pivoting and implicit row scaling.</div><div class="paramtext">An indication of whether or not the matrix <m:math><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:math>&#160;is nearly singular is returned in the <m:math><m:mi>n</m:mi></m:math>th element of the array  <a class="arg" href="#IPIV">IPIV</a>.  If it is important that <m:math><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:math>&#160;is nonsingular,  as is usually the case when solving a system of tridiagonal equations, then it is strongly recommended that <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>&#160;is inspected on return from F01LEF.  (See the parameter <a class="arg" href="#IPIV">IPIV</a> and  <a class="sec" href="#fcomments">Section 8</a> for further details.)</div><div class="paramtext">The parameter <m:math><m:mi>&#955;</m:mi></m:math>&#160;is included in the routine so that F01LEF may be used, in conjunction with  <a class="rout" href="../F04/f04lef.xml">F04LEF</a>, to obtain eigenvectors of <m:math><m:mi>T</m:mi></m:math>&#160;by inverse iteration.</div><h2 class="standard"><a class="sec" name="references" id="references"/>4&#160;&#160;References</h2><div class="paramtext"><a name="ref003" id="ref003"/>Wilkinson J H (1965)  <i>The Algebraic Eigenvalue Problem</i> Oxford University Press, Oxford </div>
<div class="paramtext"><a name="ref103" id="ref103"/>Wilkinson J H and Reinsch C (1971)  <i>Handbook for Automatic Computation II, Linear Algebra</i> Springer&#8211;Verlag </div><h2 class="standard"><a class="sec" name="parameters" id="parameters"/>5&#160;&#160;Parameters</h2>
<dl><dt class="paramhead"><a name="N" id="N"/>1: &#160;&#160;&#8194; N &#8211; INTEGER<span class="pclass">Input</span></dt><dd><div class="paramtext"><i>On entry</i>: 

<m:math><m:mi>n</m:mi></m:math>, <m:math><m:mi>n</m:mi></m:math>, the order of the matrix <m:math><m:mi>T</m:mi></m:math>.</div><div class="paramtext"><i>Constraint</i>:
  <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction><m:mo>&#8805;</m:mo><m:mn>1</m:mn></m:math>.
</div></dd><dt class="paramhead"><a name="A" id="A"/>2: &#160;&#160;&#8194; A(<a class="arg" href="#N">N</a>) &#8211; <span class="bitalic">double precision</span> array<span class="pclass">Input/Output</span></dt><dd><div class="paramtext"><i>On entry</i>: the diagonal elements of <m:math><m:mi>T</m:mi></m:math>.</div>
<div class="paramtext"><i>On exit</i>: the diagonal elements of the upper triangular matrix <m:math><m:mi>U</m:mi></m:math>.</div></dd><dt class="paramhead"><a name="LAMBDA" id="LAMBDA"/>3: &#160;&#160;&#8194; LAMBDA &#8211; <span class="bitalic">double precision</span><span class="pclass">Input</span></dt><dd><div class="paramtext"><i>On entry</i>: the scalar <m:math><m:mi>&#955;</m:mi></m:math>. F01LEF factorizes <m:math><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:math>.</div></dd><dt class="paramhead"><a name="B" id="B"/>4: &#160;&#160;&#8194; B(<a class="arg" href="#N">N</a>) &#8211; <span class="bitalic">double precision</span> array<span class="pclass">Input/Output</span></dt><dd><div class="paramtext"><i>On entry</i>: the superdiagonal elements of <m:math><m:mi>T</m:mi></m:math>, stored in <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#B"><m:mi mathcolor="#EE0000" mathvariant="bold">B</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>2</m:mn></m:mfenced></m:mrow></m:math>&#160;to <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#B"><m:mi mathcolor="#EE0000" mathvariant="bold">B</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>; <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#B"><m:mi mathcolor="#EE0000" mathvariant="bold">B</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>1</m:mn></m:mfenced></m:mrow></m:math>&#160;is not used.</div>
<div class="paramtext"><i>On exit</i>: the elements of the first superdiagonal of <m:math><m:mi>U</m:mi></m:math>, stored in <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#B"><m:mi mathcolor="#EE0000" mathvariant="bold">B</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>2</m:mn></m:mfenced></m:mrow></m:math>&#160;to <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#B"><m:mi mathcolor="#EE0000" mathvariant="bold">B</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>.</div></dd><dt class="paramhead"><a name="C" id="C"/>5: &#160;&#160;&#8194; C(<a class="arg" href="#N">N</a>) &#8211; <span class="bitalic">double precision</span> array<span class="pclass">Input/Output</span></dt><dd><div class="paramtext"><i>On entry</i>: the subdiagonal elements of <m:math><m:mi>T</m:mi></m:math>, stored in <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#C"><m:mi mathcolor="#EE0000" mathvariant="bold">C</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>2</m:mn></m:mfenced></m:mrow></m:math>&#160;to <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#C"><m:mi mathcolor="#EE0000" mathvariant="bold">C</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>; <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#C"><m:mi mathcolor="#EE0000" mathvariant="bold">C</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>1</m:mn></m:mfenced></m:mrow></m:math>&#160;is not used.</div>
<div class="paramtext"><i>On exit</i>: the subdiagonal elements of <m:math><m:mi>L</m:mi></m:math>, stored in <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#C"><m:mi mathcolor="#EE0000" mathvariant="bold">C</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>2</m:mn></m:mfenced></m:mrow></m:math>&#160;to <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#C"><m:mi mathcolor="#EE0000" mathvariant="bold">C</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>.</div></dd><dt class="paramhead"><a name="TOL" id="TOL"/>6: &#160;&#160;&#8194; TOL &#8211; <span class="bitalic">double precision</span><span class="pclass">Input</span></dt><dd><div class="paramtext"><i>On entry</i>: a relative tolerance used to indicate whether or not the matrix (<m:math><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:math>) is nearly singular. <a class="arg" href="#TOL">TOL</a> should normally be chosen as approximately the largest relative error in the elements of <m:math><m:mi>T</m:mi></m:math>. For example, if the elements of <m:math><m:mi>T</m:mi></m:math>&#160;are correct to about <m:math><m:mn>4</m:mn></m:math>&#160;significant figures, then <a class="arg" href="#TOL">TOL</a> should be set to about <m:math><m:mn>5</m:mn><m:mo>&#215;</m:mo><m:msup><m:mn>10</m:mn><m:mrow><m:mo>-</m:mo><m:mn>4</m:mn></m:mrow></m:msup></m:math>. See <a class="sec" href="#fcomments">Section 8</a> for further details on how <a class="arg" href="#TOL">TOL</a> is used. If <a class="arg" href="#TOL">TOL</a> is supplied as less than <m:math><m:mi>&#949;</m:mi></m:math>, where <m:math><m:mi>&#949;</m:mi></m:math>&#160;is the <span class="bitalic">machine precision</span>, then the value <m:math><m:mi>&#949;</m:mi></m:math>&#160;is used in place of <a class="arg" href="#TOL">TOL</a>.</div></dd><dt class="paramhead"><a name="D" id="D"/>7: &#160;&#160;&#8194; D(<a class="arg" href="#N">N</a>) &#8211; <span class="bitalic">double precision</span> array<span class="pclass">Output</span></dt><dd><div class="paramtext"><i>On exit</i>: the elements of the second superdiagonal of <m:math><m:mi>U</m:mi></m:math>, stored in <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#D"><m:mi mathcolor="#EE0000" mathvariant="bold">D</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>3</m:mn></m:mfenced></m:mrow></m:math>&#160;to <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#D"><m:mi mathcolor="#EE0000" mathvariant="bold">D</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>; <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#D"><m:mi mathcolor="#EE0000" mathvariant="bold">D</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>1</m:mn></m:mfenced></m:mrow></m:math>&#160;and <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#D"><m:mi mathcolor="#EE0000" mathvariant="bold">D</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mn>2</m:mn></m:mfenced></m:mrow></m:math>&#160;are not used.</div></dd><dt class="paramhead"><a name="IPIV" id="IPIV"/>8: &#160;&#160;&#8194; IPIV(<a class="arg" href="#N">N</a>) &#8211; INTEGER array<span class="pclass">Output</span></dt><dd><div class="paramtext"><i>On exit</i>: details of the permutation matrix <m:math><m:mi>P</m:mi></m:math>. If an interchange occurred at the <m:math><m:mi>k</m:mi></m:math>th step of the elimination, then <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>k</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:mn>1</m:mn></m:math>, otherwise <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>k</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:mn>0</m:mn></m:math>. If a diagonal element of <m:math><m:mi>U</m:mi></m:math>&#160;is small, indicating that <m:math><m:mfenced separators=""><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:mfenced></m:math>&#160;is nearly singular, then the element <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>&#160;is returned as positive. Otherwise <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>&#160;is returned as <m:math><m:mn>0</m:mn></m:math>. See <a class="sec" href="#fcomments">Section 8</a> for further details. If the application is such that it is important that <m:math><m:mfenced separators=""><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:mfenced></m:math>&#160;is not nearly singular, then it is strongly recommended that <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>&#160;is inspected on return.</div></dd><dt class="paramhead"><a name="IFAIL" id="IFAIL"/>9: &#160;&#160;&#8194; IFAIL &#8211; INTEGER<span class="pclass">Input/Output</span></dt><dd>
<div class="paramtext"><i>On entry</i>: <a class="arg" href="#IFAIL">IFAIL</a> must be set to <m:math><m:mn>0</m:mn></m:math>, <m:math><m:mrow><m:mo>-</m:mo><m:mn>1</m:mn></m:mrow><m:mtext>&#8203; or &#8203;</m:mtext><m:mn>1</m:mn></m:math>. If you are unfamiliar with this parameter you should refer to <a class="sec" href="../GENINT/essint.xml#library3">Section 3.3</a> in  the Essential Introduction for details.</div>
<div class="paramtext"><i>On exit</i>: <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#IFAIL"><m:mi mathcolor="#EE0000" mathvariant="bold">IFAIL</m:mi></m:maction><m:mo>=</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#errors"><m:mn mathcolor="#003399" mathvariant="bold">0</m:mn></m:maction></m:math>&#160;unless the routine detects an error (see <a class="sec" href="#errors">Section 6</a>). <div class="paramtext">For environments where it might be inappropriate to halt program execution when an error is detected, the value <m:math><m:mrow><m:mo>-</m:mo><m:mn>1</m:mn></m:mrow><m:mtext>&#8203; or &#8203;</m:mtext><m:mn>1</m:mn></m:math>&#160;is recommended.  If the output of error messages is undesirable, then the value <m:math><m:mn>1</m:mn></m:math>&#160;is recommended.  Otherwise, if you are not familiar with this parameter, the recommended value is <m:math><m:mn>0</m:mn></m:math>.  <b>When the value <m:math><m:mrow><m:mo>-</m:mo><m:mn mathvariant="bold">1</m:mn></m:mrow><m:mtext>&#8203; or &#8203;</m:mtext><m:mn mathvariant="bold">1</m:mn></m:math>&#160;is used it is essential to test the value of <a class="arg" href="#IFAIL">IFAIL</a> on exit.</b></div></div></dd></dl><h2 class="standard"><a class="sec" name="errors" id="errors"/>6&#160;&#160;Error Indicators and Warnings</h2>
<div class="paramtext">If on entry <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#IFAIL"><m:mi mathcolor="#EE0000" mathvariant="bold">IFAIL</m:mi></m:maction><m:mo>=</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#errors"><m:mn mathcolor="#003399" mathvariant="bold">0</m:mn></m:maction></m:math>&#160;or <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#errors"><m:mn mathcolor="#003399" mathvariant="bold">-1</m:mn></m:maction></m:math>, explanatory error messages are output on the current error message unit (as defined by <a class="rout" href="../X04/x04aaf.xml">X04AAF</a>).</div><div class="paramtext">Errors or warnings detected by the routine:</div>
<dl class="ifail">
<dt class="errorhead"><a name="IFeq1" id="IFeq1"/><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#IFAIL"><m:mi mathcolor="#EE0000" mathvariant="bold">IFAIL</m:mi></m:maction><m:mo>=</m:mo><m:mn>1</m:mn></m:math></dt>
<dd>
<table class="ifail"><tr><td class="ifail1">On&#160;entry,</td><td class="ifail2-90"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction><m:mo>&lt;</m:mo><m:mn>1</m:mn></m:math>.</td></tr></table>
</dd>
</dl><h2 class="standard"><a class="sec" name="accuracy" id="accuracy"/>7&#160;&#160;Accuracy</h2>
<div class="paramtext">The computed factorization will satisfy the equation

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
<m:mi>P</m:mi><m:mi>L</m:mi><m:mi>U</m:mi><m:mo>=</m:mo><m:mfenced separators=""><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:mfenced><m:mo>+</m:mo><m:mi>E</m:mi><m:mtext>,</m:mtext>
</m:math></td><td class="formula2"/></tr></table></div>


where

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
<m:msub><m:mfenced open="&#8214;" close="&#8214;" separators=""><m:mi>E</m:mi></m:mfenced><m:mn>1</m:mn></m:msub><m:mo>&#8804;</m:mo> <m:mn>9</m:mn><m:mo>&#215;</m:mo><m:msub><m:mi mathvariant="normal">max</m:mi><m:mrow><m:mi>i</m:mi><m:mo>&#8805;</m:mo><m:mi>j</m:mi></m:mrow></m:msub> <m:mfenced separators=""><m:mfenced open="|" close="|" separators=""><m:msub><m:mi>l</m:mi><m:mrow><m:mi>i</m:mi><m:mi>j</m:mi></m:mrow></m:msub></m:mfenced><m:mo>,</m:mo><m:msup><m:mfenced open="|" close="|" separators=""><m:msub><m:mi>l</m:mi><m:mrow><m:mi>i</m:mi><m:mi>j</m:mi></m:mrow></m:msub></m:mfenced><m:mn>2</m:mn></m:msup></m:mfenced> <m:mi>&#949;</m:mi> <m:msub><m:mfenced open="&#8214;" close="&#8214;" separators=""><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi> <m:mi>I</m:mi></m:mfenced><m:mn>1</m:mn></m:msub>
</m:math></td><td class="formula2"/></tr></table></div>

where <m:math><m:mi>&#949;</m:mi></m:math>&#160;is the <span class="bitalic">machine precision</span>.</div><h2 class="standard"><a class="sec" name="fcomments" id="fcomments"/>8&#160;&#160;Further Comments</h2>
<div class="paramtext">The time taken by F01LEF is approximately proportional to  <m:math><m:mi>n</m:mi></m:math>.</div><div class="paramtext">The factorization of a tridiagonal matrix proceeds in <m:math><m:mfenced separators=""><m:mi>n</m:mi><m:mo>-</m:mo><m:mn>1</m:mn></m:mfenced></m:math>&#160;steps, each step eliminating one subdiagonal element of the tridiagonal matrix.  In order to avoid small pivot elements and to prevent growth in the size of the elements of <m:math><m:mi>L</m:mi></m:math>, rows <m:math><m:mi>k</m:mi></m:math>&#160;and  (<m:math><m:mi>k</m:mi><m:mo>+</m:mo><m:mn>1</m:mn></m:math>) will, if necessary, be interchanged at the  <m:math><m:mi>k</m:mi></m:math>th step prior to the elimination.</div><div class="paramtext">The element <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>&#160;returns the smallest integer,  <m:math><m:mi>j</m:mi></m:math>, for which

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
<m:mfenced open="|" close="|" separators=""><m:msub><m:mi>u</m:mi><m:mrow><m:mi>j</m:mi><m:mi>j</m:mi></m:mrow></m:msub></m:mfenced><m:mo>&#8804;</m:mo><m:msub><m:mfenced open="&#8214;" close="&#8214;" separators=""><m:msub><m:mfenced separators=""><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:mfenced><m:mi>j</m:mi></m:msub></m:mfenced><m:mn>1</m:mn></m:msub><m:mo>&#215;</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#TOL"><m:mi mathcolor="#EE0000" mathvariant="bold">TOL</m:mi></m:maction><m:mtext>,</m:mtext>
</m:math></td><td class="formula2"/></tr></table></div>

where <m:math><m:msub><m:mfenced open="&#8214;" close="&#8214;" separators=""><m:msub><m:mfenced separators=""><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:mfenced><m:mi>j</m:mi></m:msub></m:mfenced><m:mn>1</m:mn></m:msub></m:math>&#160;denotes the sum of the absolute values of the <m:math><m:mi>j</m:mi></m:math>th row of the matrix  (<m:math><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:math>).  If no such <m:math><m:mi>j</m:mi></m:math>&#160;exists,  then <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#IPIV"><m:mi mathcolor="#EE0000" mathvariant="bold">IPIV</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>n</m:mi></m:mfenced></m:mrow></m:math>&#160;is returned as zero.  If such a <m:math><m:mi>j</m:mi></m:math>&#160;exists, then <m:math><m:mfenced open="|" close="|" separators=""><m:msub><m:mi>u</m:mi><m:mrow><m:mi>j</m:mi><m:mi>j</m:mi></m:mrow></m:msub></m:mfenced></m:math>&#160;is small and hence  (<m:math><m:mi>T</m:mi><m:mo>-</m:mo><m:mi>&#955;</m:mi><m:mi>I</m:mi></m:math>) is singular or nearly singular.</div><div class="paramtext">This routine may be followed by <a class="rout" href="../F04/f04lef.xml">F04LEF</a> to solve systems of tridiagonal equations.  If you wish to solve single systems of tridiagonal equations you should be aware of <a class="rout" href="../F07/f07caf.xml">F07CAF (DGTSV)</a>, which solves tridiagonal systems with a single call.  <a class="rout" href="../F07/f07caf.xml">F07CAF (DGTSV)</a>  requires less storage and will generally be faster than the combination of F01LEF and <a class="rout" href="../F04/f04lef.xml">F04LEF</a>, but no test for near singularity is included in <a class="rout" href="../F07/f07caf.xml">F07CAF (DGTSV)</a> and so it should only be used when the equations are known to be nonsingular.</div><h2 class="standard"><a class="sec" name="example" id="example"/>9&#160;&#160;Example</h2>
<div class="paramtext">This example factorizes the tridiagonal matrix <m:math><m:mi>T</m:mi></m:math>&#160;where

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
<m:mi>T</m:mi><m:mo>=</m:mo>
 <m:mfenced><m:mtable columnalign="right">
  <m:mtr>
   <m:mtd><m:mn>3.0</m:mn></m:mtd>
   <m:mtd><m:mn>2.1</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mn>3.4</m:mn></m:mtd>
   <m:mtd><m:mn>2.3</m:mn></m:mtd>
   <m:mtd><m:mrow><m:mo>-</m:mo><m:mn>1.0</m:mn></m:mrow></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>3.6</m:mn></m:mtd>
   <m:mtd><m:mrow><m:mo>-</m:mo><m:mn>5.0</m:mn></m:mrow></m:mtd>
   <m:mtd><m:mn>1.9</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>7.0</m:mn></m:mtd>
   <m:mtd><m:mrow><m:mo>-</m:mo><m:mn>0.9</m:mn></m:mrow></m:mtd>
   <m:mtd><m:mn>8.0</m:mn></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mn>0</m:mn></m:mtd>
   <m:mtd><m:mrow><m:mo>-</m:mo><m:mn>6.0</m:mn></m:mrow></m:mtd>
   <m:mtd><m:mn>7.1</m:mn></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
</m:math></td><td class="formula2"/></tr></table></div>

and then to solve the equations <m:math><m:mi>T</m:mi><m:mi>x</m:mi><m:mo>=</m:mo><m:mi>y</m:mi></m:math>, where

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
<m:mi>y</m:mi><m:mo>=</m:mo>
<m:mfenced><m:mtable columnalign="right">
  <m:mtr>
   <m:mtd><m:mn>2.7</m:mn></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mrow><m:mo>-</m:mo><m:mn>0.5</m:mn></m:mrow></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mn>2.6</m:mn></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mn>0.6</m:mn></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd><m:mn>2.7</m:mn></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
</m:math></td><td class="formula2"/></tr></table></div>

by a call to <a class="rout" href="../F04/f04lef.xml">F04LEF</a>.  The example program sets <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#TOL"><m:mi mathcolor="#EE0000" mathvariant="bold">TOL</m:mi></m:maction><m:mo>=</m:mo><m:mn>5</m:mn><m:mo>&#215;</m:mo><m:msup><m:mn>10</m:mn><m:mrow><m:mo>-</m:mo><m:mn>5</m:mn></m:mrow></m:msup></m:math>&#160;and, of course, sets  <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LAMBDA"><m:mi mathcolor="#EE0000" mathvariant="bold">LAMBDA</m:mi></m:maction><m:mo>=</m:mo><m:mn>0</m:mn></m:math>.</div><h3 class="standard"><a class="sec" name="examtext" id="examtext"/>9.1&#160;&#160;Program Text</h3>
<p><a class="verbatimref" href="../../examples/source/f01lefe.f">Program Text (f01lefe.f)</a></p><h3 class="standard"><a class="sec" name="examdata" id="examdata"/>9.2&#160;&#160;Program Data</h3>
<p><a class="verbatimref" href="../../examples/data/f01lefe.d">Program&#160;Data (f01lefe.d)</a></p><h3 class="standard"><a class="sec" name="examresults" id="examresults"/>9.3&#160;&#160;Program Results</h3>
<p><a class="verbatimref" href="../../examples/baseresults/f01lefe.r">Program Results (f01lefe.r)</a></p>
<hr/><div><a class="rout" href="../../pdf/F01/f01lef.pdf">F01LEF (PDF version)</a></div><div><a class="chap" href="f01conts.xml">F01 Chapter Contents</a></div><div><a class="chapint" href="f01intro.xml">F01 Chapter Introduction</a></div>
<div><a class="htmltoc" href="../FRONTMATTER/manconts.xml">NAG Library Manual</a></div>
<div><hr/><a class="genint" href="../FRONTMATTER/copyright.xml">&#169; The Numerical Algorithms Group Ltd, Oxford, UK. 2009</a></div></body></html>
