SourcePro® API Reference Guide

 
List of all members | Public Member Functions
RWSymEigDecomp< TypeT > Class Template Reference

Encapsulates the eigenvalues and eigenvectors of a symmetric matrix. More...

#include <rw/lapack/symeig.h>

Public Member Functions

 RWSymEigDecomp ()
 
 RWSymEigDecomp (const RWSymEigDecomp< TypeT > &A)
 
 RWSymEigDecomp (const RWSymMat< TypeT > &A, bool computeVecs=true)
 
 RWSymEigDecomp (const RWSymBandMat< TypeT > &A, bool computeVecs=true)
 
unsigned cols () const
 
TypeT eigenValue (int i) const
 
const RWMathVec< TypeT > eigenValues () const
 
const RWMathVec< TypeT > eigenVector (int i) const
 
const RWGenMat< TypeT > eigenVectors () const
 
void factor (const RWSymMat< TypeT > &A, bool computeVecs=true)
 
void factor (const RWSymBandMat< TypeT > &A, bool computeVecs=true)
 
bool fail () const
 
bool good () const
 
bool inaccurate () const
 
unsigned numEigenValues () const
 
unsigned numEigenVectors () const
 
RWSymEigDecomp< TypeT > & operator= (const RWSymEigDecomp< TypeT > &A)
 
unsigned rows () const
 

Detailed Description

template<class TypeT>
class RWSymEigDecomp< TypeT >

The class RWSymEigDecomp encapsulates the eigenvalues and eigenvectors of a symmetric matrix. You can construct an eigenvalue decomposition object in two ways:

Synopsis
#include <rw/lapack/symeig.h> // RWSymEigDecomp<T>
RWSymEigDecomp<double> eig(A); // A is an RWSymMat<double>
Example
#include <iostream>
#include <rw/lapack/symeig.h>
int main()
{
std::cin >> A;
std::cout << "eigenvalues: " << eig.eigenValues() << std::endl;
std::cout << "eigenvectors: " << eig.eigenVectors() << std::endl;
return 0;
}

Constructor & Destructor Documentation

template<class TypeT>
RWSymEigDecomp< TypeT >::RWSymEigDecomp ( )

Default constructor. Builds a decomposition of a 0 x 0 matrix.

template<class TypeT>
RWSymEigDecomp< TypeT >::RWSymEigDecomp ( const RWSymEigDecomp< TypeT > &  A)

Copy and precision conversion constructor. Where possible, data is referenced for efficiency.

template<class TypeT>
RWSymEigDecomp< TypeT >::RWSymEigDecomp ( const RWSymMat< 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.

template<class TypeT>
RWSymEigDecomp< TypeT >::RWSymEigDecomp ( const RWSymBandMat< 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.

Member Function Documentation

template<class TypeT>
unsigned RWSymEigDecomp< TypeT >::cols ( ) const
inline

Returns the number of columns in the decomposed matrix.

template<class TypeT>
TypeT RWSymEigDecomp< TypeT >::eigenValue ( int  i) const

Returns the i th eigenvalue.

template<class TypeT>
const RWMathVec<TypeT> RWSymEigDecomp< TypeT >::eigenValues ( ) const
inline

Returns a vector of all computed eigenvalues.

template<class TypeT>
const RWMathVec<TypeT> RWSymEigDecomp< TypeT >::eigenVector ( int  i) const

Returns the i th eigenvector.

template<class TypeT>
const RWGenMat<TypeT> RWSymEigDecomp< TypeT >::eigenVectors ( ) const
inline

Returns a matrix whose columns are the eigenvectors.

template<class TypeT>
void RWSymEigDecomp< TypeT >::factor ( const RWSymMat< 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.

template<class TypeT>
void RWSymEigDecomp< TypeT >::factor ( const RWSymBandMat< 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.

template<class TypeT>
bool RWSymEigDecomp< TypeT >::fail ( ) const

Returns true if an eigenvalue or eigenvector that is supposed to be computed fails to be computed.

template<class TypeT>
bool RWSymEigDecomp< TypeT >::good ( ) const

Returns true if all desired eigenvalues and eigenvectors are successfully computed to full desired accuracy.

template<class TypeT>
bool RWSymEigDecomp< 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.

template<class TypeT>
unsigned RWSymEigDecomp< TypeT >::numEigenValues ( ) const
inline

Returns the number of eigenvalues in this object.

template<class TypeT>
unsigned RWSymEigDecomp< TypeT >::numEigenVectors ( ) const
inline

Returns the number of eigenvectors in this object.

template<class TypeT>
RWSymEigDecomp<TypeT>& RWSymEigDecomp< TypeT >::operator= ( const RWSymEigDecomp< TypeT > &  A)

Assigns this decomposition the passed value. The current contents of the decomposition are lost.

template<class TypeT>
unsigned RWSymEigDecomp< TypeT >::rows ( ) const
inline

Returns the number of rows in the decomposed matrix.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.