<?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>F08WVF (ZGGBAL) : NAG Library, Mark 23</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/F08/f08wvf.pdf">F08WVF (ZGGBAL) (PDF version)</a></div><div><a class="chap" href="f08conts.xml">F08 Chapter Contents</a></div><div><a class="chapint" href="f08intro.xml">F08 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/>F08WVF (ZGGBAL)</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="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#example">9&#160;&#160;<b>Example</b></a>
</div>
</div>
</div><h2 class="standard"><a class="sec" name="purpose" id="purpose"/>1&#160;&#160;Purpose</h2>
<div class="paramtext">F08WVF (ZGGBAL) balances a pair of complex square matrices <m:math><m:mfenced separators=""><m:mi>A</m:mi><m:mo>,</m:mo><m:mi>B</m:mi></m:mfenced></m:math>&#160;of order <m:math><m:mi>n</m:mi></m:math>.  Balancing usually improves the accuracy of computed generalized eigenvalues and eigenvectors.</div><h2 class="standard"><a class="sec" name="specification" id="specification"/>2&#160;&#160;Specification</h2><table class="fspec"><tr><td class="tdfspec1">
<div class="left-tablediv"><table class="fspec1"><tbody>
<tr>
<td class="tdfspec1" valign="top" align="left">SUBROUTINE&#160;F08WVF&#160;(</td>
<td class="tdfspec2" valign="top" align="left"><a class="arg" href="#JOB">JOB</a>, <a class="arg" href="#N">N</a>, <a class="arg" href="#A">A</a>, <a class="arg" href="#LDA">LDA</a>, <a class="arg" href="#B">B</a>, <a class="arg" href="#LDB">LDB</a>, <a class="arg" href="#ILO">ILO</a>, <a class="arg" href="#IHI">IHI</a>, <a class="arg" href="#LSCALE">LSCALE</a>, <a class="arg" href="#RSCALE">RSCALE</a>, <a class="arg" href="#WORK">WORK</a>, <a class="arg" href="#INFO">INFO</a>)</td>
</tr>
</tbody>
</table></div>
<div class="left-tablediv"><table class="fspec3"><tbody>
<tr>
<td class="tdfspec1" valign="top" align="left">INTEGER&#160;</td>
<td class="tdfspec2" valign="top" align="left">N, LDA, LDB, ILO, IHI, INFO</td>
</tr>
<tr>
<td class="tdfspec1" valign="top" align="left">REAL&#160;(KIND=nag_wp)&#160;</td>
<td class="tdfspec2" valign="top" align="left">LSCALE(N), RSCALE(N), WORK(6*N)</td>
</tr>
<tr>
<td class="tdfspec1" valign="top" align="left">COMPLEX&#160;(KIND=nag_wp)&#160;</td>
<td class="tdfspec2" valign="top" align="left">A(LDA,*), B(LDB,*)</td>
</tr><tr>
<td class="tdfspec1" valign="top" align="left">CHARACTER(1)&#160;</td>
<td class="tdfspec2" valign="top" align="left">JOB</td></tr>
</tbody>
</table></div>
</td></tr></table>
<div class="paramtext">The routine may be called by its 
    LAPACK
    name <span class="bitalic">zggbal</span>.</div><h2 class="standard"><a class="sec" name="description" id="description"/>3&#160;&#160;Description</h2>
<div class="paramtext">Balancing may reduce the <m:math><m:mn>1</m:mn></m:math>-norm of the matrices and improve the accuracy of the computed eigenvalues and eigenvectors in the complex generalized eigenvalue problem

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
 <m:mi>A</m:mi><m:mi>x</m:mi><m:mo>=</m:mo><m:mi>&#955;</m:mi><m:mi>B</m:mi><m:mi>x</m:mi><m:mtext>.</m:mtext>
</m:math></td><td class="formula2"/></tr></table></div>

F08WVF (ZGGBAL) is usually the first step in the solution of the above generalized eigenvalue problem.  Balancing is optional but it is highly recommended.</div><div class="paramtext">The term &#8216;balancing&#8217; covers two steps, each of which involves similarity transformations on <m:math><m:mi>A</m:mi></m:math>&#160;and <m:math><m:mi>B</m:mi></m:math>.  The routine can perform either or both of these steps.  Both steps are optional.
<ol class="listnumber"><li class="listnumber">The routine first attempts to permute <m:math><m:mi>A</m:mi></m:math>&#160;and <m:math><m:mi>B</m:mi></m:math>&#160;to block upper triangular form by a similarity transformation:

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
 <m:mi>P</m:mi><m:mi>A</m:mi><m:msup><m:mi>P</m:mi><m:mi mathvariant="normal">T</m:mi></m:msup><m:mo>=</m:mo><m:mi>F</m:mi><m:mo>=</m:mo> <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>11</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>12</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>13</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>22</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>23</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>33</m:mn></m:msub></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
</m:math></td><td class="formula2"/></tr></table></div><div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
 <m:mi>P</m:mi><m:mi>B</m:mi><m:msup><m:mi>P</m:mi><m:mi mathvariant="normal">T</m:mi></m:msup><m:mo>=</m:mo><m:mi>G</m:mi><m:mo>=</m:mo> <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>11</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>12</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>13</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>22</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>23</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>33</m:mn></m:msub></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
</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:msub><m:mi>F</m:mi><m:mn>11</m:mn></m:msub></m:math>, <m:math><m:msub><m:mi>F</m:mi><m:mn>33</m:mn></m:msub></m:math>, <m:math><m:msub><m:mi>G</m:mi><m:mn>11</m:mn></m:msub></m:math>&#160;and <m:math><m:msub><m:mi>G</m:mi><m:mn>33</m:mn></m:msub></m:math>&#160;are upper triangular.  Then the diagonal elements of the matrix pairs <m:math><m:mfenced separators=""><m:msub><m:mi>F</m:mi><m:mn>11</m:mn></m:msub><m:mo>,</m:mo><m:msub><m:mi>G</m:mi><m:mn>11</m:mn></m:msub></m:mfenced></m:math>&#160;and <m:math><m:mfenced separators=""><m:msub><m:mi>F</m:mi><m:mn>33</m:mn></m:msub><m:mo>,</m:mo><m:msub><m:mi>G</m:mi><m:mn>33</m:mn></m:msub></m:mfenced></m:math>&#160;are generalized eigenvalues of <m:math><m:mfenced separators=""><m:mi>A</m:mi><m:mo>,</m:mo><m:mi>B</m:mi></m:mfenced></m:math>.  The rest of the generalized eigenvalues are given by the matrix pair <m:math><m:mfenced separators=""><m:msub><m:mi>F</m:mi><m:mn>22</m:mn></m:msub><m:mo>,</m:mo><m:msub><m:mi>G</m:mi><m:mn>22</m:mn></m:msub></m:mfenced></m:math>&#160;which are in rows and columns <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub></m:math>&#160;to <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub></m:math>.  Subsequent operations to compute the generalized eigenvalues of <m:math><m:mfenced separators=""><m:mi>A</m:mi><m:mo>,</m:mo><m:mi>B</m:mi></m:mfenced></m:math>&#160;need only be applied to the matrix pair <m:math><m:mfenced separators=""><m:msub><m:mi>F</m:mi><m:mn>22</m:mn></m:msub><m:mo>,</m:mo><m:msub><m:mi>G</m:mi><m:mn>22</m:mn></m:msub></m:mfenced></m:math>; this can save a significant amount of work if <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>&gt;</m:mo><m:mn>1</m:mn></m:math>&#160;and <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>&lt;</m:mo><m:mi>n</m:mi></m:math>.  If no suitable permutation exists (as is often the case), the routine sets <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>=</m:mo><m:mn>1</m:mn></m:math>&#160;and <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>=</m:mo><m:mi>n</m:mi></m:math>.</li><li class="listnumber">The routine applies a diagonal similarity transformation to <m:math><m:mfenced separators=""><m:mi>F</m:mi><m:mo>,</m:mo><m:mi>G</m:mi></m:mfenced></m:math>, to make the rows and columns of <m:math><m:mfenced separators=""><m:msub><m:mi>F</m:mi><m:mn>22</m:mn></m:msub><m:mo>,</m:mo><m:msub><m:mi>G</m:mi><m:mn>22</m:mn></m:msub></m:mfenced></m:math>&#160;as close in norm as possible:

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
 <m:mi>D</m:mi><m:mi>F</m:mi><m:mover><m:mi>D</m:mi><m:mo>^</m:mo></m:mover><m:mo>=</m:mo> <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:mi>I</m:mi></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:msub><m:mi>D</m:mi><m:mn>22</m:mn></m:msub></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:mi>I</m:mi></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
 <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>11</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>12</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>13</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>22</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>23</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>F</m:mi><m:mn>33</m:mn></m:msub></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
 <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:mi>I</m:mi></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:msub><m:mover><m:mi>D</m:mi><m:mo>^</m:mo></m:mover><m:mn>22</m:mn></m:msub></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:mi>I</m:mi></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
</m:math></td><td class="formula2"/></tr></table></div><div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
 <m:mi>D</m:mi><m:mi>G</m:mi><m:msup><m:mi>D</m:mi><m:mrow><m:mo>-</m:mo><m:mn>1</m:mn></m:mrow></m:msup><m:mo>=</m:mo> <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:mi>I</m:mi></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:msub><m:mi>D</m:mi><m:mn>22</m:mn></m:msub></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:mi>I</m:mi></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
 <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>11</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>12</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>13</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>22</m:mn></m:msub></m:mtd>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>23</m:mn></m:msub></m:mtd>
  </m:mtr><m:mtr>
   <m:mtd/>
   <m:mtd/>
   <m:mtd><m:msub><m:mi>G</m:mi><m:mn>33</m:mn></m:msub></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
 <m:mfenced><m:mtable>
  <m:mtr>
   <m:mtd><m:mi>I</m:mi></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:msub><m:mover><m:mi>D</m:mi><m:mo>^</m:mo></m:mover><m:mn>22</m:mn></m:msub></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:mi>I</m:mi></m:mtd>
  </m:mtr>
 </m:mtable></m:mfenced>
</m:math></td><td class="formula2"/></tr></table></div>
 This transformation usually improves the accuracy of computed generalized eigenvalues and eigenvectors.</li></ol>
</div><h2 class="standard"><a class="sec" name="references" id="references"/>4&#160;&#160;References</h2><div class="paramtext"><a name="ref707" id="ref707"/>Ward R C (1981)  Balancing the generalized eigenvalue problem <i>SIAM J. Sci. Stat. Comp.</i> <b>2</b> 141&#8211;152 </div><h2 class="standard"><a class="sec" name="parameters" id="parameters"/>5&#160;&#160;Parameters</h2>
<dl><dt class="paramhead"><a name="JOB" id="JOB"/>1: &#160;&#160;&#8194; JOB &#8211; CHARACTER(1)<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</i>: specifies the operations to be performed on matrices <m:math><m:mi>A</m:mi></m:math>&#160;and <m:math><m:mi>B</m:mi></m:math>.

<dl>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math></dt>
<dd>No balancing is done. Initialize <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#ILO"><m:mi mathcolor="#EE0000" mathvariant="bold">ILO</m:mi></m:maction><m:mo>=</m:mo><m:mn>1</m:mn></m:math>, <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#IHI"><m:mi mathcolor="#EE0000" mathvariant="bold">IHI</m:mi></m:maction><m:mo>=</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction></m:math>, <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#LSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">LSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">i</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:mn>1.0</m:mn></m:math>&#160;and <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#RSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">RSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">i</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:mn>1.0</m:mn></m:math>, for <m:math><m:mi mathvariant="italic">i</m:mi><m:mo>=</m:mo><m:mn>1</m:mn><m:mo>,</m:mo><m:mn>2</m:mn><m:mo>,</m:mo><m:mo>&#8230;</m:mo><m:mo>,</m:mo><m:mi>n</m:mi></m:math>.</dd>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'P'</m:mtext></m:math></dt>
<dd>Only permutations are used in balancing.</dd>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'S'</m:mtext></m:math></dt>
<dd>Only scalings are are used in balancing.</dd>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'B'</m:mtext></m:math></dt>
<dd>Both permutations and scalings are used in balancing.</dd></dl>
</div><div class="paramtext"><i>Constraint</i>:
  <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <m:math><m:mtext>'P'</m:mtext></m:math>, <m:math><m:mtext>'S'</m:mtext></m:math>&#160;or <m:math><m:mtext>'B'</m:mtext></m:math>.
</div>
</dd><dt class="paramhead"><a name="N" id="N"/>2: &#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>, the order of the matrices <m:math><m:mi>A</m:mi></m:math>&#160;and <m:math><m:mi>B</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>0</m:mn></m:math>.
</div>
</dd><dt class="paramhead"><a name="A" id="A"/>3: &#160;&#160;&#8194; A(<a class="arg" href="#LDA">LDA</a>,<m:math><m:mo>*</m:mo></m:math>) &#8211; COMPLEX&#160;(KIND=nag_wp)&#160;array<span class="pclass">Input/Output</span></dt><dd>
<div class="paramtext"><b>Note:</b> the second dimension of the array <a class="arg" href="#A">A</a>
must be at least
<m:math><m:mrow><m:mi>max</m:mi><m:mspace width="0.125em"/><m:mfenced separators=""><m:mn>1</m:mn><m:mo>,</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction></m:mfenced></m:mrow></m:math>.</div>
<div class="paramtext"><i>On entry</i>: the <m:math><m:mi>n</m:mi></m:math>&#160;by <m:math><m:mi>n</m:mi></m:math>&#160;matrix <m:math><m:mi>A</m:mi></m:math>.</div>
<div class="paramtext"><i>On exit</i>: <a class="arg" href="#A">A</a> is overwritten by the balanced matrix. If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <a class="arg" href="#A">A</a> is not referenced.</div></dd><dt class="paramhead"><a name="LDA" id="LDA"/>4: &#160;&#160;&#8194; LDA &#8211; INTEGER<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</i>: the first dimension of the array <a class="arg" href="#A">A</a> as declared in the (sub)program from which F08WVF (ZGGBAL) is called.</div><div class="paramtext"><i>Constraint</i>:
  <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LDA"><m:mi mathcolor="#EE0000" mathvariant="bold">LDA</m:mi></m:maction><m:mo>&#8805;</m:mo><m:mrow><m:mi>max</m:mi><m:mspace width="0.125em"/><m:mfenced separators=""><m:mn>1</m:mn><m:mo>,</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction></m:mfenced></m:mrow></m:math>.
</div>
</dd><dt class="paramhead"><a name="B" id="B"/>5: &#160;&#160;&#8194; B(<a class="arg" href="#LDB">LDB</a>,<m:math><m:mo>*</m:mo></m:math>) &#8211; COMPLEX&#160;(KIND=nag_wp)&#160;array<span class="pclass">Input/Output</span></dt><dd>
<div class="paramtext"><b>Note:</b> the second dimension of the array <a class="arg" href="#B">B</a>
must be at least
<m:math><m:mrow><m:mi>max</m:mi><m:mspace width="0.125em"/><m:mfenced separators=""><m:mn>1</m:mn><m:mo>,</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction></m:mfenced></m:mrow></m:math>.</div>
<div class="paramtext"><i>On entry</i>: the <m:math><m:mi>n</m:mi></m:math>&#160;by <m:math><m:mi>n</m:mi></m:math>&#160;matrix <m:math><m:mi>B</m:mi></m:math>.</div>
<div class="paramtext"><i>On exit</i>: <a class="arg" href="#B">B</a> is overwritten by the balanced matrix. If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <a class="arg" href="#B">B</a> is not referenced.</div></dd><dt class="paramhead"><a name="LDB" id="LDB"/>6: &#160;&#160;&#8194; LDB &#8211; INTEGER<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</i>: the first dimension of the array <a class="arg" href="#B">B</a> as declared in the (sub)program from which F08WVF (ZGGBAL) is called.</div><div class="paramtext"><i>Constraint</i>:
  <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LDB"><m:mi mathcolor="#EE0000" mathvariant="bold">LDB</m:mi></m:maction><m:mo>&#8805;</m:mo><m:mrow><m:mi>max</m:mi><m:mspace width="0.125em"/><m:mfenced separators=""><m:mn>1</m:mn><m:mo>,</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction></m:mfenced></m:mrow></m:math>.
</div>
</dd><dt class="paramhead"><a name="ILO" id="ILO"/>7: &#160;&#160;&#8194; ILO &#8211; INTEGER<span class="pclass">Output</span></dt><dt class="multi-paramhead"><a name="IHI" id="IHI"/>8: &#160;&#160;&#8194; IHI &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub></m:math>&#160;and <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub></m:math>&#160;are set such that <m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#A"><m:mi mathcolor="#EE0000" mathvariant="bold">A</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi>i</m:mi><m:mi>j</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:mn>0</m:mn></m:math>&#160;and <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>i</m:mi><m:mi>j</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:mn>0</m:mn></m:math>&#160;if <m:math><m:mi>i</m:mi><m:mo>&gt;</m:mo><m:mi>j</m:mi></m:math>&#160;and <m:math><m:mn>1</m:mn><m:mo>&#8804;</m:mo><m:mi>j</m:mi><m:mo>&lt;</m:mo><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub></m:math>&#160;or <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>&lt;</m:mo><m:mi>i</m:mi><m:mo>&#8804;</m:mo><m:mi>n</m:mi></m:math>.
<div class="paramtext">If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#JOB"><m:mi mathcolor="#EE0000" mathvariant="bold">JOB</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>&#160;or <m:math><m:mtext>'S'</m:mtext></m:math>, <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>=</m:mo><m:mn>1</m:mn></m:math>&#160;and <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>=</m:mo><m:mi>n</m:mi></m:math>.</div></div>
</dd><dt class="paramhead"><a name="LSCALE" id="LSCALE"/>9: &#160;&#160;&#8194; LSCALE(<a class="arg" href="#N">N</a>) &#8211; REAL&#160;(KIND=nag_wp)&#160;array<span class="pclass">Output</span></dt><dd><div class="paramtext"><i>On exit</i>: details of the permutations and scaling factors applied to the left side of the matrices <m:math><m:mi>A</m:mi></m:math>&#160;and <m:math><m:mi>B</m:mi></m:math>. If <m:math><m:msub><m:mi>P</m:mi><m:mi>i</m:mi></m:msub></m:math>&#160;is the index of the row interchanged with row <m:math><m:mi>i</m:mi></m:math>&#160;and <m:math><m:msub><m:mi>d</m:mi><m:mi>i</m:mi></m:msub></m:math>&#160;is the scaling factor applied to row <m:math><m:mi>i</m:mi></m:math>, then
<ul class="listind"><li class="listind"><m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#LSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">LSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">i</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:msub><m:mi>P</m:mi><m:mi mathvariant="italic">i</m:mi></m:msub></m:math>, for <m:math><m:mi mathvariant="italic">i</m:mi><m:mo>=</m:mo><m:mn>1</m:mn><m:mo>,</m:mo><m:mn>2</m:mn><m:mo>,</m:mo><m:mo>&#8230;</m:mo><m:mo>,</m:mo><m:msub><m:mi mathvariant="italic">i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>-</m:mo><m:mn>1</m:mn></m:math>;</li><li class="listind"><m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#LSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">LSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">i</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:msub><m:mi mathvariant="italic">d</m:mi><m:mi mathvariant="italic">i</m:mi></m:msub></m:math>, for <m:math><m:mi mathvariant="italic">i</m:mi><m:mo>=</m:mo><m:msub><m:mi mathvariant="italic">i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>,</m:mo><m:mo>&#8230;</m:mo><m:mo>,</m:mo><m:msub><m:mi mathvariant="italic">i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub></m:math>;</li><li class="listind"><m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#LSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">LSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">i</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:msub><m:mi>P</m:mi><m:mi mathvariant="italic">i</m:mi></m:msub></m:math>, for <m:math><m:mi mathvariant="italic">i</m:mi><m:mo>=</m:mo><m:msub><m:mi mathvariant="italic">i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>+</m:mo><m:mn>1</m:mn><m:mo>,</m:mo><m:mo>&#8230;</m:mo><m:mo>,</m:mo><m:mi>n</m:mi></m:math>.</li></ul>
<div class="paramtext">The order in which the interchanges are made is <m:math><m:mi>n</m:mi></m:math>&#160;to <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>+</m:mo><m:mn>1</m:mn></m:math>, then <m:math><m:mn>1</m:mn></m:math>&#160;to <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>-</m:mo><m:mn>1</m:mn></m:math>.</div>
</div>
</dd><dt class="paramhead"><a name="RSCALE" id="RSCALE"/>10: &#8194; RSCALE(<a class="arg" href="#N">N</a>) &#8211; REAL&#160;(KIND=nag_wp)&#160;array<span class="pclass">Output</span></dt><dd><div class="paramtext"><i>On exit</i>: details of the permutations and scaling factors applied to the right side of the matrices <m:math><m:mi>A</m:mi></m:math>&#160;and <m:math><m:mi>B</m:mi></m:math>.
<div class="paramtext">If <m:math><m:msub><m:mi>P</m:mi><m:mi>j</m:mi></m:msub></m:math>&#160;is the index of the column interchanged with column <m:math><m:mi>j</m:mi></m:math>&#160;and <m:math><m:msub><m:mover><m:mi>d</m:mi><m:mo>^</m:mo></m:mover><m:mi>j</m:mi></m:msub></m:math>&#160;is the scaling factor applied to column <m:math><m:mi>j</m:mi></m:math>, then
<ul class="listind"><li class="listind"><m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#RSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">RSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">j</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:msub><m:mi>P</m:mi><m:mi mathvariant="italic">j</m:mi></m:msub></m:math>, for <m:math><m:mi mathvariant="italic">j</m:mi><m:mo>=</m:mo><m:mn>1</m:mn><m:mo>,</m:mo><m:mn>2</m:mn><m:mo>,</m:mo><m:mo>&#8230;</m:mo><m:mo>,</m:mo><m:msub><m:mi mathvariant="italic">i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>-</m:mo><m:mn>1</m:mn></m:math>;</li><li class="listind"><m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#RSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">RSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">j</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:msub><m:mover><m:mi>d</m:mi><m:mo>^</m:mo></m:mover><m:mi mathvariant="italic">j</m:mi></m:msub></m:math>, for <m:math><m:mi mathvariant="italic">j</m:mi><m:mo>=</m:mo><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>,</m:mo><m:mo>&#8230;</m:mo><m:mo>,</m:mo><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub></m:math>;</li><li class="listind"><m:math><m:mrow><m:maction actiontype="link" dsi:type="simple" dsi:href="#RSCALE"><m:mi mathcolor="#EE0000" mathvariant="bold">RSCALE</m:mi></m:maction><m:mfenced separators="," open="(" close=")"><m:mi mathvariant="italic">j</m:mi></m:mfenced></m:mrow><m:mo>=</m:mo><m:msub><m:mi>P</m:mi><m:mi mathvariant="italic">j</m:mi></m:msub></m:math>, for <m:math><m:mi mathvariant="italic">j</m:mi><m:mo>=</m:mo><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>+</m:mo><m:mn>1</m:mn><m:mo>,</m:mo><m:mo>&#8230;</m:mo><m:mo>,</m:mo><m:mi>n</m:mi></m:math>.</li></ul>
</div>
<div class="paramtext">The order in which the interchanges are made is <m:math><m:mi>n</m:mi></m:math>&#160;to <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">hi</m:mi></m:msub><m:mo>+</m:mo><m:mn>1</m:mn></m:math>, then <m:math><m:mn>1</m:mn></m:math>&#160;to <m:math><m:msub><m:mi>i</m:mi><m:mi mathvariant="normal">lo</m:mi></m:msub><m:mo>-</m:mo><m:mn>1</m:mn></m:math>.</div>
</div>
</dd><dt class="paramhead"><a name="WORK" id="WORK"/>11: &#8194; WORK(<m:math><m:mn>6</m:mn><m:mo>&#215;</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#N"><m:mi mathcolor="#EE0000" mathvariant="bold">N</m:mi></m:maction></m:math>) &#8211; REAL&#160;(KIND=nag_wp)&#160;array<span class="pclass">Workspace</span></dt><dt class="paramhead"><a name="INFO" id="INFO"/>12: &#8194; INFO &#8211; INTEGER<span class="pclass">Output</span></dt><dd><div class="paramtext"><i>On exit</i>: <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#INFO"><m:mi mathcolor="#EE0000" mathvariant="bold">INFO</m:mi></m:maction><m:mo>=</m:mo><m:mn>0</m:mn></m:math>&#160;unless the routine detects an error (see <a class="sec" href="#errors">Section 6</a>).</div></dd></dl><h2 class="standard"><a class="sec" name="errors" id="errors"/>6&#160;&#160;Error Indicators and Warnings</h2>
<div class="paramtext">Errors or warnings detected by the routine:</div>
<dl class="ifail">
<dt class="errorhead"><a name="INlt0" id="INlt0"/><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#INFO"><m:mi mathcolor="#EE0000" mathvariant="bold">INFO</m:mi></m:maction><m:mo>&lt;</m:mo><m:mn>0</m:mn></m:math></dt>
<dd><div class="paramtext">If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#INFO"><m:mi mathcolor="#EE0000" mathvariant="bold">INFO</m:mi></m:maction><m:mo>=</m:mo><m:mo>-</m:mo><m:mi>i</m:mi></m:math>, argument <m:math><m:mi>i</m:mi></m:math>&#160;had an illegal value. An explanatory message is output, and execution of the program is terminated.</div></dd>
</dl><h2 class="standard"><a class="sec" name="accuracy" id="accuracy"/>7&#160;&#160;Accuracy</h2>
<div class="paramtext">The errors are negligible, compared to those in subsequent computations.</div><h2 class="standard"><a class="sec" name="fcomments" id="fcomments"/>8&#160;&#160;Further Comments</h2>
<div class="paramtext">F08WVF (ZGGBAL) is usually the first step in computing the complex generalized eigenvalue problem but it is an optional step.  The matrix <m:math><m:mi>B</m:mi></m:math>&#160;is reduced to the triangular form using the <m:math><m:mi>Q</m:mi><m:mi>R</m:mi></m:math>&#160;factorization routine <a class="rout" href="../F08/f08asf.xml">F08ASF (ZGEQRF)</a> and the unitary transformation <m:math><m:mi>Q</m:mi></m:math>&#160;is applied to the matrix <m:math><m:mi>A</m:mi></m:math>&#160;by calling <a class="rout" href="../F08/f08auf.xml">F08AUF (ZUNMQR)</a>.  This is followed by <a class="rout" href="../F08/f08wsf.xml">F08WSF (ZGGHRD)</a> which reduces the matrix pair into the generalized Hessenberg form.</div><div class="paramtext">If the matrix pair <m:math><m:mfenced separators=""><m:mi>A</m:mi><m:mo>,</m:mo><m:mi>B</m:mi></m:mfenced></m:math>&#160;is balanced by this routine, then any generalized eigenvectors computed subsequently are eigenvectors of the balanced matrix pair.  In that case, to compute the generalized eigenvectors of the original matrix, <a class="rout" href="../F08/f08wwf.xml">F08WWF (ZGGBAK)</a> must be called.</div><div class="paramtext">The total number of floating point operations is approximately proportional to <m:math><m:msup><m:mi>n</m:mi><m:mn>2</m:mn></m:msup></m:math>.</div><div class="paramtext">The real analogue of this routine is <a class="rout" href="../F08/f08whf.xml">F08WHF (DGGBAL)</a>.</div><h2 class="standard"><a class="sec" name="example" id="example"/>9&#160;&#160;Example</h2>
<div class="paramtext">See Section 9 in <a class="rout" href="../F08/f08xsf.xml">F08XSF (ZHGEQZ)</a> and <a class="rout" href="../F08/f08yxf.xml">F08YXF (ZTGEVC)</a>.</div>
<hr/><div><a class="rout" href="../../pdf/F08/f08wvf.pdf">F08WVF (ZGGBAL) (PDF version)</a></div><div><a class="chap" href="f08conts.xml">F08 Chapter Contents</a></div><div><a class="chapint" href="f08intro.xml">F08 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. 2011</a></div></body></html>