concepts::Compose< F, H > Class Template Reference

Computes the product of two operators. More...

#include <compositions.hh>

Inheritance diagram for concepts::Compose< F, H >:

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
bool	collapse (Matrix< F > &dest) const
	Collapses the composition of matrices into one matrix. More...
	Compose (Operator< F > &A, Operator< H > &B)
	Constructor. More...
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...
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...
void	operator() (const Function< F > &fncY, Function< F > &fncX)
	Application operator. More...
virtual void	operator() (const Function< r_type > &fncY, Function< F > &fncX)
	Application operator for real function fncY. More...
virtual void	show_messages ()

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_

Private Member Functions
void	collapse_ (DenseMatrix< F > &A, DenseMatrix< H > &B, Matrix< F > &dest) const

Private Attributes
Operator< F > &	A_
	First operator. More...
Operator< H > &	B_
	Second operator. More...
Vector< F >	f_
	Intermediate vector to store result after application of B. More...

Detailed Description

template<class F, class H = F>
class concepts::Compose< F, H >

Computes the product of two operators.

In reality, no product is computed but A is applied after B. If you really want to compute the matrix product, construct a new matrix operator and use the compose object as constructor argument.

Test:

test::CompositionsTest

test::DriverTest

test::MoreCompositionsTest

test::DeepCompositionsTest

Definition at line 190 of file compositions.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

Compose()

template<class F , class H >

concepts::Compose< F, H >::Compose ( Operator< F > &  A, Operator< H > &  B  )

inline

Constructor.

Definition at line 222 of file compositions.hh.

Member Function Documentation

collapse()

template<class F , class H = F>

bool concepts::Compose< F, H >::collapse

(

Matrix< F > &

dest

)

const

Collapses the composition of matrices into one matrix.

This only works in some rare combinations, test it out.

Returns

True, if the operation was succesful.

Parameters

dest	Matrix into which the operator should be collapsed. Should be zero on startup since the components are added into the matrix.

collapse_()

template<class F , class H = F>

void concepts::Compose< F, H >::collapse_ ( DenseMatrix< F > &  A, DenseMatrix< H > &  B, Matrix< F > &  dest  ) const

private

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)

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)

Definition at line 98 of file compositions.hh.

info()

template<class F , class H = F>

virtual std::ostream& concepts::Compose< F, H >::info ( std::ostream &  os ) const

protectedvirtual

Reimplemented from concepts::Operator< F >.

operator()() [1/4]

template<class F >

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

virtualinherited

Application operator without argument.

Reimplemented in concepts::VecOperator< F >, concepts::VecOperator< T >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Cmplx >, concepts::VecOperator< Real >, and concepts::BelosSolver< T >.

operator()() [2/4]

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::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/4]

template<class F , class H >

void concepts::Compose< F, H >::operator() ( const Function< F > &  fncY, Function< F > &  fncX  )

inline

Application operator.

Computes $x = A B y$.

Definition at line 231 of file compositions.hh.

operator()() [4/4]

template<class F >

virtual void concepts::Operator< F >::operator() ( const Function< r_type > &  fncY, Function< F > &  fncX  )

virtualinherited

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 ( )

inlinevirtualinherited

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

Definition at line 100 of file compositions.hh.

Member Data Documentation

A_

template<class F , class H = F>

Operator<F>& concepts::Compose< F, H >::A_

private

First operator.

Definition at line 212 of file compositions.hh.

B_

template<class F , class H = F>

Operator<H>& concepts::Compose< F, H >::B_

private

Second operator.

Definition at line 214 of file compositions.hh.

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.

f_

template<class F , class H = F>

Vector<F> concepts::Compose< F, H >::f_

private

Intermediate vector to store result after application of B.

Definition at line 216 of file compositions.hh.

---

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

• operator/compositions.hh