Dense matrix and array manipulation » Reference » Householder module module

Contents

This module provides Householder transformations.

#include <Eigen/Householder>

Classes

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

Functions

template<typename VectorsType, typename CoeffsType>
auto householderSequence(const VectorsType& v, const CoeffsType& h) -> HouseholderSequence<VectorsType, CoeffsType>
Convenience function for constructing a Householder sequence.
template<typename VectorsType, typename CoeffsType>
auto rightHouseholderSequence(const VectorsType& v, const CoeffsType& h) -> HouseholderSequence<VectorsType, CoeffsType, OnTheRight>
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.

% . \ # </> \

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.