<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>The MRPT project: HouseholderSequence< VectorsType, CoeffsType, Side > Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</span><span class="right"></span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-types">Private Types</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>HouseholderSequence< VectorsType, CoeffsType, Side > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="HouseholderSequence" --><!-- doxytag: inherits="EigenBase< HouseholderSequence< VectorsType, CoeffsType, Side > >" --><hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename VectorsType, typename CoeffsType, int Side><br/>
class HouseholderSequence< VectorsType, CoeffsType, Side ></h3>
<p>Sequence of Householder reflections acting on subspaces with decreasing size </p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">VectorsType</td><td>type of matrix containing the Householder vectors </td></tr>
<tr><td class="paramname">CoeffsType</td><td>type of vector containing the Householder coefficients </td></tr>
<tr><td class="paramname">Side</td><td>either OnTheLeft (the default) or OnTheRight</td></tr>
</table>
</dd>
</dl>
<p>This class represents a product sequence of Householder reflections where the first Householder reflection acts on the whole space, the second Householder reflection leaves the one-dimensional subspace spanned by the first unit vector invariant, the third Householder reflection leaves the two-dimensional subspace spanned by the first two unit vectors invariant, and so on up to the last reflection which leaves all but one dimensions invariant and acts only on the last dimension. Such sequences of Householder reflections are used in several algorithms to zero out certain parts of a matrix. Indeed, the methods <a class="el" href="class_hessenberg_decomposition.html#a4b926fff77bd9682b46579eb83e93329" title="Reconstructs the orthogonal matrix Q in the decomposition.">HessenbergDecomposition::matrixQ()</a>, <a class="el" href="class_tridiagonalization.html#aed4ce56784bd5c6d416a8f224a6e2b31" title="Returns the unitary matrix Q in the decomposition.">Tridiagonalization::matrixQ()</a>, <a class="el" href="class_householder_q_r.html#aaa5701b132355064b91758379e9a2939">HouseholderQR::householderQ()</a>, and <a class="el" href="class_col_piv_householder_q_r.html#ab3f9982c63b2f037c11d2cffddd0d338">ColPivHouseholderQR::householderQ()</a> all return a HouseholderSequence.</p>
<p>More precisely, the class HouseholderSequence represents an <img class="formulaInl" alt="$ n \times n $" src="form_238.png"/> matrix <img class="formulaInl" alt="$ H $" src="form_182.png"/> of the form <img class="formulaInl" alt="$ H = \prod_{i=0}^{n-1} H_i $" src="form_239.png"/> where the i-th Householder reflection is <img class="formulaInl" alt="$ H_i = I - h_i v_i v_i^* $" src="form_240.png"/>. The i-th Householder coefficient <img class="formulaInl" alt="$ h_i $" src="form_191.png"/> is a scalar and the i-th Householder vector <img class="formulaInl" alt="$ v_i $" src="form_193.png"/> is a vector of the form </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ v_i = [\underbrace{0, \ldots, 0}_{i-1\mbox{ zeros}}, 1, \underbrace{*, \ldots,*}_{n-i\mbox{ arbitrary entries}} ]. \]" src="form_241.png"/>
</p>
<p> The last <img class="formulaInl" alt="$ n-i $" src="form_242.png"/> entries of <img class="formulaInl" alt="$ v_i $" src="form_193.png"/> are called the essential part of the Householder vector.</p>
<p>Typical usages are listed below, where H is a <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>: </p>
<div class="fragment"><pre class="fragment"> A.applyOnTheRight(H); <span class="comment">// A = A * H</span>
A.applyOnTheLeft(H); <span class="comment">// A = H * A</span>
A.applyOnTheRight(H.adjoint()); <span class="comment">// A = A * H^*</span>
A.applyOnTheLeft(H.adjoint()); <span class="comment">// A = H^* * A</span>
MatrixXd Q = H; <span class="comment">// conversion to a dense matrix</span>
</pre></div><p> In addition to the adjoint, you can also apply the inverse (=adjoint), the transpose, and the conjugate operators.</p>
<p>See the documentation for <a class="el" href="class_householder_sequence.html#a09607ab897a02fe47458b8aa75ff554e" title="Constructor.">HouseholderSequence(const VectorsType&, const CoeffsType&)</a> for an example.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_matrix_base.html#a971dc304632f344591e82730f74389a1" title="replaces *this by *this * other.">MatrixBase::applyOnTheLeft()</a>, <a class="el" href="class_matrix_base.html#a6625c0ecbda2c07153c9290dcb91eedd" title="replaces *this by *this * other.">MatrixBase::applyOnTheRight()</a> </dd></dl>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00125">125</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p><code>#include <<a class="el" href="_householder_sequence_8h_source.html">src/Householder/HouseholderSequence.h</a>></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for HouseholderSequence< VectorsType, CoeffsType, Side >:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="class_householder_sequence__inherit__graph.png" border="0" usemap="#_householder_sequence_3_01_vectors_type_00_01_coeffs_type_00_01_side_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_householder_sequence_3_01_vectors_type_00_01_coeffs_type_00_01_side_01_4_inherit__map" id="_householder_sequence_3_01_vectors_type_00_01_coeffs_type_00_01_side_01_4_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="class_householder_sequence-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="class_householder_sequence.html">HouseholderSequence</a><br class="typebreak"/>
< VectorsType, typename <br class="typebreak"/>
<a class="el" href="structinternal_1_1conditional.html">internal::conditional</a><br class="typebreak"/>
< <a class="el" href="struct_num_traits.html">NumTraits</a>< <a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a> ><br class="typebreak"/>
::IsComplex, typename <br class="typebreak"/>
<a class="el" href="structinternal_1_1remove__all.html">internal::remove_all</a>< typename <br class="typebreak"/>
CoeffsType::ConjugateReturnType ><br class="typebreak"/>
::<a class="el" href="classinternal_1_1dense__xpr__base_1_1type.html">type</a>, CoeffsType >::<a class="el" href="classinternal_1_1dense__xpr__base_1_1type.html">type</a>, <br class="typebreak"/>
Side > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a581337cac172b40e8912da4d48755846">ConjugateReturnType</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a09607ab897a02fe47458b8aa75ff554e">HouseholderSequence</a> (const VectorsType &v, const CoeffsType &h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a09607ab897a02fe47458b8aa75ff554e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a0a55434561f6987f93a8eb74a4446fee">HouseholderSequence</a> (const <a class="el" href="class_householder_sequence.html">HouseholderSequence</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a0a55434561f6987f93a8eb74a4446fee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a12f4324c7a6f8dfd9753c7b7b3ff6bcf">rows</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of rows of transformation viewed as a matrix. <a href="#a12f4324c7a6f8dfd9753c7b7b3ff6bcf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a108d6052245f5922c03369ac9a5c9f24">cols</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of columns of transformation viewed as a matrix. <a href="#a108d6052245f5922c03369ac9a5c9f24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_block.html">EssentialVectorType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a5a151d626ad5ce6bb81820d8e9bbb771">essentialVector</a> (<a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> k) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Essential part of a Householder vector. <a href="#a5a151d626ad5ce6bb81820d8e9bbb771"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#acdad2de40f825a767a75b1b27dd251b0">transpose</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transpose of the Householder sequence. <a href="#acdad2de40f825a767a75b1b27dd251b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html">ConjugateReturnType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a4469b920a5b4f00cb61bd65e249d7e6f">conjugate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Complex conjugate of the Householder sequence. <a href="#a4469b920a5b4f00cb61bd65e249d7e6f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html">ConjugateReturnType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#afbd37bc94a6d582b5b75a9e901fbc3f9">adjoint</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjoint (conjugate transpose) of the Householder sequence. <a href="#afbd37bc94a6d582b5b75a9e901fbc3f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html">ConjugateReturnType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#ae185384ec848e1ee8848e6f4add921e9">inverse</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inverse of the Householder sequence (equals the adjoint). <a href="#ae185384ec848e1ee8848e6f4add921e9"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename DestType > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a80d43150849006e9c4ebeacf9b3b7249">evalTo</a> (DestType &dst) const </td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename Dest > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#ab79af67bb92dfd63968ee8f4b5071ec2">applyThisOnTheRight</a> (Dest &dst) const </td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename Dest > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a56235aad7107c9b86a6c3b4a456f8094">applyThisOnTheLeft</a> (Dest &dst) const </td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename OtherDerived > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structinternal_1_1matrix__type__times__scalar__type.html">internal::matrix_type_times_scalar_type</a><br class="typebreak"/>
< <a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a>, OtherDerived >::Type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a69f2d63f77cdd9edd39c7e1a9a187223">operator*</a> (const <a class="el" href="class_matrix_base.html">MatrixBase</a>< OtherDerived > &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computes the product of a Householder sequence with a matrix. <a href="#a69f2d63f77cdd9edd39c7e1a9a187223"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a2bd35025c253e4f444ff34df6fdf9207">setTrans</a> (bool trans)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the transpose flag. <a href="#a2bd35025c253e4f444ff34df6fdf9207"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a799231e5f66bcfb628131d43dd117a0b">setLength</a> (<a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the length of the Householder sequence. <a href="#a799231e5f66bcfb628131d43dd117a0b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a1de7acd7458775b2ae8c125b8ef6c68e">setShift</a> (<a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> shift)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the shift of the Householder sequence. <a href="#a1de7acd7458775b2ae8c125b8ef6c68e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a5ff0d726fa449b4ce9c6a0de215e277f">trans</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the transpose flag. <a href="#a5ff0d726fa449b4ce9c6a0de215e277f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a0074371b2deb5b2d40e9d7e9c4f5a6a0">length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of the Householder sequence. <a href="#a0074371b2deb5b2d40e9d7e9c4f5a6a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a4ae9280826776c50f845f0f9388058dc">shift</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the shift of the Householder sequence. <a href="#a4ae9280826776c50f845f0f9388058dc"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">VectorsType::Nested </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#acadf3596b9acb628c06509125f227860">m_vectors</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CoeffsType::Nested </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#ae613856e2e1a4ac2cf075d5f7cffe8ee">m_coeffs</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a09c44102bc0daf84ed44e50c5a9b85cb">m_trans</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a0691dadf31f89d4e1801f3e960dfab9a">m_length</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a2bc14ecf5a07f2cf96248a28cc324d7c">m_shift</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="class_householder_sequence.html#ab41c0b509f39c02d42b38b1db891a08ca1fabc3234c13586f3902fac0713aaf75">RowsAtCompileTime</a> = internal::traits<HouseholderSequence>::RowsAtCompileTime,
<a class="el" href="class_householder_sequence.html#ab41c0b509f39c02d42b38b1db891a08ca3abe5d385499b6fcfac2954f33b93f7c">ColsAtCompileTime</a> = internal::traits<HouseholderSequence>::ColsAtCompileTime,
<a class="el" href="class_householder_sequence.html#ab41c0b509f39c02d42b38b1db891a08ca68267fd2f2d85d211f8a0f4fd42ac37f">MaxRowsAtCompileTime</a> = internal::traits<HouseholderSequence>::MaxRowsAtCompileTime,
<a class="el" href="class_householder_sequence.html#ab41c0b509f39c02d42b38b1db891a08ca3e8e3133164dec9bb5012a6bb25596b9">MaxColsAtCompileTime</a> = internal::traits<HouseholderSequence>::MaxColsAtCompileTime
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef internal::traits<br class="typebreak"/>
< <a class="el" href="class_householder_sequence.html">HouseholderSequence</a> ><br class="typebreak"/>
::<a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef VectorsType::Index </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
<a class="el" href="structinternal_1_1hseq__side__dependent__impl.html">internal::hseq_side_dependent_impl</a><br class="typebreak"/>
< VectorsType, CoeffsType, <br class="typebreak"/>
Side >::<a class="el" href="class_block.html">EssentialVectorType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#a5b0534a75fe0cf340370dd2200287ad1">EssentialVectorType</a></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#abd776150e5af1fe542b7cfb3f549571e">internal::hseq_side_dependent_impl</a></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename OtherDerived > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structinternal_1_1matrix__type__times__scalar__type.html">internal::matrix_type_times_scalar_type</a><br class="typebreak"/>
< <a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a>, OtherDerived >::Type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_householder_sequence.html#ab3aca94e7a244eca60489f2a84628765">operator*</a> (const <a class="el" href="class_matrix_base.html">MatrixBase</a>< OtherDerived > &other, const <a class="el" href="class_householder_sequence.html">HouseholderSequence</a> &h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Computes the product of a matrix with a Householder sequence. <a href="#ab3aca94e7a244eca60489f2a84628765"></a><br/></td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a581337cac172b40e8912da4d48755846"></a><!-- doxytag: member="HouseholderSequence::ConjugateReturnType" ref="a581337cac172b40e8912da4d48755846" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, typename <a class="el" href="structinternal_1_1conditional.html">internal::conditional</a><<a class="el" href="struct_num_traits.html">NumTraits</a><<a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a>>::IsComplex, typename <a class="el" href="structinternal_1_1remove__all.html">internal::remove_all</a><typename CoeffsType::ConjugateReturnType>::<a class="el" href="classinternal_1_1dense__xpr__base_1_1type.html">type</a>, CoeffsType>::<a class="el" href="classinternal_1_1dense__xpr__base_1_1type.html">type</a>, Side > <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html">ConjugateReturnType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00148">148</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5b0534a75fe0cf340370dd2200287ad1"></a><!-- doxytag: member="HouseholderSequence::EssentialVectorType" ref="a5b0534a75fe0cf340370dd2200287ad1" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structinternal_1_1hseq__side__dependent__impl.html">internal::hseq_side_dependent_impl</a><VectorsType,CoeffsType,Side>::<a class="el" href="class_block.html">EssentialVectorType</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_block.html">EssentialVectorType</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00138">138</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<a class="anchor" id="a389bc616f0a5f738303a3a3145e6ddf5"></a><!-- doxytag: member="HouseholderSequence::Index" ref="a389bc616f0a5f738303a3a3145e6ddf5" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">typedef VectorsType::Index <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="struct_eigen_base.html#ae16d01a6ef4203489bca06ca933fe410">EigenBase< HouseholderSequence< VectorsType, CoeffsType, Side > ></a>.</p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00135">135</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<a class="anchor" id="a399d89db728ffd324c2bfa92212ffc6b"></a><!-- doxytag: member="HouseholderSequence::Scalar" ref="a399d89db728ffd324c2bfa92212ffc6b" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">typedef internal::traits<<a class="el" href="class_householder_sequence.html">HouseholderSequence</a>>::<a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00134">134</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ab41c0b509f39c02d42b38b1db891a08c"></a><!-- doxytag: member="HouseholderSequence::@377" ref="ab41c0b509f39c02d42b38b1db891a08c" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">anonymous enum<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ab41c0b509f39c02d42b38b1db891a08ca1fabc3234c13586f3902fac0713aaf75"></a><!-- doxytag: member="RowsAtCompileTime" ref="ab41c0b509f39c02d42b38b1db891a08ca1fabc3234c13586f3902fac0713aaf75" args="" -->RowsAtCompileTime</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab41c0b509f39c02d42b38b1db891a08ca3abe5d385499b6fcfac2954f33b93f7c"></a><!-- doxytag: member="ColsAtCompileTime" ref="ab41c0b509f39c02d42b38b1db891a08ca3abe5d385499b6fcfac2954f33b93f7c" args="" -->ColsAtCompileTime</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab41c0b509f39c02d42b38b1db891a08ca68267fd2f2d85d211f8a0f4fd42ac37f"></a><!-- doxytag: member="MaxRowsAtCompileTime" ref="ab41c0b509f39c02d42b38b1db891a08ca68267fd2f2d85d211f8a0f4fd42ac37f" args="" -->MaxRowsAtCompileTime</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab41c0b509f39c02d42b38b1db891a08ca3e8e3133164dec9bb5012a6bb25596b9"></a><!-- doxytag: member="MaxColsAtCompileTime" ref="ab41c0b509f39c02d42b38b1db891a08ca3e8e3133164dec9bb5012a6bb25596b9" args="" -->MaxColsAtCompileTime</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00128">128</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a09607ab897a02fe47458b8aa75ff554e"></a><!-- doxytag: member="HouseholderSequence::HouseholderSequence" ref="a09607ab897a02fe47458b8aa75ff554e" args="(const VectorsType &v, const CoeffsType &h)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html">HouseholderSequence</a> </td>
<td>(</td>
<td class="paramtype">const VectorsType & </td>
<td class="paramname"> <em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const CoeffsType & </td>
<td class="paramname"> <em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">v</td><td>Matrix containing the essential parts of the Householder vectors </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Vector containing the Householder coefficients</td></tr>
</table>
</dd>
</dl>
<p>Constructs the Householder sequence with coefficients given by <code>h</code> and vectors given by <code>v</code>. The i-th Householder coefficient <img class="formulaInl" alt="$ h_i $" src="form_191.png"/> is given by <code>h(i)</code> and the essential part of the i-th Householder vector <img class="formulaInl" alt="$ v_i $" src="form_193.png"/> is given by <code>v(k,i)</code> with <code>k</code> > <code>i</code> (the subdiagonal part of the i-th column). If <code>v</code> has fewer columns than rows, then the Householder sequence contains as many Householder reflections as there are columns.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The HouseholderSequence object stores <code>v</code> and <code>h</code> by reference.</dd></dl>
<p>Example: </p>
<div class="fragment"><pre class="fragment"></pre></div><p> Output: </p>
<div class="fragment"><pre class="fragment"></pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_householder_sequence.html#a799231e5f66bcfb628131d43dd117a0b" title="Sets the length of the Householder sequence.">setLength()</a>, <a class="el" href="class_householder_sequence.html#a1de7acd7458775b2ae8c125b8ef6c68e" title="Sets the shift of the Householder sequence.">setShift()</a> </dd></dl>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00167">167</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00216">HouseholderSequence< VectorsType, CoeffsType, Side >::transpose()</a>.</p>
</div>
</div>
<a class="anchor" id="a0a55434561f6987f93a8eb74a4446fee"></a><!-- doxytag: member="HouseholderSequence::HouseholderSequence" ref="a0a55434561f6987f93a8eb74a4446fee" args="(const HouseholderSequence &other)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html">HouseholderSequence</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side > & </td>
<td class="paramname"> <em>other</em> )</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00174">174</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afbd37bc94a6d582b5b75a9e901fbc3f9"></a><!-- doxytag: member="HouseholderSequence::adjoint" ref="afbd37bc94a6d582b5b75a9e901fbc3f9" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">ConjugateReturnType</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::adjoint </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjoint (conjugate transpose) of the Householder sequence. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00231">231</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00352">HouseholderSequence< VectorsType, CoeffsType, Side >::setTrans()</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00237">HouseholderSequence< VectorsType, CoeffsType, Side >::inverse()</a>.</p>
</div>
</div>
<a class="anchor" id="a56235aad7107c9b86a6c3b4a456f8094"></a><!-- doxytag: member="HouseholderSequence::applyThisOnTheLeft" ref="a56235aad7107c9b86a6c3b4a456f8094" args="(Dest &dst) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<div class="memtemplate">
template<typename Dest > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::applyThisOnTheLeft </td>
<td>(</td>
<td class="paramtype">Dest & </td>
<td class="paramname"> <em>dst</em> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="struct_eigen_base.html#ac754c473f22eef641a91e2ac71d27807">EigenBase< HouseholderSequence< VectorsType, CoeffsType, Side > ></a>.</p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00298">298</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00209">HouseholderSequence< VectorsType, CoeffsType, Side >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00396">HouseholderSequence< VectorsType, CoeffsType, Side >::m_coeffs</a>, <a class="el" href="_householder_sequence_8h_source.html#l00398">HouseholderSequence< VectorsType, CoeffsType, Side >::m_length</a>, <a class="el" href="_householder_sequence_8h_source.html#l00399">HouseholderSequence< VectorsType, CoeffsType, Side >::m_shift</a>, <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00187">HouseholderSequence< VectorsType, CoeffsType, Side >::rows()</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00317">HouseholderSequence< VectorsType, CoeffsType, Side >::operator*()</a>.</p>
</div>
</div>
<a class="anchor" id="ab79af67bb92dfd63968ee8f4b5071ec2"></a><!-- doxytag: member="HouseholderSequence::applyThisOnTheRight" ref="ab79af67bb92dfd63968ee8f4b5071ec2" args="(Dest &dst) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<div class="memtemplate">
template<typename Dest > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::applyThisOnTheRight </td>
<td>(</td>
<td class="paramtype">Dest & </td>
<td class="paramname"> <em>dst</em> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="struct_eigen_base.html#a80f46cbbdead5c9448811ed8f524c4d7">EigenBase< HouseholderSequence< VectorsType, CoeffsType, Side > ></a>.</p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00286">286</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00209">HouseholderSequence< VectorsType, CoeffsType, Side >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00396">HouseholderSequence< VectorsType, CoeffsType, Side >::m_coeffs</a>, <a class="el" href="_householder_sequence_8h_source.html#l00398">HouseholderSequence< VectorsType, CoeffsType, Side >::m_length</a>, <a class="el" href="_householder_sequence_8h_source.html#l00399">HouseholderSequence< VectorsType, CoeffsType, Side >::m_shift</a>, <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00187">HouseholderSequence< VectorsType, CoeffsType, Side >::rows()</a>.</p>
</div>
</div>
<a class="anchor" id="a108d6052245f5922c03369ac9a5c9f24"></a><!-- doxytag: member="HouseholderSequence::cols" ref="a108d6052245f5922c03369ac9a5c9f24" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::cols </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Number of columns of transformation viewed as a matrix. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of columns</dd></dl>
<p>This equals the dimension of the space that the transformation acts on. </p>
<p>Reimplemented from <a class="el" href="struct_eigen_base.html#a357bf06518b5140350e96e6c31b4cbb0">EigenBase< HouseholderSequence< VectorsType, CoeffsType, Side > ></a>.</p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00193">193</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00187">HouseholderSequence< VectorsType, CoeffsType, Side >::rows()</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>.</p>
</div>
</div>
<a class="anchor" id="a4469b920a5b4f00cb61bd65e249d7e6f"></a><!-- doxytag: member="HouseholderSequence::conjugate" ref="a4469b920a5b4f00cb61bd65e249d7e6f" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">ConjugateReturnType</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::conjugate </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Complex conjugate of the Householder sequence. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00222">222</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00396">HouseholderSequence< VectorsType, CoeffsType, Side >::m_coeffs</a>, <a class="el" href="_householder_sequence_8h_source.html#l00398">HouseholderSequence< VectorsType, CoeffsType, Side >::m_length</a>, <a class="el" href="_householder_sequence_8h_source.html#l00399">HouseholderSequence< VectorsType, CoeffsType, Side >::m_shift</a>, <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>, <a class="el" href="_householder_sequence_8h_source.html#l00395">HouseholderSequence< VectorsType, CoeffsType, Side >::m_vectors</a>, <a class="el" href="_householder_sequence_8h_source.html#l00367">HouseholderSequence< VectorsType, CoeffsType, Side >::setLength()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00384">HouseholderSequence< VectorsType, CoeffsType, Side >::setShift()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00352">HouseholderSequence< VectorsType, CoeffsType, Side >::setTrans()</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00231">HouseholderSequence< VectorsType, CoeffsType, Side >::adjoint()</a>.</p>
</div>
</div>
<a class="anchor" id="a5a151d626ad5ce6bb81820d8e9bbb771"></a><!-- doxytag: member="HouseholderSequence::essentialVector" ref="a5a151d626ad5ce6bb81820d8e9bbb771" args="(Index k) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_block.html">EssentialVectorType</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::essentialVector </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td>
<td class="paramname"> <em>k</em> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Essential part of a Householder vector. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">k</td><td>Index of Householder reflection </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Vector containing non-trivial entries of k-th Householder vector</dd></dl>
<p>This function returns the essential part of the Householder vector <img class="formulaInl" alt="$ v_i $" src="form_193.png"/>. This is a vector of length <img class="formulaInl" alt="$ n-i $" src="form_242.png"/> containing the last <img class="formulaInl" alt="$ n-i $" src="form_242.png"/> entries of the vector </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ v_i = [\underbrace{0, \ldots, 0}_{i-1\mbox{ zeros}}, 1, \underbrace{*, \ldots,*}_{n-i\mbox{ arbitrary entries}} ]. \]" src="form_241.png"/>
</p>
<p> The index <img class="formulaInl" alt="$ i $" src="form_192.png"/> equals <code>k</code> + <a class="el" href="class_householder_sequence.html#a4ae9280826776c50f845f0f9388058dc" title="Returns the shift of the Householder sequence.">shift()</a>, corresponding to the k-th column of the matrix <code>v</code> passed to the constructor.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_householder_sequence.html#a1de7acd7458775b2ae8c125b8ef6c68e" title="Sets the shift of the Householder sequence.">setShift()</a>, <a class="el" href="class_householder_sequence.html#a4ae9280826776c50f845f0f9388058dc" title="Returns the shift of the Householder sequence.">shift()</a> </dd></dl>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00209">209</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_macros_8h_source.html#l00122">eigen_assert</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00398">HouseholderSequence< VectorsType, CoeffsType, Side >::m_length</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00298">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheLeft()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00286">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheRight()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>.</p>
</div>
</div>
<a class="anchor" id="a80d43150849006e9c4ebeacf9b3b7249"></a><!-- doxytag: member="HouseholderSequence::evalTo" ref="a80d43150849006e9c4ebeacf9b3b7249" args="(DestType &dst) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<div class="memtemplate">
template<typename DestType > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::evalTo </td>
<td>(</td>
<td class="paramtype">DestType & </td>
<td class="paramname"> <em>dst</em> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00240">240</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_constants_8h_source.html#l00208">AutoAlign</a>, <a class="el" href="_constants_8h_source.html#l00205">ColMajor</a>, <a class="el" href="_householder_sequence_8h_source.html#l00193">HouseholderSequence< VectorsType, CoeffsType, Side >::cols()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00209">HouseholderSequence< VectorsType, CoeffsType, Side >::essentialVector()</a>, <a class="el" href="_blas_util_8h_source.html#l00266">internal::extract_data()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00396">HouseholderSequence< VectorsType, CoeffsType, Side >::m_coeffs</a>, <a class="el" href="_householder_sequence_8h_source.html#l00398">HouseholderSequence< VectorsType, CoeffsType, Side >::m_length</a>, <a class="el" href="_householder_sequence_8h_source.html#l00399">HouseholderSequence< VectorsType, CoeffsType, Side >::m_shift</a>, <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>, <a class="el" href="_householder_sequence_8h_source.html#l00395">HouseholderSequence< VectorsType, CoeffsType, Side >::m_vectors</a>, <a class="el" href="_householder_sequence_8h_source.html#l00131">HouseholderSequence< VectorsType, CoeffsType, Side >::MaxRowsAtCompileTime</a>, <a class="el" href="_householder_sequence_8h_source.html#l00187">HouseholderSequence< VectorsType, CoeffsType, Side >::rows()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00129">HouseholderSequence< VectorsType, CoeffsType, Side >::RowsAtCompileTime</a>.</p>
</div>
</div>
<a class="anchor" id="ae185384ec848e1ee8848e6f4add921e9"></a><!-- doxytag: member="HouseholderSequence::inverse" ref="ae185384ec848e1ee8848e6f4add921e9" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">ConjugateReturnType</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::inverse </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inverse of the Householder sequence (equals the adjoint). </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00237">237</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00231">HouseholderSequence< VectorsType, CoeffsType, Side >::adjoint()</a>.</p>
</div>
</div>
<a class="anchor" id="a0074371b2deb5b2d40e9d7e9c4f5a6a0"></a><!-- doxytag: member="HouseholderSequence::length" ref="a0074371b2deb5b2d40e9d7e9c4f5a6a0" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::length </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the length of the Householder sequence. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00391">391</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00398">HouseholderSequence< VectorsType, CoeffsType, Side >::m_length</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00367">HouseholderSequence< VectorsType, CoeffsType, Side >::setLength()</a>.</p>
</div>
</div>
<a class="anchor" id="a69f2d63f77cdd9edd39c7e1a9a187223"></a><!-- doxytag: member="HouseholderSequence::operator*" ref="a69f2d63f77cdd9edd39c7e1a9a187223" args="(const MatrixBase< OtherDerived > &other) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<div class="memtemplate">
template<typename OtherDerived > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structinternal_1_1matrix__type__times__scalar__type.html">internal::matrix_type_times_scalar_type</a><<a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a>, OtherDerived>::Type <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::operator* </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_matrix_base.html">MatrixBase</a>< OtherDerived > & </td>
<td class="paramname"> <em>other</em> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Computes the product of a Householder sequence with a matrix. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>Matrix being multiplied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Expression object representing the product.</dd></dl>
<p>This function computes <img class="formulaInl" alt="$ HM $" src="form_243.png"/> where <img class="formulaInl" alt="$ H $" src="form_182.png"/> is the Householder sequence represented by <code>*this</code> and <img class="formulaInl" alt="$ M $" src="form_14.png"/> is the matrix <code>other</code>. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00317">317</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00298">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheLeft()</a>, and <a class="el" href="_common_cwise_unary_ops_8h_source.html#l00107">cast()</a>.</p>
</div>
</div>
<a class="anchor" id="a12f4324c7a6f8dfd9753c7b7b3ff6bcf"></a><!-- doxytag: member="HouseholderSequence::rows" ref="a12f4324c7a6f8dfd9753c7b7b3ff6bcf" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::rows </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Number of rows of transformation viewed as a matrix. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of rows</dd></dl>
<p>This equals the dimension of the space that the transformation acts on. </p>
<p>Reimplemented from <a class="el" href="struct_eigen_base.html#ae36c3b1f4e279e8c2ef60430dc32da35">EigenBase< HouseholderSequence< VectorsType, CoeffsType, Side > ></a>.</p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00187">187</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00395">HouseholderSequence< VectorsType, CoeffsType, Side >::m_vectors</a>, and <a class="el" href="_constants_8h_source.html#l00216">OnTheLeft</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00298">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheLeft()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00286">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheRight()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00193">HouseholderSequence< VectorsType, CoeffsType, Side >::cols()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00108">internal::hseq_side_dependent_impl< VectorsType, CoeffsType, OnTheRight >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00095">internal::hseq_side_dependent_impl< VectorsType, CoeffsType, Side >::essentialVector()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>.</p>
</div>
</div>
<a class="anchor" id="a799231e5f66bcfb628131d43dd117a0b"></a><!-- doxytag: member="HouseholderSequence::setLength" ref="a799231e5f66bcfb628131d43dd117a0b" args="(Index length)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a>& <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::setLength </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td>
<td class="paramname"> <em>length</em> )</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the length of the Householder sequence. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>New value for the length.</td></tr>
</table>
</dd>
</dl>
<p>By default, the length <img class="formulaInl" alt="$ n $" src="form_160.png"/> of the Householder sequence <img class="formulaInl" alt="$ H = H_0 H_1 \ldots H_{n-1} $" src="form_246.png"/> is set to the number of columns of the matrix <code>v</code> passed to the constructor, or the number of rows if that is smaller. After this function is called, the length equals <code>length</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_householder_sequence.html#a0074371b2deb5b2d40e9d7e9c4f5a6a0" title="Returns the length of the Householder sequence.">length()</a> </dd></dl>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00367">367</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00391">HouseholderSequence< VectorsType, CoeffsType, Side >::length()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00398">HouseholderSequence< VectorsType, CoeffsType, Side >::m_length</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>.</p>
</div>
</div>
<a class="anchor" id="a1de7acd7458775b2ae8c125b8ef6c68e"></a><!-- doxytag: member="HouseholderSequence::setShift" ref="a1de7acd7458775b2ae8c125b8ef6c68e" args="(Index shift)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a>& <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::setShift </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> </td>
<td class="paramname"> <em>shift</em> )</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the shift of the Householder sequence. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>New value for the shift.</td></tr>
</table>
</dd>
</dl>
<p>By default, a HouseholderSequence object represents <img class="formulaInl" alt="$ H = H_0 H_1 \ldots H_{n-1} $" src="form_246.png"/> and the i-th column of the matrix <code>v</code> passed to the constructor corresponds to the i-th Householder reflection. After this function is called, the object represents <img class="formulaInl" alt="$ H = H_{\mathrm{shift}} H_{\mathrm{shift}+1} \ldots H_{n-1} $" src="form_247.png"/> and the i-th column of <code>v</code> corresponds to the (shift+i)-th Householder reflection.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_householder_sequence.html#a4ae9280826776c50f845f0f9388058dc" title="Returns the shift of the Householder sequence.">shift()</a> </dd></dl>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00384">384</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00399">HouseholderSequence< VectorsType, CoeffsType, Side >::m_shift</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00392">HouseholderSequence< VectorsType, CoeffsType, Side >::shift()</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>.</p>
</div>
</div>
<a class="anchor" id="a2bd35025c253e4f444ff34df6fdf9207"></a><!-- doxytag: member="HouseholderSequence::setTrans" ref="a2bd35025c253e4f444ff34df6fdf9207" args="(bool trans)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a>& <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::setTrans </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>trans</em> )</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the transpose flag. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">trans</td><td>New value of the transpose flag.</td></tr>
</table>
</dd>
</dl>
<p>By default, the transpose flag is not set. If the transpose flag is set, then this object represents <img class="formulaInl" alt="$ H^T = H_{n-1}^T \ldots H_1^T H_0^T $" src="form_245.png"/> instead of <img class="formulaInl" alt="$ H = H_0 H_1 \ldots H_{n-1} $" src="form_246.png"/>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_householder_sequence.html#a5ff0d726fa449b4ce9c6a0de215e277f" title="Returns the transpose flag.">trans()</a> </dd></dl>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00352">352</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00390">HouseholderSequence< VectorsType, CoeffsType, Side >::trans()</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00231">HouseholderSequence< VectorsType, CoeffsType, Side >::adjoint()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>.</p>
</div>
</div>
<a class="anchor" id="a4ae9280826776c50f845f0f9388058dc"></a><!-- doxytag: member="HouseholderSequence::shift" ref="a4ae9280826776c50f845f0f9388058dc" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::shift </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the shift of the Householder sequence. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00392">392</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00399">HouseholderSequence< VectorsType, CoeffsType, Side >::m_shift</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00384">HouseholderSequence< VectorsType, CoeffsType, Side >::setShift()</a>.</p>
</div>
</div>
<a class="anchor" id="a5ff0d726fa449b4ce9c6a0de215e277f"></a><!-- doxytag: member="HouseholderSequence::trans" ref="a5ff0d726fa449b4ce9c6a0de215e277f" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::trans </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the transpose flag. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00390">390</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00352">HouseholderSequence< VectorsType, CoeffsType, Side >::setTrans()</a>.</p>
</div>
</div>
<a class="anchor" id="acdad2de40f825a767a75b1b27dd251b0"></a><!-- doxytag: member="HouseholderSequence::transpose" ref="acdad2de40f825a767a75b1b27dd251b0" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html">HouseholderSequence</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::transpose </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transpose of the Householder sequence. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00216">216</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>References <a class="el" href="_householder_sequence_8h_source.html#l00167">HouseholderSequence< VectorsType, CoeffsType, Side >::HouseholderSequence()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00397">HouseholderSequence< VectorsType, CoeffsType, Side >::m_trans</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="abd776150e5af1fe542b7cfb3f549571e"></a><!-- doxytag: member="HouseholderSequence::internal::hseq_side_dependent_impl" ref="abd776150e5af1fe542b7cfb3f549571e" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">friend struct <a class="el" href="structinternal_1_1hseq__side__dependent__impl.html">internal::hseq_side_dependent_impl</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00342">342</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab3aca94e7a244eca60489f2a84628765"></a><!-- doxytag: member="HouseholderSequence::operator*" ref="ab3aca94e7a244eca60489f2a84628765" args="(const MatrixBase< OtherDerived > &other, const HouseholderSequence &h)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<div class="memtemplate">
template<typename OtherDerived > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structinternal_1_1matrix__type__times__scalar__type.html">internal::matrix_type_times_scalar_type</a><<a class="el" href="class_householder_sequence.html#a399d89db728ffd324c2bfa92212ffc6b">Scalar</a>, OtherDerived>::Type operator* </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_matrix_base.html">MatrixBase</a>< OtherDerived > & </td>
<td class="paramname"> <em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side > & </td>
<td class="paramname"> <em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Computes the product of a matrix with a Householder sequence. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>Matrix being multiplied. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>HouseholderSequence being multiplied. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Expression object representing the product.</dd></dl>
<p>This function computes <img class="formulaInl" alt="$ MH $" src="form_244.png"/> where <img class="formulaInl" alt="$ M $" src="form_14.png"/> is the matrix <code>other</code> and <img class="formulaInl" alt="$ H $" src="form_182.png"/> is the Householder sequence represented by <code>h</code>. </p>
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00334">334</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae613856e2e1a4ac2cf075d5f7cffe8ee"></a><!-- doxytag: member="HouseholderSequence::m_coeffs" ref="ae613856e2e1a4ac2cf075d5f7cffe8ee" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">CoeffsType::Nested <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html#ae613856e2e1a4ac2cf075d5f7cffe8ee">m_coeffs</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00396">396</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00298">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheLeft()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00286">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheRight()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>.</p>
</div>
</div>
<a class="anchor" id="a0691dadf31f89d4e1801f3e960dfab9a"></a><!-- doxytag: member="HouseholderSequence::m_length" ref="a0691dadf31f89d4e1801f3e960dfab9a" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html#a0691dadf31f89d4e1801f3e960dfab9a">m_length</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00398">398</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00298">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheLeft()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00286">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheRight()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00209">HouseholderSequence< VectorsType, CoeffsType, Side >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00391">HouseholderSequence< VectorsType, CoeffsType, Side >::length()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00367">HouseholderSequence< VectorsType, CoeffsType, Side >::setLength()</a>.</p>
</div>
</div>
<a class="anchor" id="a2bc14ecf5a07f2cf96248a28cc324d7c"></a><!-- doxytag: member="HouseholderSequence::m_shift" ref="a2bc14ecf5a07f2cf96248a28cc324d7c" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_householder_sequence.html#a389bc616f0a5f738303a3a3145e6ddf5">Index</a> <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html#a2bc14ecf5a07f2cf96248a28cc324d7c">m_shift</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00399">399</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00298">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheLeft()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00286">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheRight()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00108">internal::hseq_side_dependent_impl< VectorsType, CoeffsType, OnTheRight >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00095">internal::hseq_side_dependent_impl< VectorsType, CoeffsType, Side >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00384">HouseholderSequence< VectorsType, CoeffsType, Side >::setShift()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00392">HouseholderSequence< VectorsType, CoeffsType, Side >::shift()</a>.</p>
</div>
</div>
<a class="anchor" id="a09c44102bc0daf84ed44e50c5a9b85cb"></a><!-- doxytag: member="HouseholderSequence::m_trans" ref="a09c44102bc0daf84ed44e50c5a9b85cb" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html#a09c44102bc0daf84ed44e50c5a9b85cb">m_trans</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00397">397</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00231">HouseholderSequence< VectorsType, CoeffsType, Side >::adjoint()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00298">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheLeft()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00286">HouseholderSequence< VectorsType, CoeffsType, Side >::applyThisOnTheRight()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00352">HouseholderSequence< VectorsType, CoeffsType, Side >::setTrans()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00390">HouseholderSequence< VectorsType, CoeffsType, Side >::trans()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00216">HouseholderSequence< VectorsType, CoeffsType, Side >::transpose()</a>.</p>
</div>
</div>
<a class="anchor" id="acadf3596b9acb628c06509125f227860"></a><!-- doxytag: member="HouseholderSequence::m_vectors" ref="acadf3596b9acb628c06509125f227860" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename VectorsType, typename CoeffsType, int Side> </div>
<table class="memname">
<tr>
<td class="memname">VectorsType::Nested <a class="el" href="class_householder_sequence.html">HouseholderSequence</a>< VectorsType, CoeffsType, Side >::<a class="el" href="class_householder_sequence.html#acadf3596b9acb628c06509125f227860">m_vectors</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_householder_sequence_8h_source.html#l00395">395</a> of file <a class="el" href="_householder_sequence_8h_source.html">HouseholderSequence.h</a>.</p>
<p>Referenced by <a class="el" href="_householder_sequence_8h_source.html#l00222">HouseholderSequence< VectorsType, CoeffsType, Side >::conjugate()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00108">internal::hseq_side_dependent_impl< VectorsType, CoeffsType, OnTheRight >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00095">internal::hseq_side_dependent_impl< VectorsType, CoeffsType, Side >::essentialVector()</a>, <a class="el" href="_householder_sequence_8h_source.html#l00240">HouseholderSequence< VectorsType, CoeffsType, Side >::evalTo()</a>, and <a class="el" href="_householder_sequence_8h_source.html#l00187">HouseholderSequence< VectorsType, CoeffsType, Side >::rows()</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
