<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Eigen: RealSchur< _MatrixType > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="eigendoxy.css" rel="stylesheet" type="text/css">
<!-- -->
<script type="text/javascript" src="eigen_navtree_hacks.js"></script>
<!-- <script type="text/javascript"> -->
<!-- </script> -->
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- <a name="top"></a> -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen</a>
 <span id="projectnumber">3.2.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classEigen_1_1RealSchur.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="classEigen_1_1RealSchur-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">RealSchur< _MatrixType > Class Template Reference<div class="ingroups"><a class="el" href="group__Eigenvalues__Module.html">Eigenvalues module</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename _MatrixType><br/>
class Eigen::RealSchur< _MatrixType ></h3>
<p>Performs a real Schur decomposition of a square matrix. </p>
<p>This is defined in the Eigenvalues module.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <Eigen/Eigenvalues></span> </div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">_MatrixType</td><td>the type of the matrix of which we are computing the real Schur decomposition; this is expected to be an instantiation of the <a class="el" href="classEigen_1_1Matrix.html" title="The matrix class, also used for vectors and row-vectors. ">Matrix</a> class template.</td></tr>
</table>
</dd>
</dl>
<p>Given a real square matrix A, this class computes the real Schur decomposition: <img class="formulaInl" alt="$ A = U T U^T $" src="form_93.png"/> where U is a real orthogonal matrix and T is a real quasi-triangular matrix. An orthogonal matrix is a matrix whose inverse is equal to its transpose, <img class="formulaInl" alt="$ U^{-1} = U^T $" src="form_91.png"/>. A quasi-triangular matrix is a block-triangular matrix whose diagonal consists of 1-by-1 blocks and 2-by-2 blocks with complex eigenvalues. The eigenvalues of the blocks on the diagonal of T are the same as the eigenvalues of the matrix A, and thus the real Schur decomposition is used in <a class="el" href="classEigen_1_1EigenSolver.html" title="Computes eigenvalues and eigenvectors of general matrices. ">EigenSolver</a> to compute the eigendecomposition of a matrix.</p>
<p>Call the function <a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a" title="Computes Schur decomposition of given matrix. ">compute()</a> to compute the real Schur decomposition of a given matrix. Alternatively, you can use the <a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198" title="Constructor; computes real Schur decomposition of given matrix. ">RealSchur(const MatrixType&, bool)</a> constructor which computes the real Schur decomposition at construction time. Once the decomposition is computed, you can use the <a class="el" href="classEigen_1_1RealSchur.html#a7663c715ad9aaf8b57825646f5317166" title="Returns the orthogonal matrix in the Schur decomposition. ">matrixU()</a> and <a class="el" href="classEigen_1_1RealSchur.html#a0d31900234ef9fea5751ce8ea693d71f" title="Returns the quasi-triangular matrix in the Schur decomposition. ">matrixT()</a> functions to retrieve the matrices U and T in the decomposition.</p>
<p>The documentation of <a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198" title="Constructor; computes real Schur decomposition of given matrix. ">RealSchur(const MatrixType&, bool)</a> contains an example of the typical use of this class.</p>
<dl class="section note"><dt>Note</dt><dd>The implementation is adapted from <a href="http://math.nist.gov/javanumerics/jama/">JAMA</a> (public domain). Their code is based on EISPACK.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>class <a class="el" href="classEigen_1_1ComplexSchur.html" title="Performs a complex Schur decomposition of a real or complex square matrix. ">ComplexSchur</a>, class <a class="el" href="classEigen_1_1EigenSolver.html" title="Computes eigenvalues and eigenvectors of general matrices. ">EigenSolver</a>, class <a class="el" href="classEigen_1_1ComplexEigenSolver.html" title="Computes eigenvalues and eigenvectors of general complex matrices. ">ComplexEigenSolver</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ace387c8cea391973ca2a99edc720671a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a">compute</a> (const MatrixType &matrix, bool computeU=true)</td></tr>
<tr class="memdesc:ace387c8cea391973ca2a99edc720671a"><td class="mdescLeft"> </td><td class="mdescRight">Computes Schur decomposition of given matrix. <a href="#ace387c8cea391973ca2a99edc720671a">More...</a><br/></td></tr>
<tr class="separator:ace387c8cea391973ca2a99edc720671a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b461a34397b36bb284ccfb0f3a4c498"><td class="memTemplParams" colspan="2">template<typename HessMatrixType , typename OrthMatrixType > </td></tr>
<tr class="memitem:a5b461a34397b36bb284ccfb0f3a4c498"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#a5b461a34397b36bb284ccfb0f3a4c498">computeFromHessenberg</a> (const HessMatrixType &matrixH, const OrthMatrixType &matrixQ, bool computeU)</td></tr>
<tr class="memdesc:a5b461a34397b36bb284ccfb0f3a4c498"><td class="mdescLeft"> </td><td class="mdescRight">Computes Schur decomposition of a Hessenberg matrix H = Z T Z^T. <a href="#a5b461a34397b36bb284ccfb0f3a4c498">More...</a><br/></td></tr>
<tr class="separator:a5b461a34397b36bb284ccfb0f3a4c498"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6f0a63ea1d26cef5e748207043eb43e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6f0a63ea1d26cef5e748207043eb43e"></a>
Index </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#ab6f0a63ea1d26cef5e748207043eb43e">getMaxIterations</a> ()</td></tr>
<tr class="memdesc:ab6f0a63ea1d26cef5e748207043eb43e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum number of iterations. <br/></td></tr>
<tr class="separator:ab6f0a63ea1d26cef5e748207043eb43e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c06d5c2034ebb329c54235369643ad2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__enums.html#ga51bc1ac16f26ebe51eae1abb77bd037b">ComputationInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#a0c06d5c2034ebb329c54235369643ad2">info</a> () const </td></tr>
<tr class="memdesc:a0c06d5c2034ebb329c54235369643ad2"><td class="mdescLeft"> </td><td class="mdescRight">Reports whether previous computation was successful. <a href="#a0c06d5c2034ebb329c54235369643ad2">More...</a><br/></td></tr>
<tr class="separator:a0c06d5c2034ebb329c54235369643ad2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d31900234ef9fea5751ce8ea693d71f"><td class="memItemLeft" align="right" valign="top">const MatrixType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#a0d31900234ef9fea5751ce8ea693d71f">matrixT</a> () const </td></tr>
<tr class="memdesc:a0d31900234ef9fea5751ce8ea693d71f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the quasi-triangular matrix in the Schur decomposition. <a href="#a0d31900234ef9fea5751ce8ea693d71f">More...</a><br/></td></tr>
<tr class="separator:a0d31900234ef9fea5751ce8ea693d71f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7663c715ad9aaf8b57825646f5317166"><td class="memItemLeft" align="right" valign="top">const MatrixType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#a7663c715ad9aaf8b57825646f5317166">matrixU</a> () const </td></tr>
<tr class="memdesc:a7663c715ad9aaf8b57825646f5317166"><td class="mdescLeft"> </td><td class="mdescRight">Returns the orthogonal matrix in the Schur decomposition. <a href="#a7663c715ad9aaf8b57825646f5317166">More...</a><br/></td></tr>
<tr class="separator:a7663c715ad9aaf8b57825646f5317166"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a782ab2c509de1deb484bbd12d6e863a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#a782ab2c509de1deb484bbd12d6e863a0">RealSchur</a> (Index size=RowsAtCompileTime==<a class="el" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a>?1:RowsAtCompileTime)</td></tr>
<tr class="memdesc:a782ab2c509de1deb484bbd12d6e863a0"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a782ab2c509de1deb484bbd12d6e863a0">More...</a><br/></td></tr>
<tr class="separator:a782ab2c509de1deb484bbd12d6e863a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d73d4e86d87bd2babf172909fc54198"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198">RealSchur</a> (const MatrixType &matrix, bool computeU=true)</td></tr>
<tr class="memdesc:a8d73d4e86d87bd2babf172909fc54198"><td class="mdescLeft"> </td><td class="mdescRight">Constructor; computes real Schur decomposition of given matrix. <a href="#a8d73d4e86d87bd2babf172909fc54198">More...</a><br/></td></tr>
<tr class="separator:a8d73d4e86d87bd2babf172909fc54198"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcb20d95f17c74395f9a906e5a72ab6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#adcb20d95f17c74395f9a906e5a72ab6b">setMaxIterations</a> (Index maxIters)</td></tr>
<tr class="memdesc:adcb20d95f17c74395f9a906e5a72ab6b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum number of iterations allowed. <a href="#adcb20d95f17c74395f9a906e5a72ab6b">More...</a><br/></td></tr>
<tr class="separator:adcb20d95f17c74395f9a906e5a72ab6b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:afdafb24d67af7529bb903a4c9bff3ea4"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1RealSchur.html#afdafb24d67af7529bb903a4c9bff3ea4">m_maxIterationsPerRow</a></td></tr>
<tr class="memdesc:afdafb24d67af7529bb903a4c9bff3ea4"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of iterations per row. <a href="#afdafb24d67af7529bb903a4c9bff3ea4">More...</a><br/></td></tr>
<tr class="separator:afdafb24d67af7529bb903a4c9bff3ea4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a782ab2c509de1deb484bbd12d6e863a0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a> </td>
<td>(</td>
<td class="paramtype">Index </td>
<td class="paramname"><em>size</em> = <code>RowsAtCompileTime==<a class="el" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a> ? 1 : RowsAtCompileTime</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Positive integer, size of the matrix whose Schur decomposition will be computed.</td></tr>
</table>
</dd>
</dl>
<p>The default constructor is useful in cases in which the user intends to perform decompositions via <a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a" title="Computes Schur decomposition of given matrix. ">compute()</a>. The <code>size</code> parameter is only used as a hint. It is not an error to give a wrong <code>size</code>, but it may impair performance.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a" title="Computes Schur decomposition of given matrix. ">compute()</a> for an example. </dd></dl>
</div>
</div>
<a class="anchor" id="a8d73d4e86d87bd2babf172909fc54198"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a> </td>
<td>(</td>
<td class="paramtype">const MatrixType & </td>
<td class="paramname"><em>matrix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>computeU</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor; computes real Schur decomposition of given matrix. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">matrix</td><td>Square matrix whose Schur decomposition is to be computed. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">computeU</td><td>If true, both T and U are computed; if false, only T is computed.</td></tr>
</table>
</dd>
</dl>
<p>This constructor calls <a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a" title="Computes Schur decomposition of given matrix. ">compute()</a> to compute the Schur decomposition.</p>
<p>Example: </p>
<div class="fragment"><div class="line">MatrixXd A = <a class="code" href="classEigen_1_1DenseBase.html#a8e759dafdd9ecc446d397b7f5435f60a">MatrixXd::Random</a>(6,6);</div>
<div class="line">cout << <span class="stringliteral">"Here is a random 6x6 matrix, A:"</span> << endl << A << endl << endl;</div>
<div class="line"></div>
<div class="line">RealSchur<MatrixXd> schur(A);</div>
<div class="line">cout << <span class="stringliteral">"The orthogonal matrix U is:"</span> << endl << schur.matrixU() << endl;</div>
<div class="line">cout << <span class="stringliteral">"The quasi-triangular matrix T is:"</span> << endl << schur.matrixT() << endl << endl;</div>
<div class="line"></div>
<div class="line">MatrixXd U = schur.matrixU();</div>
<div class="line">MatrixXd T = schur.matrixT();</div>
<div class="line">cout << <span class="stringliteral">"U * T * U^T = "</span> << endl << U * T * U.transpose() << endl;</div>
</div><!-- fragment --><p> Output: </p>
<pre class="fragment">Here is a random 6x6 matrix, A:
0.68 -0.33 -0.27 -0.717 -0.687 0.0259
-0.211 0.536 0.0268 0.214 -0.198 0.678
0.566 -0.444 0.904 -0.967 -0.74 0.225
0.597 0.108 0.832 -0.514 -0.782 -0.408
0.823 -0.0452 0.271 -0.726 0.998 0.275
-0.605 0.258 0.435 0.608 -0.563 0.0486
The orthogonal matrix U is:
0.348 -0.754 0.00435 -0.351 0.0145 0.432
-0.16 -0.266 -0.747 0.457 -0.366 0.0571
0.505 -0.157 0.0746 0.644 0.518 -0.177
0.703 0.324 -0.409 -0.349 -0.187 -0.275
0.296 0.372 0.24 0.324 -0.379 0.684
-0.126 0.305 -0.46 -0.161 0.647 0.485
The quasi-triangular matrix T is:
-0.2 -1.83 0.864 0.271 1.09 0.14
0.647 0.298 -0.0536 0.676 -0.288 0.023
0 0 0.967 -0.201 -0.429 0.847
0 0 0 0.353 0.602 0.694
0 0 0 0 0.572 -1.03
0 0 0 0 0.0184 0.664
U * T * U^T =
0.68 -0.33 -0.27 -0.717 -0.687 0.0259
-0.211 0.536 0.0268 0.214 -0.198 0.678
0.566 -0.444 0.904 -0.967 -0.74 0.225
0.597 0.108 0.832 -0.514 -0.782 -0.408
0.823 -0.0452 0.271 -0.726 0.998 0.275
-0.605 0.258 0.435 0.608 -0.563 0.0486
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ace387c8cea391973ca2a99edc720671a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a>< MatrixType > & compute </td>
<td>(</td>
<td class="paramtype">const MatrixType & </td>
<td class="paramname"><em>matrix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>computeU</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes Schur decomposition of given matrix. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">matrix</td><td>Square matrix whose Schur decomposition is to be computed. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">computeU</td><td>If true, both T and U are computed; if false, only T is computed. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to <code>*this</code> </dd></dl>
<p>The Schur decomposition is computed by first reducing the matrix to Hessenberg form using the class <a class="el" href="classEigen_1_1HessenbergDecomposition.html" title="Reduces a square matrix to Hessenberg form by an orthogonal similarity transformation. ">HessenbergDecomposition</a>. The Hessenberg matrix is then reduced to triangular form by performing Francis QR iterations with implicit double shift. The cost of computing the Schur decomposition depends on the number of iterations; as a rough guide, it may be taken to be <img class="formulaInl" alt="$25n^3$" src="form_47.png"/> flops if <em>computeU</em> is true and <img class="formulaInl" alt="$10n^3$" src="form_48.png"/> flops if <em>computeU</em> is false.</p>
<p>Example: </p>
<div class="fragment"><div class="line"><a class="code" href="group__matrixtypedefs.html#gabab09c32e96cfa9829a88400627af162">MatrixXf</a> A = <a class="code" href="classEigen_1_1DenseBase.html#a8e759dafdd9ecc446d397b7f5435f60a">MatrixXf::Random</a>(4,4);</div>
<div class="line">RealSchur<MatrixXf> schur(4);</div>
<div class="line">schur.compute(A, <span class="comment">/* computeU = */</span> <span class="keyword">false</span>);</div>
<div class="line">cout << <span class="stringliteral">"The matrix T in the decomposition of A is:"</span> << endl << schur.matrixT() << endl;</div>
<div class="line">schur.compute(A.inverse(), <span class="comment">/* computeU = */</span> <span class="keyword">false</span>);</div>
<div class="line">cout << <span class="stringliteral">"The matrix T in the decomposition of A^(-1) is:"</span> << endl << schur.matrixT() << endl;</div>
</div><!-- fragment --><p> Output: </p>
<pre class="fragment">The matrix T in the decomposition of A is:
0.523 -0.698 0.148 0.742
0.475 0.986 -0.793 0.721
0 0 -0.28 -0.77
0 0 0.0145 -0.367
The matrix T in the decomposition of A^(-1) is:
-3.06 -4.57 -6.05 5.39
0.168 -2.62 -3.33 3.86
0 0 0.434 0.56
0 0 -1.06 1.35
</pre><dl class="section see"><dt>See Also</dt><dd>compute(const MatrixType&, bool, Index) </dd></dl>
<p>Referenced by <a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198">RealSchur< MatrixType >::RealSchur()</a>.</p>
</div>
</div>
<a class="anchor" id="a5b461a34397b36bb284ccfb0f3a4c498"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a>& computeFromHessenberg </td>
<td>(</td>
<td class="paramtype">const HessMatrixType & </td>
<td class="paramname"><em>matrixH</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const OrthMatrixType & </td>
<td class="paramname"><em>matrixQ</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>computeU</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes Schur decomposition of a Hessenberg matrix H = Z T Z^T. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">matrixH</td><td><a class="el" href="classEigen_1_1Matrix.html" title="The matrix class, also used for vectors and row-vectors. ">Matrix</a> in Hessenberg form H </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">matrixQ</td><td>orthogonal matrix Q that transform a matrix A to H : A = Q H Q^T </td></tr>
<tr><td class="paramdir"></td><td class="paramname">computeU</td><td>Computes the matriX U of the Schur vectors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to <code>*this</code> </dd></dl>
<p>This routine assumes that the matrix is already reduced in Hessenberg form matrixH using either the class <a class="el" href="classEigen_1_1HessenbergDecomposition.html" title="Reduces a square matrix to Hessenberg form by an orthogonal similarity transformation. ">HessenbergDecomposition</a> or another mean. It computes the upper quasi-triangular matrix T of the Schur decomposition of H When computeU is true, this routine computes the matrix U such that A = U T U^T = (QZ) T (QZ)^T = Q H Q^T where A is the initial matrix</p>
<p>NOTE Q is referenced if computeU is true; so, if the initial orthogonal matrix is not available, the user should give an identity matrix (Q.setIdentity())</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a" title="Computes Schur decomposition of given matrix. ">compute(const MatrixType&, bool)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0c06d5c2034ebb329c54235369643ad2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__enums.html#ga51bc1ac16f26ebe51eae1abb77bd037b">ComputationInfo</a> info </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reports whether previous computation was successful. </p>
<dl class="section return"><dt>Returns</dt><dd><code>Success</code> if computation was succesful, <code>NoConvergence</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a0d31900234ef9fea5751ce8ea693d71f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const MatrixType& matrixT </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the quasi-triangular matrix in the Schur decomposition. </p>
<dl class="section return"><dt>Returns</dt><dd>A const reference to the matrix T.</dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>Either the constructor <a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198" title="Constructor; computes real Schur decomposition of given matrix. ">RealSchur(const MatrixType&, bool)</a> or the member function <a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a" title="Computes Schur decomposition of given matrix. ">compute(const MatrixType&, bool)</a> has been called before to compute the Schur decomposition of a matrix.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198" title="Constructor; computes real Schur decomposition of given matrix. ">RealSchur(const MatrixType&, bool)</a> for an example </dd></dl>
</div>
</div>
<a class="anchor" id="a7663c715ad9aaf8b57825646f5317166"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const MatrixType& matrixU </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the orthogonal matrix in the Schur decomposition. </p>
<dl class="section return"><dt>Returns</dt><dd>A const reference to the matrix U.</dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>Either the constructor <a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198" title="Constructor; computes real Schur decomposition of given matrix. ">RealSchur(const MatrixType&, bool)</a> or the member function <a class="el" href="classEigen_1_1RealSchur.html#ace387c8cea391973ca2a99edc720671a" title="Computes Schur decomposition of given matrix. ">compute(const MatrixType&, bool)</a> has been called before to compute the Schur decomposition of a matrix, and <code>computeU</code> was set to true (the default value).</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1RealSchur.html#a8d73d4e86d87bd2babf172909fc54198" title="Constructor; computes real Schur decomposition of given matrix. ">RealSchur(const MatrixType&, bool)</a> for an example </dd></dl>
</div>
</div>
<a class="anchor" id="adcb20d95f17c74395f9a906e5a72ab6b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a>& setMaxIterations </td>
<td>(</td>
<td class="paramtype">Index </td>
<td class="paramname"><em>maxIters</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the maximum number of iterations allowed. </p>
<p>If not specified by the user, the maximum number of iterations is m_maxIterationsPerRow times the size of the matrix. </p>
<p>Referenced by <a class="el" href="classEigen_1_1EigenSolver.html#ab70fdf436af2c43b7174e2981f618fb3">EigenSolver< _MatrixType >::setMaxIterations()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="afdafb24d67af7529bb903a4c9bff3ea4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int m_maxIterationsPerRow</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of iterations per row. </p>
<p>If not otherwise specified, the maximum number of iterations is this number times the size of the matrix. It is currently set to 40. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RealSchur_8h_source.html">RealSchur.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceEigen.html">Eigen</a></li><li class="navelem"><a class="el" href="classEigen_1_1RealSchur.html">RealSchur</a></li>
<li class="footer">Generated on Mon Oct 28 2013 11:04:30 for Eigen by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
<!-- Piwik -->
<!--
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.sylphide-consulting.com/piwik/" : "http://stats.sylphide-consulting.com/piwik/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
try {
var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 20);
piwikTracker.trackPageView();
piwikTracker.enableLinkTracking();
} catch( err ) {}
</script><noscript><p><img src="http://stats.sylphide-consulting.com/piwik/piwik.php?idsite=20" style="border:0" alt="" /></p></noscript>
-->
<!-- End Piwik Tracking Code -->
</body>
</html>
