SourcePro C++ 13.0 |
SourcePro® C++ API Reference Guide |
Product Documentation: 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) | |
More... | |
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 |
void | factor (const RWHermMat< TypeT > &A, bool computeVecs=true) |
void | factor (const RWHermBandMat< TypeT > &A, bool computeVecs=true) |
More... | |
bool | fail () const |
bool | good () const |
bool | inaccurate () const |
unsigned | numEigenValues () const |
unsigned | numEigenVectors () const |
RWHermEigDecomp< TypeT > & | operator= (const RWHermEigDecomp< TypeT > &A) |
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:
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.
|
inline |
Returns the number of columns in the decomposed matrix.
double RWHermEigDecomp< TypeT >::eigenValue | ( | int | i | ) | const |
Returns the i th eigenvalue.
|
inline |
Returns a vector of all computed eigenvalues.
const RWMathVec<TypeT> RWHermEigDecomp< TypeT >::eigenVector | ( | int | i | ) | const |
Returns the i th eigenvector.
|
inline |
Returns a matrix whose columns are the eigenvectors.
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.
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.
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.
|
inline |
Returns the number of eigenvalues in this object.
|
inline |
Returns the number of eigenvectors in this object.
RWHermEigDecomp<TypeT>& RWHermEigDecomp< TypeT >::operator= | ( | const RWHermEigDecomp< TypeT > & | A | ) |
Assigns this decomposition the passed value. The current contents of the decomposition are lost.
|
inline |
Returns the number of rows in the decomposed matrix.
Copyright © 2014 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.
Provide feedback to Rogue Wave about its documentation.