SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Encapsulates factorizations of positive definite symmetric matrices. See also RWPDBandFact<T> and RWPDTriDiagFact<T> . More...
#include <rw/lapack/pdfct.h>
Public Member Functions | |
RWPDFact () | |
RWPDFact (const fact_matrix &A, bool ec=true) | |
void | factor (const fact_matrix &A, bool ec=true) |
bool | good () const |
bool | fail () const |
bool | isSingular () const |
int | rows () const |
int | cols () const |
rw_numeric_traits< TypeT > ::norm_type | condition () const |
bool | isPD () const |
RWMathVec< TypeT > | solve (const RWMathVec< TypeT > &b) const |
RWGenMat< TypeT > | solve (const RWGenMat< TypeT > &b) const |
TypeT | determinant () const |
fact_matrix | inverse () const |
Related Functions | |
(Note that these are not member functions.) | |
template<class TypeT > | |
RWMathVec< TypeT > | solve (const RWPDFact< TypeT > &A, const RWMathVec< TypeT > &b) |
template<class TypeT > | |
RWGenMat< TypeT > | solve (const RWPDFact< TypeT > &A, const RWGenMat< TypeT > &b) |
template<class TypeT > | |
TypeT | determinant (const RWPDFact< TypeT > &A) |
template<class TypeT > | |
rw_linear_algebra_traits < TypeT >::hermitian_type | inverse (const RWPDFact< TypeT > &A) |
template<class TypeT > | |
rw_numeric_traits< TypeT > ::norm_type | condition (const RWPDFact< TypeT > &A) |
The classes RWPDFact<T>, RWPDBandFact<T>, and RWPDTriDiagFact<T> encapsulate factorizations of positive definite symmetric matrices, which are Hermitians in the complex case. These classes produce a valid factorization only if the matrix being factored is positive definite. If the matrix is not positive definite, attempting to use the factorization to solve a system of equations results in an exception being thrown. To test if the factorization is valid, use the good() or fail() member functions.
#include <rw/math/genmat.h> // RWGenMat<T>, class T general #include <rw/lapack/pdfct.h> #include <rw/lapack/pdbdfct.h> #include <rw/lapack/pdtdfct.h> RWGenFact<double> LU(A); // A is a RWGenMat<double> RWPDFact<double> LU4(D); // D is a RWPDMat<double> RWPDTriDiagFact<double> LU7(G); // G is a // RWPDTriDiagMat<double>
#include <iostream> #include <rw/dgenfct.h> int main() { // Read in a matrix and a right-hand side and // print the solution RWGenMat<double> A; RWMathVec<double> b; std::cin >> A >> b; RWGenFact<double> LU(A); if (LU.good()) { std::cout << "solution is " << solve(LU,b) << std::endl; } else { std::cout << "Could not factor A, perhaps it is singular" << std::endl; } return 0; }
Default constructor. Builds a factorization of a 0 x 0 matrix. You use the member function factor() to fill in the factorization.
RWPDFact< TypeT >::RWPDFact | ( | const fact_matrix & | A, | |
bool | ec = true | |||
) |
Constructs a factorization of the matrix A. This factorization can be used to solve systems of equations, and to calculate inverses and determinants. If the parameter ec is true
, you can use the function condition() to obtain an estimate of the condition number of the matrix. Setting ec to false
can save some computation if the condition number is not needed.
int RWPDFact< TypeT >::cols | ( | ) | const [inline] |
Returns the number of columns in the matrix represented by this factorization.
rw_numeric_traits<TypeT>::norm_type RWPDFact< TypeT >::condition | ( | ) | const |
Calculates the reciprocal condition number of the matrix represented by this factorization. If this number is near 0, the matrix is ill-conditioned and solutions to systems of equations computed using this factorization may not be accurate. If the number is near 1, the matrix is well-conditioned. For the condition number to be computed, the norm of the matrix must be computed at the time the factorization is constructed. If you set the optional boolean parameter in RWPDFact() or factor() to false
, calling condition() generates an exception.
TypeT RWPDFact< TypeT >::determinant | ( | ) | const |
Calculates the determinant of the matrix represented by this factorization.
void RWPDFact< TypeT >::factor | ( | const fact_matrix & | A, | |
bool | ec = true | |||
) |
Factors a matrix. Calling factor() replaces the current factorization with the factorization of the matrix A. This is commonly used to initialize a factorization constructed with the default (no arguments) constructor.
bool RWPDFact< TypeT >::fail | ( | ) | const |
Checks whether the factorization is successfully constructed. If fail() returns true
, attempting to use the factorization to solve a system of equations results in an exception being thrown.
bool RWPDFact< TypeT >::good | ( | ) | const [inline] |
Checks whether the factorization is successfully constructed. If good() returns false
, attempting to use the factorization to solve a system of equations results in an exception being thrown.
fact_matrix RWPDFact< TypeT >::inverse | ( | ) | const |
Computes the inverse of the matrix represented by this factorization. Although matrix inverses are very useful in theoretical analysis, they are rarely necessary in implementation. A factorization is nearly always as useful as the actual inverse, and can be constructed at far less cost.
bool RWPDFact< TypeT >::isPD | ( | ) | const |
Tests if the matrix is positive definite. If the matrix is not positive definite, the factorization is not complete and you cannot use the factorization to solve systems of equations.
bool RWPDFact< TypeT >::isSingular | ( | ) | const |
Tests if the matrix is singular to within machine precision. If the factorization is a positive definite type and the matrix that was factored is not actually positive definite, then isSingular() may return true
regardless of whether or not the matrix is actually singular.
int RWPDFact< TypeT >::rows | ( | ) | const [inline] |
Returns the number of rows in the matrix represented by this factorization.
rw_numeric_traits< TypeT >::norm_type condition | ( | const RWPDFact< TypeT > & | A | ) | [related] |
Calculates the reciprocal condition number of the matrix represented by the factorization A. If this number is near 0, the matrix is ill-conditioned and solutions to systems of equations computed using this factorization may not be accurate. If the number is near 1, the matrix is well-conditioned. For the condition number to be computed, the norm of the matrix must be computed at the time the factorization is constructed. If you set the optional boolean parameter in the constructor or the factor member function to false
, calling condition() generates an exception.
TypeT determinant | ( | const RWPDFact< TypeT > & | A | ) | [related] |
Calculates the determinant of the matrix represented by the factorization A.
rw_linear_algebra_traits< TypeT >::hermitian_type inverse | ( | const RWPDFact< TypeT > & | A | ) | [related] |
Computes the inverse of the matrix represented by the factorization A. Although matrix inverses are very useful in theoretical analysis, they are rarely necessary in implementation. A factorization is nearly always as useful as the actual inverse, and can be constructed at far less cost.
© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.