<?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>F08WSF (ZGGHRD) : 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/f08wsf.pdf">F08WSF (ZGGHRD) (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/>F08WSF (ZGGHRD)</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">F08WSF (ZGGHRD) reduces a pair of complex matrices <m:math><m:mfenced separators=""><m:mi>A</m:mi><m:mo>,</m:mo><m:mi>B</m:mi></m:mfenced></m:math>, where <m:math><m:mi>B</m:mi></m:math>&#160;is upper triangular, to the generalized upper Hessenberg form using unitary transformations.</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;F08WSF&#160;(</td>
<td class="tdfspec2" valign="top" align="left"><a class="arg" href="#COMPQ">COMPQ</a>, <a class="arg" href="#COMPZ">COMPZ</a>, <a class="arg" href="#N">N</a>, <a class="arg" href="#ILO">ILO</a>, <a class="arg" href="#IHI">IHI</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="#Q">Q</a>, <a class="arg" href="#LDQ">LDQ</a>, <a class="arg" href="#Z">Z</a>, <a class="arg" href="#LDZ">LDZ</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, ILO, IHI, LDA, LDB, LDQ, LDZ, INFO</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,*), Q(LDQ,*), Z(LDZ,*)</td>
</tr><tr>
<td class="tdfspec1" valign="top" align="left">CHARACTER(1)&#160;</td>
<td class="tdfspec2" valign="top" align="left">COMPQ, COMPZ</td></tr></tbody>
</table></div>
</td></tr></table>
<div class="paramtext">The routine may be called by its 
    LAPACK
    name <span class="bitalic">zgghrd</span>.</div><h2 class="standard"><a class="sec" name="description" id="description"/>3&#160;&#160;Description</h2>
<div class="paramtext">F08WSF (ZGGHRD) is usually the third step in the solution of 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>

The (optional) first step balances the two matrices using <a class="rout" href="../F08/f08wvf.xml">F08WVF (ZGGBAL)</a>.  In the second step, matrix <m:math><m:mi>B</m:mi></m:math>&#160;is reduced to upper 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 this unitary transformation <m:math><m:mi>Q</m:mi></m:math>&#160;is applied to matrix <m:math><m:mi>A</m:mi></m:math>&#160;by calling <a class="rout" href="../F08/f08auf.xml">F08AUF (ZUNMQR)</a>.</div><div class="paramtext">F08WSF (ZGGHRD) reduces a pair of complex matrices <m:math><m:mfenced separators=""><m:mi>A</m:mi><m:mo>,</m:mo><m:mi>B</m:mi></m:mfenced></m:math>, where <m:math><m:mi>B</m:mi></m:math>&#160;is triangular, to the generalized upper Hessenberg form using unitary transformations.  This two-sided transformation is of the form

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
 <m:mtable>
 <m:mtr>
  <m:mtd><m:msup><m:mi>Q</m:mi><m:mi mathvariant="normal">H</m:mi></m:msup><m:mi>A</m:mi><m:mi>Z</m:mi><m:mo>=</m:mo><m:mi>H</m:mi></m:mtd>
 </m:mtr><m:mtr>
  <m:mtd><m:msup><m:mi>Q</m:mi><m:mi mathvariant="normal">H</m:mi></m:msup><m:mi>B</m:mi><m:mi>Z</m:mi><m:mo>=</m:mo><m:mi>T</m:mi></m:mtd>
 </m:mtr>
</m:mtable>
</m:math></td><td class="formula2"/></tr></table></div>

where <m:math><m:mi>H</m:mi></m:math>&#160;is an upper Hessenberg matrix, <m:math><m:mi>T</m:mi></m:math>&#160;is an upper triangular matrix and <m:math><m:mi>Q</m:mi></m:math>&#160;and <m:math><m:mi>Z</m:mi></m:math>&#160;are unitary matrices determined as products of Givens rotations.  They may either be formed explicitly, or they may be postmultiplied into input matrices <m:math><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub></m:math>&#160;and <m:math><m:msub><m:mi>Z</m:mi><m:mn>1</m:mn></m:msub></m:math>, so that

<div class="formula"><table class="formula"><tr><td class="formula"><m:math display="block">
 <m:mtable>
 <m:mtr>
  <m:mtd><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub><m:mi>A</m:mi><m:msubsup><m:mi>Z</m:mi><m:mn>1</m:mn><m:mi mathvariant="normal">H</m:mi></m:msubsup><m:mo>=</m:mo><m:mfenced separators=""><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub><m:mi>Q</m:mi></m:mfenced><m:mi>H</m:mi><m:msup><m:mfenced separators=""><m:msub><m:mi>Z</m:mi><m:mn>1</m:mn></m:msub><m:mi>Z</m:mi></m:mfenced><m:mi mathvariant="normal">H</m:mi></m:msup><m:mtext>,</m:mtext></m:mtd>
 </m:mtr><m:mtr>
  <m:mtd><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub><m:mi>B</m:mi><m:msubsup><m:mi>Z</m:mi><m:mn>1</m:mn><m:mi mathvariant="normal">H</m:mi></m:msubsup><m:mo>=</m:mo><m:mfenced separators=""><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub><m:mi>Q</m:mi></m:mfenced><m:mi>T</m:mi><m:msup><m:mfenced separators=""><m:msub><m:mi>Z</m:mi><m:mn>1</m:mn></m:msub><m:mi>Z</m:mi></m:mfenced><m:mi mathvariant="normal">H</m:mi></m:msup><m:mtext>.</m:mtext></m:mtd>
 </m:mtr>
</m:mtable>
</m:math></td><td class="formula2"/></tr></table></div></div><h2 class="standard"><a class="sec" name="references" id="references"/>4&#160;&#160;References</h2><div class="paramtext"><a name="ref105" id="ref105"/>Golub G H and Van Loan C F (1996)  <i>Matrix Computations</i> (3rd Edition) Johns Hopkins University Press, Baltimore </div>
<div class="paramtext"><a name="ref107" id="ref107"/>Moler C B and Stewart G W (1973)  An algorithm for generalized matrix eigenproblems <i>SIAM J. Numer. Anal.</i> <b>10</b> 241&#8211;256 </div><h2 class="standard"><a class="sec" name="parameters" id="parameters"/>5&#160;&#160;Parameters</h2>
<dl><dt class="paramhead"><a name="COMPQ" id="COMPQ"/>1: &#160;&#160;&#8194; COMPQ &#8211; CHARACTER(1)<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</i>: specifies the form of the computed
unitary
matrix <m:math><m:mi>Q</m:mi></m:math>.

<dl>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math></dt>
<dd>Do not compute <m:math><m:mi>Q</m:mi></m:math>.</dd>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'I'</m:mtext></m:math></dt>
<dd>The
unitary
matrix <m:math><m:mi>Q</m:mi></m:math>&#160;is returned.</dd>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math></dt>
<dd><a class="arg" href="#Q">Q</a> must contain
a unitary
matrix <m:math><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub></m:math>, and the product <m:math><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub><m:mi>Q</m:mi></m:math>&#160;is returned.</dd></dl>
</div><div class="paramtext"><i>Constraint</i>:
  <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <m:math><m:mtext>'I'</m:mtext></m:math>&#160;or <m:math><m:mtext>'V'</m:mtext></m:math>.
</div>
</dd><dt class="paramhead"><a name="COMPZ" id="COMPZ"/>2: &#160;&#160;&#8194; COMPZ &#8211; CHARACTER(1)<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</i>: specifies the form of the computed
unitary
matrix <m:math><m:mi>Z</m:mi></m:math>.

<dl>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math></dt>
<dd>Do not compute <m:math><m:mi>Z</m:mi></m:math>.</dd>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'I'</m:mtext></m:math></dt>
<dd>The
unitary
matrix <m:math><m:mi>Z</m:mi></m:math>&#160;is returned.</dd>
<dt class="paramval"><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math></dt>
<dd><a class="arg" href="#Z">Z</a> must contain
a unitary
matrix <m:math><m:msub><m:mi>Z</m:mi><m:mn>1</m:mn></m:msub></m:math>, and the product <m:math><m:msub><m:mi>Z</m:mi><m:mn>1</m:mn></m:msub><m:mi>Z</m:mi></m:math>&#160;is returned.</dd></dl>
</div><div class="paramtext"><i>Constraint</i>:
  <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <m:math><m:mtext>'I'</m:mtext></m:math>&#160;or <m:math><m:mtext>'V'</m:mtext></m:math>.
</div>
</dd><dt class="paramhead"><a name="N" id="N"/>3: &#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="ILO" id="ILO"/>4: &#160;&#160;&#8194; ILO &#8211; INTEGER<span class="pclass">Input</span></dt><dt class="multi-paramhead"><a name="IHI" id="IHI"/>5: &#160;&#160;&#8194; IHI &#8211; INTEGER<span class="pclass">Input</span></dt><dd>
<div class="paramtext"><i>On entry</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;as determined by a previous call to <a class="rout" href="../F08/f08wvf.xml">F08WVF (ZGGBAL)</a>. Otherwise, they should be set to <m:math><m:mn>1</m:mn></m:math>&#160;and <m:math><m:mi>n</m:mi></m:math>, respectively.</div><div class="paramtext"><i>Constraints</i>:
   <div class="paramtext"/><ul class="listcons">
<li class="listcons">if <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>&gt;</m:mo><m:mn>0</m:mn></m:math>, <m:math><m:mn>1</m:mn><m:mo>&#8804;</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#ILO"><m:mi mathcolor="#EE0000" mathvariant="bold">ILO</m:mi></m:maction><m:mo>&#8804;</m:mo><m:maction actiontype="link" dsi:type="simple" dsi:href="#IHI"><m:mi mathcolor="#EE0000" mathvariant="bold">IHI</m:mi></m:maction><m:mo>&#8804;</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>;</li>
<li class="listcons">if <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>=</m:mo><m:mn>0</m:mn></m:math>, <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>&#160;and <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:mn>0</m:mn></m:math>.</li>
</ul></div>
</dd><dt class="paramhead"><a name="A" id="A"/>6: &#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 matrix <m:math><m:mi>A</m:mi></m:math>&#160;of 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>. Usually, this is the matrix <m:math><m:mi>A</m:mi></m:math>&#160;returned by
<a class="rout" href="../F08/f08auf.xml">F08AUF (ZUNMQR)</a>.</div>
<div class="paramtext"><i>On exit</i>: <a class="arg" href="#A">A</a> is overwritten by the upper Hessenberg matrix <m:math><m:mi>H</m:mi></m:math>.</div></dd><dt class="paramhead"><a name="LDA" id="LDA"/>7: &#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 F08WSF (ZGGHRD) 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"/>8: &#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 upper triangular matrix <m:math><m:mi>B</m:mi></m:math>&#160;of 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>. Usually, this is the matrix <m:math><m:mi>B</m:mi></m:math>&#160;returned by 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>.</div>
<div class="paramtext"><i>On exit</i>: <a class="arg" href="#B">B</a> is overwritten by the upper triangular matrix <m:math><m:mi>T</m:mi></m:math>.</div></dd><dt class="paramhead"><a name="LDB" id="LDB"/>9: &#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 F08WSF (ZGGHRD) 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="Q" id="Q"/>10: &#8194; Q(<a class="arg" href="#LDQ">LDQ</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="#Q">Q</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>&#160;if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'I'</m:mtext></m:math>&#160;or <m:math><m:mtext>'V'</m:mtext></m:math>&#160;and at least <m:math><m:mn>1</m:mn></m:math>&#160;if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>.</div>
<div class="paramtext"><i>On entry</i>: if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math>, <a class="arg" href="#Q">Q</a> must contain
a unitary
matrix <m:math><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub></m:math>.
<div class="paramtext">If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <a class="arg" href="#Q">Q</a> is not referenced.</div>
</div>
<div class="paramtext"><i>On exit</i>: if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'I'</m:mtext></m:math>, <a class="arg" href="#Q">Q</a> contains the
unitary
matrix <m:math><m:mi>Q</m:mi></m:math>.
<div class="paramtext">Iif <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math>, <a class="arg" href="#Q">Q</a> is overwritten by <m:math><m:msub><m:mi>Q</m:mi><m:mn>1</m:mn></m:msub><m:mi>Q</m:mi></m:math>.</div>
</div>
</dd><dt class="paramhead"><a name="LDQ" id="LDQ"/>11: &#8194; LDQ &#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="#Q">Q</a> as declared in the (sub)program from which F08WSF (ZGGHRD) is called.</div><div class="paramtext"><i>Constraints</i>:
   <div class="paramtext"/><ul class="listcons">
<li class="listcons">if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'I'</m:mtext></m:math>&#160;or <m:math><m:mtext>'V'</m:mtext></m:math>, <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LDQ"><m:mi mathcolor="#EE0000" mathvariant="bold">LDQ</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>;</li>
<li class="listcons">if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPQ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPQ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LDQ"><m:mi mathcolor="#EE0000" mathvariant="bold">LDQ</m:mi></m:maction><m:mo>&#8805;</m:mo><m:mn>1</m:mn></m:math>.</li>
</ul></div>
</dd><dt class="paramhead"><a name="Z" id="Z"/>12: &#8194; Z(<a class="arg" href="#LDZ">LDZ</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="#Z">Z</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>&#160;if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math>&#160;or <m:math><m:mtext>'I'</m:mtext></m:math>&#160;and at least <m:math><m:mn>1</m:mn></m:math>&#160;if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>.</div>
<div class="paramtext"><i>On entry</i>: if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math>, <a class="arg" href="#Z">Z</a> must contain a unitary matrix <m:math><m:msub><m:mi>Z</m:mi><m:mn>1</m:mn></m:msub></m:math>.
<div class="paramtext">If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <a class="arg" href="#Z">Z</a> is not referenced.</div>
</div>
<div class="paramtext"><i>On exit</i>: if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'I'</m:mtext></m:math>, <a class="arg" href="#Z">Z</a> contains the unitary matrix <m:math><m:mi>Z</m:mi></m:math>.
<div class="paramtext">If <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math>, <a class="arg" href="#Z">Z</a> is overwritten by <m:math><m:msub><m:mi>Z</m:mi><m:mn>1</m:mn></m:msub><m:mi>Z</m:mi></m:math>.</div>
</div>
</dd><dt class="paramhead"><a name="LDZ" id="LDZ"/>13: &#8194; LDZ &#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="#Z">Z</a> as declared in the (sub)program from which F08WSF (ZGGHRD) is called.</div><div class="paramtext"><i>Constraints</i>:
   <div class="paramtext"/><ul class="listcons">
<li class="listcons">if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'V'</m:mtext></m:math>&#160;or <m:math><m:mtext>'I'</m:mtext></m:math>, <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LDZ"><m:mi mathcolor="#EE0000" mathvariant="bold">LDZ</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>;</li>
<li class="listcons">if <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#COMPZ"><m:mi mathcolor="#EE0000" mathvariant="bold">COMPZ</m:mi></m:maction><m:mo>=</m:mo><m:mtext>'N'</m:mtext></m:math>, <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#LDZ"><m:mi mathcolor="#EE0000" mathvariant="bold">LDZ</m:mi></m:maction><m:mo>&#8805;</m:mo><m:mn>1</m:mn></m:math>.</li>
</ul></div>
</dd><dt class="paramhead"><a name="INFO" id="INFO"/>14: &#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 reduction to the generalized Hessenberg form is implemented using unitary transformations which are backward stable.</div><h2 class="standard"><a class="sec" name="fcomments" id="fcomments"/>8&#160;&#160;Further Comments</h2>
<div class="paramtext">This routine is usually followed by <a class="rout" href="../F08/f08xsf.xml">F08XSF (ZHGEQZ)</a> which implements the <m:math><m:mi>Q</m:mi><m:mi>Z</m:mi></m:math>&#160;algorithm for computing generalized eigenvalues of a reduced pair of matrices.</div><div class="paramtext">The real analogue of this routine is <a class="rout" href="../F08/f08wef.xml">F08WEF (DGGHRD)</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/f08wsf.pdf">F08WSF (ZGGHRD) (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>