WPILibC++ 2023.4.3-108-ge5452e3
Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::internal::UpperBidiagonalization< _MatrixType > Class Template Reference

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SVD/UpperBidiagonalization.h>

Public Types

enum  { RowsAtCompileTime = MatrixType::RowsAtCompileTime , ColsAtCompileTime = MatrixType::ColsAtCompileTime , ColsAtCompileTimeMinusOne = internal::decrement_size<ColsAtCompileTime>::ret }
 
typedef _MatrixType MatrixType
 
typedef MatrixType::Scalar Scalar
 
typedef MatrixType::RealScalar RealScalar
 
typedef Eigen::Index Index
 
typedef Matrix< Scalar, 1, ColsAtCompileTime > RowVectorType
 
typedef Matrix< Scalar, RowsAtCompileTime, 1 > ColVectorType
 
typedef BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0, RowMajor > BidiagonalType
 
typedef Matrix< Scalar, ColsAtCompileTime, 1 > DiagVectorType
 
typedef Matrix< Scalar, ColsAtCompileTimeMinusOne, 1 > SuperDiagVectorType
 
typedef HouseholderSequence< const MatrixType, const typename internal::remove_all< typename Diagonal< const MatrixType, 0 >::ConjugateReturnType >::type > HouseholderUSequenceType
 
typedef HouseholderSequence< const typename internal::remove_all< typename MatrixType::ConjugateReturnType >::type, Diagonal< const MatrixType, 1 >, OnTheRight > HouseholderVSequenceType
 

Public Member Functions

 UpperBidiagonalization ()
 Default Constructor. More...
 
 UpperBidiagonalization (const MatrixType &matrix)
 
UpperBidiagonalization & compute (const MatrixType &matrix)
 
UpperBidiagonalization & computeUnblocked (const MatrixType &matrix)
 
const MatrixType & householder () const
 
const BidiagonalType & bidiagonal () const
 
const HouseholderUSequenceType householderU () const
 
const HouseholderVSequenceType householderV ()
 

Protected Attributes

MatrixType m_householder
 
BidiagonalType m_bidiagonal
 
bool m_isInitialized
 

Member Typedef Documentation

◆ BidiagonalType

template<typename _MatrixType >
typedef BandMatrix<RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0, RowMajor> Eigen::internal::UpperBidiagonalization< _MatrixType >::BidiagonalType

◆ ColVectorType

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

◆ DiagVectorType

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

◆ 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

◆ HouseholderVSequenceType

template<typename _MatrixType >
typedef HouseholderSequence< const typename internal::remove_all<typename MatrixType::ConjugateReturnType>::type, Diagonal<const MatrixType,1>, OnTheRight > Eigen::internal::UpperBidiagonalization< _MatrixType >::HouseholderVSequenceType

◆ Index

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

◆ MatrixType

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

◆ RealScalar

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

◆ RowVectorType

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

◆ Scalar

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

◆ SuperDiagVectorType

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

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType >
anonymous enum
Enumerator
RowsAtCompileTime 
ColsAtCompileTime 
ColsAtCompileTimeMinusOne 

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&).

◆ UpperBidiagonalization() [2/2]

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

Member Function Documentation

◆ bidiagonal()

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

◆ compute()

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

◆ computeUnblocked()

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

◆ householder()

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

◆ householderU()

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

◆ householderV()

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

Member Data Documentation

◆ m_bidiagonal

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

◆ m_householder

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

◆ m_isInitialized

template<typename _MatrixType >
bool Eigen::internal::UpperBidiagonalization< _MatrixType >::m_isInitialized
protected
The documentation for this class was generated from the following file: