HouseholderSequence.h File Reference

Go to the source code of this file.

Classes
class	HouseholderSequence< VectorsType, CoeffsType, Side >
	Sequence of Householder reflections acting on subspaces with decreasing size. More...
struct	internal::hseq_side_dependent_impl< VectorsType, CoeffsType, Side >
struct	internal::hseq_side_dependent_impl< VectorsType, CoeffsType, OnTheRight >
struct	internal::matrix_type_times_scalar_type< OtherScalarType, MatrixType >
struct	internal::traits< HouseholderSequence< VectorsType, CoeffsType, Side > >
Namespaces
namespace	internal
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 OtherDerived , typename VectorsType , typename CoeffsType , int Side>
internal::matrix_type_times_scalar_type < typename VectorsType::Scalar, OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other, const HouseholderSequence< VectorsType, CoeffsType, Side > &h)
	Computes the product of a matrix with 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.

---

Function Documentation

template<typename VectorsType , typename CoeffsType >

HouseholderSequence<VectorsType,CoeffsType> 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 412 of file HouseholderSequence.h.

template<typename OtherDerived , typename VectorsType , typename CoeffsType , int Side>

internal::matrix_type_times_scalar_type<typename VectorsType::Scalar,OtherDerived>::Type operator*	(	const MatrixBase< OtherDerived > &	other,
		const HouseholderSequence< VectorsType, CoeffsType, Side > &	h
	)

Computes the product of a matrix with a Householder sequence.

Parameters:

[in]	other	Matrix being multiplied.
[in]	h	HouseholderSequence being multiplied.

Returns:

Expression object representing the product.

This function computes where is the matrix other and is the Householder sequence represented by h.

Definition at line 399 of file HouseholderSequence.h.

template<typename VectorsType , typename CoeffsType >

HouseholderSequence<VectorsType,CoeffsType,OnTheRight> 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 424 of file HouseholderSequence.h.