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

#include <Scaling.h>

Public Types

typedef MatrixType::Index Index
 
typedef _MatrixType MatrixType
 
typedef MatrixType::Scalar Scalar
 

Public Member Functions

void compute (const MatrixType &mat)
 
void computeRef (MatrixType &mat)
 
 IterScaling ()
 
 IterScaling (const MatrixType &matrix)
 
VectorXd & LeftScaling ()
 
VectorXd & RightScaling ()
 
void setTolerance (double tol)
 
 ~IterScaling ()
 

Protected Member Functions

void init ()
 

Protected Attributes

ComputationInfo m_info
 
bool m_isInitialized
 
VectorXd m_left
 
MatrixType m_matrix
 
int m_maxits
 
VectorXd m_right
 
double m_tol
 

Detailed Description

template<typename _MatrixType>
class Eigen::IterScaling< _MatrixType >

Definition at line 47 of file unsupported/Eigen/src/IterativeSolvers/Scaling.h.

Member Typedef Documentation

template<typename _MatrixType >
typedef MatrixType::Index Eigen::IterScaling< _MatrixType >::Index
template<typename _MatrixType >
typedef _MatrixType Eigen::IterScaling< _MatrixType >::MatrixType
template<typename _MatrixType >
typedef MatrixType::Scalar Eigen::IterScaling< _MatrixType >::Scalar

Constructor & Destructor Documentation

template<typename _MatrixType >
Eigen::IterScaling< _MatrixType >::IterScaling ( )
inline
template<typename _MatrixType >
Eigen::IterScaling< _MatrixType >::IterScaling ( const MatrixType matrix)
inline
template<typename _MatrixType >
Eigen::IterScaling< _MatrixType >::~IterScaling ( )
inline

Member Function Documentation

template<typename _MatrixType >
void Eigen::IterScaling< _MatrixType >::compute ( const MatrixType mat)
inline

Compute the left and right diagonal matrices to scale the input matrix mat

FIXME This algorithm will be modified such that the diagonal elements are permuted on the diagonal.

See also
LeftScaling() RightScaling()

Definition at line 72 of file unsupported/Eigen/src/IterativeSolvers/Scaling.h.

template<typename _MatrixType >
void Eigen::IterScaling< _MatrixType >::computeRef ( MatrixType mat)
inline

Compute the left and right vectors to scale the vectors the input matrix is scaled with the computed vectors at output

See also
compute()

Definition at line 141 of file unsupported/Eigen/src/IterativeSolvers/Scaling.h.

template<typename _MatrixType >
void Eigen::IterScaling< _MatrixType >::init ( )
inlineprotected
template<typename _MatrixType >
VectorXd& Eigen::IterScaling< _MatrixType >::LeftScaling ( )
inline

Get the vector to scale the rows of the matrix

Definition at line 148 of file unsupported/Eigen/src/IterativeSolvers/Scaling.h.

template<typename _MatrixType >
VectorXd& Eigen::IterScaling< _MatrixType >::RightScaling ( )
inline

Get the vector to scale the columns of the matrix

Definition at line 155 of file unsupported/Eigen/src/IterativeSolvers/Scaling.h.

template<typename _MatrixType >
void Eigen::IterScaling< _MatrixType >::setTolerance ( double  tol)
inline

Set the tolerance for the convergence of the iterative scaling algorithm

Definition at line 162 of file unsupported/Eigen/src/IterativeSolvers/Scaling.h.

Member Data Documentation

template<typename _MatrixType >
ComputationInfo Eigen::IterScaling< _MatrixType >::m_info
mutableprotected
template<typename _MatrixType >
bool Eigen::IterScaling< _MatrixType >::m_isInitialized
protected
template<typename _MatrixType >
VectorXd Eigen::IterScaling< _MatrixType >::m_left
protected
template<typename _MatrixType >
MatrixType Eigen::IterScaling< _MatrixType >::m_matrix
protected
template<typename _MatrixType >
int Eigen::IterScaling< _MatrixType >::m_maxits
protected
template<typename _MatrixType >
VectorXd Eigen::IterScaling< _MatrixType >::m_right
protected
template<typename _MatrixType >
double Eigen::IterScaling< _MatrixType >::m_tol
protected

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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:35