Class documentation of Concepts

Loading...
Searching...
No Matches
sparseqr::GivensRotations< F > Class Template Reference

#include <givensRotations.hh>

Inheritance diagram for sparseqr::GivensRotations< F >:
concepts::Operator< F > concepts::OutputOperator

Public Types

typedef F type
 Type of data, e.g. matrix entries.
 
typedef Realtype< F >::type r_type
 Real type of data type.
 
typedef Cmplxtype< F >::type c_type
 Real type of data type.
 

Public Member Functions

template<class G >
 GivensRotations (const concepts::Space< G > &space, const Qmatrix &q, bool transpose)
 
 GivensRotations (uint dim, const Qmatrix &q, bool transpose)
 
virtual void operator() (const concepts::Function< F > &fncY, concepts::Function< F > &fncX)
 
void multiply (const concepts::Matrix< F > &fact, concepts::Matrix< F > &dest) const
 
void multiplyFirst (const concepts::Matrix< F > &fact, concepts::Matrix< F > &dest) const
 
virtual void operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
 
virtual void operator() ()
 
virtual const uint dimX () const
 
virtual const uint dimY () const
 
virtual void show_messages ()
 

Protected Member Functions

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

Protected Attributes

uint dimX_
 Dimension of image space and the source space.
 
uint dimY_
 

Detailed Description

template<typename F>
class sparseqr::GivensRotations< F >

Given's Rotations. This operator applies a list of givens rotations to a vector.

Parameters
FNumber type of vectors (Real or Cmplx)
GNumber type of space (Real)
transposeApplies the permutation (false) or its transpose (ie. its inverse, true)
Author
Philipp Frauenfelder, 2002
Test:

test::DeepCompositionsTest

test::GolubExample

test::GolubExampleSum

test::MaxwellTransmissionEVP

Definition at line 32 of file givensRotations.hh.

Member Typedef Documentation

◆ c_type

template<class F >
typedef Cmplxtype<F>::type concepts::Operator< F >::c_type
inherited

Real type of data type.

Definition at line 49 of file compositions.hh.

◆ r_type

template<class F >
typedef Realtype<F>::type concepts::Operator< F >::r_type
inherited

Real type of data type.

Definition at line 47 of file compositions.hh.

◆ type

template<class F >
typedef F concepts::Operator< F >::type
inherited

Type of data, e.g. matrix entries.

Definition at line 45 of file compositions.hh.

Constructor & Destructor Documentation

◆ GivensRotations() [1/2]

template<typename F >
template<class G >
sparseqr::GivensRotations< F >::GivensRotations ( const concepts::Space< G > &  space,
const Qmatrix q,
bool  transpose 
)
inline

Definition at line 35 of file givensRotations.hh.

◆ GivensRotations() [2/2]

template<typename F >
sparseqr::GivensRotations< F >::GivensRotations ( uint  dim,
const Qmatrix q,
bool  transpose 
)
inline

Definition at line 39 of file givensRotations.hh.

Member Function Documentation

◆ dimX()

template<class F >
virtual const uint concepts::Operator< F >::dimX ( ) const
inlinevirtualinherited

Returns the size of the image space of the operator (number of rows of the corresponding matrix)

Examples
hpFEM2d-simple.cc, hpFEM2d.cc, and matfileTutorial.cc.

Definition at line 93 of file compositions.hh.

◆ dimY()

template<class F >
virtual const uint concepts::Operator< F >::dimY ( ) const
inlinevirtualinherited

Returns the size of the source space of the operator (number of columns of the corresponding matrix)

Examples
matfileTutorial.cc.

Definition at line 98 of file compositions.hh.

◆ info()

template<typename F >
std::ostream & sparseqr::GivensRotations< F >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::Operator< F >.

Definition at line 154 of file givensRotations.hh.

◆ multiply()

template<typename F >
void sparseqr::GivensRotations< F >::multiply ( const concepts::Matrix< F > &  fact,
concepts::Matrix< F > &  dest 
) const

Computes fact times Givens and writes the result to dest.

Precondition
fact == dest

Definition at line 98 of file givensRotations.hh.

◆ multiplyFirst()

template<typename F >
void sparseqr::GivensRotations< F >::multiplyFirst ( const concepts::Matrix< F > &  fact,
concepts::Matrix< F > &  dest 
) const

Computes Givens times fact and writes the result to dest.

Precondition
fact == dest

Definition at line 126 of file givensRotations.hh.

◆ operator()() [1/3]

template<class F >
virtual void concepts::Operator< F >::operator() ( )
virtualinherited

◆ operator()() [2/3]

template<typename F >
void sparseqr::GivensRotations< F >::operator() ( const concepts::Function< F > &  fncY,
concepts::Function< F > &  fncX 
)
virtual

Application operator for real function fncY.

Computes fncX = A(fncY) where A is this operator.

fncX becomes the type of the operator, for real data it becomes real, for complex data it becomes complex.

In derived classes its enough to implement the operator() for real Operator's. If a complex counterpart is not implemented, the function fncY is transformed to a complex function and then the application operator for complex functions is called.

If in a derived class the operator() for real Operator's is not implemented, a exception is thrown from here.

Reimplemented from concepts::Operator< F >.

Definition at line 62 of file givensRotations.hh.

◆ operator()() [3/3]

template<class F >
virtual void concepts::Operator< F >::operator() ( const Function< c_type > &  fncY,
Function< c_type > &  fncX 
)
virtualinherited

Application operator for complex function fncY.

Computes fncX = A(fncY) where A is this operator. fncX becomes complex.

In derived classes its enough to implement the operator() for complex Operator's. If a real counterpart is not implemented, the function fncY is splitted into real and imaginary part and the application operator for real functions is called for each. Then the result is combined.

If in a derived class the operator() for complex Operator's is not implemented, a exception is thrown from here.

Reimplemented in concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, concepts::VecOperator< T >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::SubMatrixN< F >, concepts::Transpose< F >, concepts::Matrix< F >, concepts::Matrix< F::type >, concepts::Matrix< FX >, concepts::Matrix< Real >, and concepts::DiagonalSolver< F >.

◆ show_messages()

template<class F >
virtual void concepts::Operator< F >::show_messages ( )
inlinevirtualinherited

Reimplemented in concepts::MumpsOverlap< F >.

Definition at line 100 of file compositions.hh.

Member Data Documentation

◆ dimX_

template<class F >
uint concepts::Operator< F >::dimX_
protectedinherited

Dimension of image space and the source space.

Definition at line 104 of file compositions.hh.

◆ dimY_

template<class F >
uint concepts::Operator< F >::dimY_
protectedinherited

Definition at line 104 of file compositions.hh.


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