Eigne Matrix Class Library

Dependents:   Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more

Embed: (wiki syntax)

« Back to documentation index

Householder module

Householder module

This module provides Householder transformations. More...

Data Structures

class  HouseholderSequence< VectorsType, CoeffsType, Side >
  More...

Functions

template<typename VectorsType , typename CoeffsType >
HouseholderSequence
< VectorsType, CoeffsType > 
householderSequence (const VectorsType &v, const CoeffsType &h)
 \
template<typename VectorsType , typename CoeffsType >
HouseholderSequence
< VectorsType, CoeffsType,
OnTheRight > 
rightHouseholderSequence (const VectorsType &v, const CoeffsType &h)
 \

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.

Definition at line 422 of file HouseholderSequence.h.

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 434 of file HouseholderSequence.h.