concepts::VecOperator< F > Class Template Referenceabstract
Abstract class for an operator acting on vectors only, not arbitrary functions. More...
#include <compositions.hh>
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... | |
| void | operator() () |
| Application method without second argument. Used for parallel solvers. 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... | |
| void | operator() (const Matrix< c_type > &mX, Matrix< c_type > &mY) |
| Application method to complex matrices. Calls apply_() More... | |
| void | operator() (const Matrix< r_type > &mX, Matrix< F > &mY) |
| Application method to real matrices. Calls function apply() More... | |
| virtual void | operator() (const Vector< c_type > &fncY, Vector< c_type > &fncX) |
Application operator for complex function fncY. More... | |
| virtual void | operator() (const Vector< r_type > &fncY, Vector< F > &fncX) |
Application operator for real vector fncY. More... | |
| virtual void | show_messages () |
| VecOperator (uint dimX, uint dimY) | |
Protected Member Functions | |
| virtual void | apply_ ()=0 |
| Intrinsic application method without argument. More... | |
| virtual void | apply_ (const Vector< F > &fncY, Vector< F > &fncX)=0 |
| Intrinsic application method, i.e. More... | |
| 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::VecOperator< F >
Abstract class for an operator acting on vectors only, not arbitrary functions.
Definition at line 115 of file compositions.hh.
Member Typedef Documentation
◆ c_type
| typedef Cmplxtype<F>::type concepts::VecOperator< F >::c_type |
Real type of data type.
Definition at line 120 of file compositions.hh.
◆ r_type
| typedef Realtype<F>::type concepts::VecOperator< F >::r_type |
Real type of data type.
Definition at line 118 of file compositions.hh.
◆ type
|
inherited |
Type of data, e.g. matrix entries.
Definition at line 45 of file compositions.hh.
Constructor & Destructor Documentation
◆ VecOperator()
|
inline |
Definition at line 122 of file compositions.hh.
Member Function Documentation
◆ apply_() [1/2]
|
protectedpure virtual |
Intrinsic application method without argument.
Implemented in concepts::SuperLU< F >, concepts::SolverConjugate, concepts::Newton< F >, concepts::MumpsOverlap< F >, concepts::Mumps< F >, concepts::LapackChol, concepts::GMRes< F >, concepts::CG< F >, concepts::BiCGStab< F, G >, concepts::BelosSolver< T >, and concepts::ShiftAndInvertOperatorForGEVPs< F >.
◆ apply_() [2/2]
|
protectedpure virtual |
Intrinsic application method, i.e.
real Operator and real Vector or complex Operator and real Vector.
Implemented in concepts::BelosSolver< T >, concepts::LapackChol, concepts::SuperLU< F >, concepts::MumpsOverlap< F >, concepts::Mumps< F >, concepts::GMRes< F >, concepts::CG< F >, concepts::BiCGStab< F, G >, concepts::ShiftAndInvertOperatorForGEVPs< F >, and concepts::SolverConjugate.
◆ dimX()
|
inlinevirtualinherited |
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()
|
inlinevirtualinherited |
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()
|
protectedvirtual |
Reimplemented from concepts::Operator< F >.
Reimplemented in concepts::SuperLU< F >, concepts::SolverConjugate, concepts::LapackChol, concepts::GMRes< F >, concepts::CG< F >, concepts::BiCGStab< F, G >, concepts::BelosSolver< T >, concepts::ShiftAndInvertOperatorForGEVPs< F >, concepts::MumpsOverlap< F >, and concepts::Mumps< F >.
◆ operator()() [1/7]
|
virtual |
Application method without second argument. Used for parallel solvers.
Reimplemented from concepts::Operator< F >.
◆ operator()() [2/7]
|
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 from concepts::Operator< F >.
◆ operator()() [3/7]
|
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 >.
◆ operator()() [4/7]
| void concepts::VecOperator< F >::operator() | ( | const Matrix< c_type > & | mX, |
| Matrix< c_type > & | mY | ||
| ) |
Application method to complex matrices. Calls apply_()
◆ operator()() [5/7]
| void concepts::VecOperator< F >::operator() | ( | const Matrix< r_type > & | mX, |
| Matrix< F > & | mY | ||
| ) |
Application method to real matrices. Calls function apply()
◆ operator()() [6/7]
|
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 vector fncY is splitted into real and imaginary part and the application operator for real vectors is called for each. Then the result is combined
If in a derived class the operator() for complex Operator's i not implemented, a exception is thrown from here.
◆ operator()() [7/7]
|
virtual |
Application operator for real vector fncY.
Computes fncX = A(fncY) where A is this operator.
Type of fncX becomes that 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 vector fncY is transformed to a complex vector and then the application for complex vectors is called.
If in a derived class the operator() for real Operator's is not implemented, a exception is thrown from here.
◆ show_messages()
|
inlinevirtualinherited |
Reimplemented in concepts::Newton< F >, concepts::MumpsOverlap< F >, and concepts::Mumps< F >.
Definition at line 100 of file compositions.hh.
Member Data Documentation
◆ dimX_
|
protectedinherited |
Dimension of image space and the source space.
Definition at line 104 of file compositions.hh.
◆ dimY_
|
protectedinherited |
Definition at line 104 of file compositions.hh.
The documentation for this class was generated from the following file:
- operator/compositions.hh