Class documentation of Concepts

Loading...
Searching...
No Matches

#include <driver.hh>

Inheritance diagram for sparseqr::Driver:
concepts::Operator< Real >

Public Member Functions

 Driver (const concepts::SparseMatrix< Real > &A)
 
concepts::Permutation< Real > * Prow ()
 Returns $P_r$.
 
concepts::Permutation< Real > * Pcol ()
 Returns $P_c$.
 
sparseqr::GivensRotations< Real > * Q ()
 Returns $Q$.
 
sparseqr::GivensRotations< Real > * Qt ()
 Returns $Q^\top$.
 
concepts::TrivExtendRestrict< Real > * restriction ()
 Returns the restriction from n to the last n-r degrees of freedom.
 
concepts::TrivExtendRestrict< Real > * extension ()
 Returns the extension from the last n-r to n degrees of freedom.
 
int rank ()
 Returns the rank of the matrix.
 
virtual void operator() (const concepts::Function< Real > &fncY, concepts::Function< Real > &fncX)
 
void operator() (const concepts::Vector< Real > &fncY, concepts::Vector< Real > &fncX)
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Private Member Functions

virtual void operator() (const Function< r_type > &fncY, Function< Real > &fncX)
 
virtual void operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
 
virtual void operator() ()
 

Detailed Description

Driver class for sparse QR decomposition. Performs a QR factorization on a sparse mxn matrix A, m>=n, such that

\[ P_r \cdot Q^\top \cdot A \cdot P_c^\top =
    \begin{pmatrix} R \\ 0 \end{pmatrix} \]

the different matrices can be asked for individually. At the same time, this class can act as a linear solver using the QR decomposition of the matrix.

Author
Philipp Frauenfelder, 2004
Test:

test::DriverTest

test::DeepCompositionsTest

Definition at line 34 of file driver.hh.

Constructor & Destructor Documentation

◆ Driver()

sparseqr::Driver::Driver ( const concepts::SparseMatrix< Real > &  A)
inline

Constructor. The constructor does not compute or copy anything, just initialises local variables.

Parameters
AMatrix to decompose

Definition at line 41 of file driver.hh.

Member Function Documentation

◆ info()

virtual std::ostream & sparseqr::Driver::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::Operator< Real >.

◆ rank()

int sparseqr::Driver::rank ( )
inline

Returns the rank of the matrix.

Definition at line 81 of file driver.hh.


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