Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
concepts::Operator< F > Class Template Reference

Abstract class for an operator. More...

#include <compositions.hh>

Inheritance diagram for concepts::Operator< F >:
Inheritance graph
[legend]
Collaboration diagram for concepts::Operator< F >:
Collaboration graph
[legend]

List of all members.

Public Types

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

Public Member Functions

virtual const uint dimX () const
 Returns the size of the image space of the operator (number of rows of the corresponding matrix)
virtual const uint dimY () const
 Returns the size of the source space of the operator (number of columns of the corresponding matrix)
 Operator (uint dimX, uint dimY)
virtual void operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
 Application operator for complex function fncY.
virtual void operator() (const Function< r_type > &fncY, Function< F > &fncX)
 Application operator for real function fncY.
virtual ~Operator ()

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<class F>
class concepts::Operator< F >

Abstract class for an operator.

Definition at line 40 of file compositions.hh.


Member Typedef Documentation

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

Type of data, e.g. matrix entries.

Reimplemented in concepts::AfterIteration< F >, and concepts::SubMatrixN< F >.

Definition at line 43 of file compositions.hh.


Constructor & Destructor Documentation

template<class F>
concepts::Operator< F >::Operator ( uint  dimX,
uint  dimY 
) [inline]

Definition at line 49 of file compositions.hh.

template<class F>
virtual concepts::Operator< F >::~Operator ( ) [inline, virtual]

Definition at line 50 of file compositions.hh.


Member Function Documentation

template<class F>
virtual const uint concepts::Operator< F >::dimX ( ) const [inline, virtual]

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

Definition at line 87 of file compositions.hh.

template<class F>
virtual const uint concepts::Operator< F >::dimY ( ) const [inline, virtual]

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

Definition at line 92 of file compositions.hh.

template<class F>
virtual std::ostream& concepts::Operator< F >::info ( std::ostream &  os) const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in aglowav::C2W< F >, aglowav::W2C< F >, aglowav::C2_tl2< F >, aglowav::C2tl2< F >, aglowav::CGt2< F >, aglowav::ComposeN< F >, aglowav2::Operator00< F >, aglowav2::C2W< F >, aglowav2::W2C< F >, EquivalentStress2d, Advection< NumFlux >, bem::D< F >, bem::D_1< F >, cluster::Operator01< NodeX, NodeY >, cluster::Operator02< NodeX, NodeY >, hp3D::SpaceTransition, concepts::AfterIteration< F >, concepts::BiCGStab< F, G >, concepts::CG< F >, concepts::VecOperator< F >, concepts::Compose< F, H >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::Constrained, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::DiagonalSolver< F >, concepts::DDSolver< F, G >, concepts::GMRes< F >, concepts::LapackChol, concepts::NRLSolver, concepts::Pardiso, concepts::Permutation< F >, concepts::TrivExtendRestrict< F >, concepts::PETSc, concepts::PETScMat, concepts::SparseMatrix< F >, concepts::Spooles, concepts::SubMatrixN< F >, concepts::SuperLU< F >, concepts::Transpose< F >, concepts::Umfpack, sparseqr::Driver, sparseqr::GivensRotations< F >, vectorial::BlockOperator< F >, vectorial::BramblePasciak, vectorial::CGUzawa, concepts::VecOperator< Real >, concepts::Compose< F >, concepts::DenseMatrix< Cmplx >, concepts::DenseMatrix< Real >, concepts::DiagonalMatrix< Real >, concepts::Permutation< Real >, concepts::TrivExtendRestrict< Real >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, concepts::SparseMatrix< Real >, and sparseqr::GivensRotations< Real >.

template<class F>
virtual void concepts::Operator< F >::operator() ( const Function< r_type > &  fncY,
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 in concepts::VecOperator< F >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::DiagonalSolver< F >, concepts::Matrix< F >, concepts::Permutation< F >, concepts::SparseMatrix< F >, concepts::SubMatrixN< F >, concepts::Transpose< F >, concepts::VecOperator< Real >, concepts::DenseMatrix< Cmplx >, concepts::DenseMatrix< Real >, concepts::DiagonalMatrix< Real >, concepts::Matrix< concepts::Real >, concepts::Matrix< F::type >, concepts::Matrix< FX >, concepts::Matrix< T >, concepts::Matrix< Cmplx >, concepts::Matrix< Real >, concepts::Permutation< Real >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, and concepts::SparseMatrix< Real >.

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

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::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::DiagonalSolver< F >, concepts::Matrix< F >, concepts::Permutation< F >, concepts::SparseMatrix< F >, concepts::SubMatrixN< F >, concepts::Transpose< F >, concepts::VecOperator< Real >, concepts::DenseMatrix< Cmplx >, concepts::DenseMatrix< Real >, concepts::DiagonalMatrix< Real >, concepts::Matrix< concepts::Real >, concepts::Matrix< F::type >, concepts::Matrix< FX >, concepts::Matrix< T >, concepts::Matrix< Cmplx >, concepts::Matrix< Real >, concepts::Permutation< Real >, concepts::SparseMatrix< concepts::Real >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< T >, concepts::SparseMatrix< Cmplx >, and concepts::SparseMatrix< Real >.


Member Data Documentation

template<class F>
uint concepts::Operator< F >::dimX_ [protected]

Dimension of image space and the source space.

Definition at line 96 of file compositions.hh.

template<class F>
uint concepts::Operator< F >::dimY_ [protected]

Definition at line 96 of file compositions.hh.


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

Home | Doxygen Documentation | Tutorials | Developer Tools (restricted)