HLIBpro 3.1
Loading...
Searching...
No Matches
TMatrixProduct< T_value > Class Template Reference

Represents product α₁A₁ · α₂A₂ · α₃A₃... of matrices (linear ops)

#include <TMatrixProduct.hh>

Inheritance diagram for TMatrixProduct< T_value >:
TLinearOperator< T_value > TTypeInfo

Public Member Functions

 TMatrixProduct (const value_t alpha1, const TLinearOperator< value_t > *A1, const bool is_owner=false)
 single matrix
 
 TMatrixProduct (const value_t alpha1, const TLinearOperator< value_t > *A1, const value_t alpha2, const TLinearOperator< value_t > *A2, const bool is_owner=false)
 two matrices
 
 TMatrixProduct (const value_t alpha1, const TLinearOperator< value_t > *A1, const value_t alpha2, const TLinearOperator< value_t > *A2, const value_t alpha3, const TLinearOperator< value_t > *A3, const bool is_owner=false)
 three matrices
 
virtual bool is_complex () const
 return true, if field type is complex
 
virtual bool is_self_adjoint () const
 return true, of operator is self adjoint
 
virtual void apply (const TVector< value_t > *x, TVector< value_t > *y, const matop_t op=apply_normal) const
 
virtual void apply_add (const value_t alpha, const TVector< value_t > *x, TVector< value_t > *y, const matop_t op=apply_normal) const
 
virtual void apply_add (const value_t alpha, const BLAS::Vector< value_t > &x, BLAS::Vector< value_t > &y, const matop_t op=apply_normal) const
 
virtual size_t domain_dim () const
 return dimension of domain
 
virtual size_t range_dim () const
 return dimension of range
 
virtual auto domain_vector () const -> std::unique_ptr< TVector< value_t > >
 return vector in domain space
 
virtual auto range_vector () const -> std::unique_ptr< TVector< value_t > >
 return vector in range space
 
- Public Member Functions inherited from TLinearOperator< T_value >
virtual bool is_real () const
 return true, if field type is real valued
 
- Public Member Functions inherited from TTypeInfo
virtual typeid_t type () const =0
 return type ID of object
 
virtual bool is_type (const typeid_t t) const
 return true if local object is of given type ID t
 
virtual std::string typestr () const
 return string representation of type
 

Member Function Documentation

◆ apply()

template<typename T_value >
virtual void apply ( const TVector< value_t > *  x,
TVector< value_t > *  y,
const matop_t  op = apply_normal 
) const
virtual

mapping function of linear operator \(A\), e.g. \( y := A(x)\). Depending on op, either \(A\), \(A^T\) or \(A^H\) is applied.

Implements TLinearOperator< T_value >.

◆ apply_add() [1/2]

template<typename T_value >
virtual void apply_add ( const value_t  alpha,
const BLAS::Vector< value_t > &  x,
BLAS::Vector< value_t > &  y,
const matop_t  op = apply_normal 
) const
virtual

same as above but only the dimension of the vector spaces is tested, not the corresponding index sets

Implements TLinearOperator< T_value >.

◆ apply_add() [2/2]

template<typename T_value >
virtual void apply_add ( const value_t  alpha,
const TVector< value_t > *  x,
TVector< value_t > *  y,
const matop_t  op = apply_normal 
) const
virtual

mapping function with update: \( y := y + \alpha A(x)\). Depending on op, either \(A\), \(A^T\) or \(A^H\) is applied.

Implements TLinearOperator< T_value >.