Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
Scaling< _MatrixType > Class Template Reference

#include <Scaling.h>

List of all members.

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)
VectorXd & LeftScaling ()
VectorXd & RightScaling ()
 Scaling ()
 Scaling (const MatrixType &matrix)
void setTolerance (double tol)
 ~Scaling ()

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 Scaling< _MatrixType >

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


Member Typedef Documentation

template<typename _MatrixType >
typedef MatrixType::Index Scaling< _MatrixType >::Index
template<typename _MatrixType >
typedef _MatrixType Scaling< _MatrixType >::MatrixType
template<typename _MatrixType >
typedef MatrixType::Scalar Scaling< _MatrixType >::Scalar

Constructor & Destructor Documentation

template<typename _MatrixType >
Scaling< _MatrixType >::Scaling ( ) [inline]
template<typename _MatrixType >
Scaling< _MatrixType >::Scaling ( const MatrixType matrix) [inline]
template<typename _MatrixType >
Scaling< _MatrixType >::~Scaling ( ) [inline]

Member Function Documentation

template<typename _MatrixType >
void Scaling< _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 Scaling< _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 Scaling< _MatrixType >::init ( ) [inline, protected]
template<typename _MatrixType >
VectorXd& Scaling< _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& Scaling< _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 Scaling< _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 Scaling< _MatrixType >::m_info [mutable, protected]
template<typename _MatrixType >
bool Scaling< _MatrixType >::m_isInitialized [protected]
template<typename _MatrixType >
VectorXd Scaling< _MatrixType >::m_left [protected]
template<typename _MatrixType >
MatrixType Scaling< _MatrixType >::m_matrix [protected]
template<typename _MatrixType >
int Scaling< _MatrixType >::m_maxits [protected]
template<typename _MatrixType >
VectorXd Scaling< _MatrixType >::m_right [protected]
template<typename _MatrixType >
double Scaling< _MatrixType >::m_tol [protected]

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


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:00