Householder module

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

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

Detailed Description

This module provides Householder transformations.

#include <Eigen/Householder>

Function Documentation

householderSequence()

template<typename VectorsType , typename CoeffsType >

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.

Definition at line 541 of file HouseholderSequence.h.

{
  return HouseholderSequence<VectorsType,CoeffsType,OnTheLeft>(v, h);
}

rightHouseholderSequence()

template<typename VectorsType , typename CoeffsType >

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.

Definition at line 553 of file HouseholderSequence.h.

{
  return HouseholderSequence<VectorsType,CoeffsType,OnTheRight>(v, h);
}