Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::internal::UpperBidiagonalization< _MatrixType > Class Template Reference

#include <UpperBidiagonalization.h>

Public Types

enum  { RowsAtCompileTime = MatrixType::RowsAtCompileTime, ColsAtCompileTime = MatrixType::ColsAtCompileTime, ColsAtCompileTimeMinusOne = internal::decrement_size<ColsAtCompileTime>::ret }
 
typedef BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0, RowMajorBidiagonalType
 
typedef Matrix< Scalar, RowsAtCompileTime, 1 > ColVectorType
 
typedef Matrix< Scalar, ColsAtCompileTime, 1 > DiagVectorType
 
typedef HouseholderSequence< const MatrixType, const typename internal::remove_all< typename Diagonal< const MatrixType, 0 >::ConjugateReturnType >::typeHouseholderUSequenceType
 
typedef HouseholderSequence< const typename internal::remove_all< typename MatrixType::ConjugateReturnType >::type, Diagonal< const MatrixType, 1 >, OnTheRightHouseholderVSequenceType
 
typedef Eigen::Index Index
 
typedef _MatrixType MatrixType
 
typedef MatrixType::RealScalar RealScalar
 
typedef Matrix< Scalar, 1, ColsAtCompileTimeRowVectorType
 
typedef MatrixType::Scalar Scalar
 
typedef Matrix< Scalar, ColsAtCompileTimeMinusOne, 1 > SuperDiagVectorType
 

Public Member Functions

const BidiagonalTypebidiagonal () const
 
UpperBidiagonalizationcompute (const MatrixType &matrix)
 
UpperBidiagonalizationcomputeUnblocked (const MatrixType &matrix)
 
const MatrixTypehouseholder () const
 
const HouseholderUSequenceType householderU () const
 
const HouseholderVSequenceType householderV ()
 
 UpperBidiagonalization ()
 Default Constructor. More...
 
 UpperBidiagonalization (const MatrixType &matrix)
 

Protected Attributes

BidiagonalType m_bidiagonal
 
MatrixType m_householder
 
bool m_isInitialized
 

Detailed Description

template<typename _MatrixType>
class Eigen::internal::UpperBidiagonalization< _MatrixType >

Definition at line 20 of file UpperBidiagonalization.h.

Member Typedef Documentation

◆ BidiagonalType

Definition at line 35 of file UpperBidiagonalization.h.

◆ ColVectorType

template<typename _MatrixType>
typedef Matrix<Scalar, RowsAtCompileTime, 1> Eigen::internal::UpperBidiagonalization< _MatrixType >::ColVectorType

Definition at line 34 of file UpperBidiagonalization.h.

◆ DiagVectorType

template<typename _MatrixType>
typedef Matrix<Scalar, ColsAtCompileTime, 1> Eigen::internal::UpperBidiagonalization< _MatrixType >::DiagVectorType

Definition at line 36 of file UpperBidiagonalization.h.

◆ HouseholderUSequenceType

template<typename _MatrixType>
typedef HouseholderSequence< const MatrixType, const typename internal::remove_all<typename Diagonal<const MatrixType,0>::ConjugateReturnType>::type > Eigen::internal::UpperBidiagonalization< _MatrixType >::HouseholderUSequenceType

Definition at line 41 of file UpperBidiagonalization.h.

◆ HouseholderVSequenceType

Definition at line 46 of file UpperBidiagonalization.h.

◆ Index

template<typename _MatrixType>
typedef Eigen::Index Eigen::internal::UpperBidiagonalization< _MatrixType >::Index
Deprecated:
since Eigen 3.3

Definition at line 32 of file UpperBidiagonalization.h.

◆ MatrixType

template<typename _MatrixType>
typedef _MatrixType Eigen::internal::UpperBidiagonalization< _MatrixType >::MatrixType

Definition at line 24 of file UpperBidiagonalization.h.

◆ RealScalar

template<typename _MatrixType>
typedef MatrixType::RealScalar Eigen::internal::UpperBidiagonalization< _MatrixType >::RealScalar

Definition at line 31 of file UpperBidiagonalization.h.

◆ RowVectorType

template<typename _MatrixType>
typedef Matrix<Scalar, 1, ColsAtCompileTime> Eigen::internal::UpperBidiagonalization< _MatrixType >::RowVectorType

Definition at line 33 of file UpperBidiagonalization.h.

◆ Scalar

template<typename _MatrixType>
typedef MatrixType::Scalar Eigen::internal::UpperBidiagonalization< _MatrixType >::Scalar

Definition at line 30 of file UpperBidiagonalization.h.

◆ SuperDiagVectorType

template<typename _MatrixType>
typedef Matrix<Scalar, ColsAtCompileTimeMinusOne, 1> Eigen::internal::UpperBidiagonalization< _MatrixType >::SuperDiagVectorType

Definition at line 37 of file UpperBidiagonalization.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType>
anonymous enum
Enumerator
RowsAtCompileTime 
ColsAtCompileTime 
ColsAtCompileTimeMinusOne 

Definition at line 25 of file UpperBidiagonalization.h.

Constructor & Destructor Documentation

◆ UpperBidiagonalization() [1/2]

template<typename _MatrixType>
Eigen::internal::UpperBidiagonalization< _MatrixType >::UpperBidiagonalization ( )
inline

Default Constructor.

The default constructor is useful in cases in which the user intends to perform decompositions via Bidiagonalization::compute(const MatrixType&).

Definition at line 54 of file UpperBidiagonalization.h.

◆ UpperBidiagonalization() [2/2]

template<typename _MatrixType>
Eigen::internal::UpperBidiagonalization< _MatrixType >::UpperBidiagonalization ( const MatrixType matrix)
inlineexplicit

Definition at line 56 of file UpperBidiagonalization.h.

Member Function Documentation

◆ bidiagonal()

template<typename _MatrixType>
const BidiagonalType& Eigen::internal::UpperBidiagonalization< _MatrixType >::bidiagonal ( ) const
inline

Definition at line 68 of file UpperBidiagonalization.h.

◆ compute()

template<typename _MatrixType >
UpperBidiagonalization< _MatrixType > & Eigen::internal::UpperBidiagonalization< _MatrixType >::compute ( const MatrixType matrix)

Definition at line 381 of file UpperBidiagonalization.h.

◆ computeUnblocked()

template<typename _MatrixType >
UpperBidiagonalization< _MatrixType > & Eigen::internal::UpperBidiagonalization< _MatrixType >::computeUnblocked ( const MatrixType matrix)

Definition at line 359 of file UpperBidiagonalization.h.

◆ householder()

template<typename _MatrixType>
const MatrixType& Eigen::internal::UpperBidiagonalization< _MatrixType >::householder ( ) const
inline

Definition at line 67 of file UpperBidiagonalization.h.

◆ householderU()

template<typename _MatrixType>
const HouseholderUSequenceType Eigen::internal::UpperBidiagonalization< _MatrixType >::householderU ( ) const
inline

Definition at line 70 of file UpperBidiagonalization.h.

◆ householderV()

template<typename _MatrixType>
const HouseholderVSequenceType Eigen::internal::UpperBidiagonalization< _MatrixType >::householderV ( )
inline

Definition at line 76 of file UpperBidiagonalization.h.

Member Data Documentation

◆ m_bidiagonal

template<typename _MatrixType>
BidiagonalType Eigen::internal::UpperBidiagonalization< _MatrixType >::m_bidiagonal
protected

Definition at line 86 of file UpperBidiagonalization.h.

◆ m_householder

template<typename _MatrixType>
MatrixType Eigen::internal::UpperBidiagonalization< _MatrixType >::m_householder
protected

Definition at line 85 of file UpperBidiagonalization.h.

◆ m_isInitialized

template<typename _MatrixType>
bool Eigen::internal::UpperBidiagonalization< _MatrixType >::m_isInitialized
protected

Definition at line 87 of file UpperBidiagonalization.h.


The documentation for this class was generated from the following file:


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:46:10