Householder module

Classes
class	HouseholderSequence< VectorsType, CoeffsType, Side >
	Sequence of Householder reflections acting on subspaces with decreasing size. More...

Functions
template<typename VectorsType , typename CoeffsType >
HouseholderSequence < VectorsType, CoeffsType >	householderSequence (const VectorsType &v, const CoeffsType &h)
	Convenience function for constructing a Householder sequence.
template<typename VectorsType , typename CoeffsType >
HouseholderSequence < VectorsType, CoeffsType, OnTheRight >	rightHouseholderSequence (const VectorsType &v, const CoeffsType &h)
	Convenience function for constructing a Householder sequence.

---

Detailed Description

This module provides Householder transformations.

    #include <Eigen/Householder>

---

Function Documentation

HouseholderSequence<VectorsType,CoeffsType> Eigen::householderSequence	(	const VectorsType &	v,
		const CoeffsType &	h
	)

Convenience function for constructing a Householder sequence.

  % . \ # </> \

Returns:

A HouseholderSequence constructed from the specified arguments.

HouseholderSequence<VectorsType,CoeffsType,OnTheRight> Eigen::rightHouseholderSequence	(	const VectorsType &	v,
		const CoeffsType &	h
	)

Convenience function for constructing a Householder sequence.

      % . \ # </> \
\returns A HouseholderSequence constructed from the specified arguments.

This function differs from householderSequence() in that the template argument OnTheSide of the constructed HouseholderSequence is set to OnTheRight, instead of the default OnTheLeft.