SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Encapsulates the eigenvalues and eigenvectors of a Hermitian matrix. More...
#include <rw/lapack/hermeig.h>
Public Member Functions | |
RWHermEigDecomp () | |
RWHermEigDecomp (const RWHermMat< TypeT > &A, bool computeVecs=true) | |
RWHermEigDecomp (const RWHermBandMat< TypeT > &A, bool computeVecs=true) | |
void | factor (const RWHermMat< TypeT > &A, bool computeVecs=true) |
void | factor (const RWHermBandMat< TypeT > &A, bool computeVecs=true) |
void | operator= (const RWHermEigDecomp< TypeT > &A) |
unsigned | cols () const |
double | eigenValue (int i) const |
const RWMathVec< double > | eigenValues () const |
const RWMathVec< TypeT > | eigenVector (int i) const |
const RWGenMat< TypeT > | eigenVectors () const |
bool | good () const |
bool | inaccurate () const |
bool | fail () const |
unsigned | numEigenValues () const |
unsigned | numEigenVectors () const |
unsigned | rows () const |
The class RWHermEigDecomp<T> encapsulates the eigenvalues and eigenvectors of a Hermitian matrix. You can construct an eigenvalue decomposition object in two ways:
#include <rw/lapack/hermeig.h> // RWHermEigDecomp<T> RWHermEigDecomp<DComplex> eig(A); // A is an RWHermMat<DComplex>
#include <iostream> #include <rw/lapack/hermeig.h> int main() { RWHermMat<DComplex> A; std::cin >> A; RWHermEigDecomp<DComplex> eig(A); std::cout << "eigenvalues: " << eig.eigenValues() << std::endl; std::cout << "eigenvectors: " << eig.eigenVectors() << std::endl; return 0; }
RWHermEigDecomp< TypeT >::RWHermEigDecomp | ( | ) |
Default constructor. Builds a decomposition of a 0
x 0
matrix.
RWHermEigDecomp< TypeT >::RWHermEigDecomp | ( | const RWHermMat< TypeT > & | A, | |
bool | computeVecs = true | |||
) |
Constructs a representation of the eigenvalues and eigenvectors of the matrix A. The boolean parameter controls whether eigenvectors are computed.
RWHermEigDecomp< TypeT >::RWHermEigDecomp | ( | const RWHermBandMat< TypeT > & | A, | |
bool | computeVecs = true | |||
) |
Constructs a representation of the eigenvalues and eigenvectors of the matrix A. The boolean parameter controls whether eigenvectors are computed.
unsigned RWHermEigDecomp< TypeT >::cols | ( | ) | const [inline] |
Returns the number of columns in the decomposed matrix.
double RWHermEigDecomp< TypeT >::eigenValue | ( | int | i | ) | const |
Returns the i th eigenvalue.
const RWMathVec<double> RWHermEigDecomp< TypeT >::eigenValues | ( | ) | const [inline] |
Returns a vector of all computed eigenvalues.
const RWMathVec<TypeT> RWHermEigDecomp< TypeT >::eigenVector | ( | int | i | ) | const |
Returns the i th eigenvector.
const RWGenMat<TypeT> RWHermEigDecomp< TypeT >::eigenVectors | ( | ) | const [inline] |
Returns a matrix whose columns are the eigenvectors.
void RWHermEigDecomp< TypeT >::factor | ( | const RWHermBandMat< TypeT > & | A, | |
bool | computeVecs = true | |||
) |
Constructs a representation of the eigenvalues and eigenvectors of the matrix A. The boolean parameter controls whether eigenvectors are computed. The current contents of the decomposition are lost.
void RWHermEigDecomp< TypeT >::factor | ( | const RWHermMat< TypeT > & | A, | |
bool | computeVecs = true | |||
) |
Constructs a representation of the eigenvalues and eigenvectors of the matrix A. The boolean parameter controls whether eigenvectors are computed. The current contents of the decomposition are lost.
bool RWHermEigDecomp< TypeT >::fail | ( | ) | const |
Returns true
if an eigenvalue or eigenvector that is supposed to be computed fails to be computed.
bool RWHermEigDecomp< TypeT >::good | ( | ) | const |
Returns true
if all desired eigenvalues and eigenvectors are successfully computed to full desired accuracy.
bool RWHermEigDecomp< TypeT >::inaccurate | ( | ) | const |
Returns true
if either an eigenvalue or eigenvector that is supposed to be computed fails to be computed, or some of the computed quantities are not computed to full desired accuracy.
unsigned RWHermEigDecomp< TypeT >::numEigenValues | ( | ) | const [inline] |
Returns the number of eigenvalues in this object.
unsigned RWHermEigDecomp< TypeT >::numEigenVectors | ( | ) | const [inline] |
Returns the number of eigenvectors in this object.
void RWHermEigDecomp< TypeT >::operator= | ( | const RWHermEigDecomp< TypeT > & | A | ) |
Assigns this decomposition the passed value. The current contents of the decomposition are lost.
unsigned RWHermEigDecomp< TypeT >::rows | ( | ) | const [inline] |
Returns the number of rows in the decomposed matrix.
© 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.