Abstract class for an operator. More...

#include <ARPACK.hh>

Inheritance diagram for concepts::Operator< F >:
concepts::Compose< F > concepts::AfterIteration< F > concepts::Compose< F, H > concepts::DDSolver< F, G > concepts::DiagonalSolver< F > concepts::LiCo< F > concepts::LiCoI< F > concepts::Multiple< F > concepts::VecOperator< F > sparseqr::GivensRotations< F > concepts::VecOperator< F::d_type > vectorial::BlockOperator< F >

Public Types

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

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) More...
 
virtual const uint dimY () const
 Returns the size of the source space of the operator (number of columns of the corresponding matrix) More...
 
 Operator (uint dimX, uint dimY)
 
virtual void operator() ()
 Application operator without argument. More...
 
virtual void operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
 Application operator for complex function fncY. More...
 
virtual void operator() (const Function< r_type > &fncY, Function< F > &fncX)
 Application operator for real function fncY. More...
 
virtual void show_messages ()
 
virtual ~Operator ()
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 

Protected Attributes

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

Detailed Description

template<class F>
class concepts::Operator< F >

Abstract class for an operator.

Definition at line 16 of file ARPACK.hh.

Member Typedef Documentation

◆ c_type

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

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

Real type of data type.

Definition at line 47 of file compositions.hh.

◆ type

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

Type of data, e.g. matrix entries.

Definition at line 45 of file compositions.hh.

Constructor & Destructor Documentation

◆ Operator()

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

Definition at line 51 of file compositions.hh.

◆ ~Operator()

template<class F >
virtual concepts::Operator< F >::~Operator ( )
inlinevirtual

Definition at line 52 of file compositions.hh.

Member Function Documentation

◆ dimX()

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

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

Definition at line 93 of file compositions.hh.

◆ dimY()

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

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

Definition at line 98 of file compositions.hh.

◆ info()

◆ operator()() [1/3]

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

◆ operator()() [2/3]

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::DiagonalSolver< F >, concepts::LiCo< F >, concepts::LiCoI< F >, concepts::Multiple< F >, concepts::VecOperator< F >, concepts::VecOperator< T >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Cmplx >, and concepts::VecOperator< Real >.

◆ operator()() [3/3]

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< T >, concepts::VecOperator< Real >, concepts::LiCo< F >, concepts::LiCoI< F >, concepts::Multiple< F >, concepts::VecOperator< F >, concepts::VecOperator< F::d_type >, and concepts::VecOperator< Cmplx >.

◆ show_messages()

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

Reimplemented in concepts::Newton< F >, concepts::MumpsOverlap< F >, and concepts::Mumps< F >.

Definition at line 100 of file compositions.hh.

Member Data Documentation

◆ dimX_

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

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_
protected

Definition at line 104 of file compositions.hh.


The documentation for this class was generated from the following files:
Page URL: http://wiki.math.ethz.ch/bin/view/Concepts/WebHome
21 August 2020
© 2020 Eidgenössische Technische Hochschule Zürich