HLIBpro  2.1
Public Member Functions | List of all members
TBlockMatrix Class Reference

Class for a n×m block matrix of TMatrix sub matrices.

#include <TBlockMatrix.hh>

Inheritance diagram for TBlockMatrix:
TMatrix TLinearOperator TLockable TTypeInfo TH2Matrix THMatrix

Public Member Functions

 TBlockMatrix (const TBlockCluster *bct=NULL)
 construct block matrix with size and block structure defined by bct
 
 TBlockMatrix (const TBlockIndexSet &bis)
 construct block matrix with over block index set bis
 
virtual ~TBlockMatrix ()
 dtor
 
virtual void set_cluster (const TBlockCluster *c)
 set cluster of matrix
 
virtual size_t rows () const
 return number of rows
 
virtual size_t cols () const
 return number of columns
 
void set_size (const size_t r, const size_t c)
 set size of matrix
 
uint block_rows () const
 return number of block-rows
 
uint block_cols () const
 return number of block-columns
 
uint no_of_blocks () const
 return number of sub blocks of matrix
 
void set_block_struct (const uint n, const uint m)
 set block structure
 
virtual void set_form (const matform_t f)
 set matrix format
 
virtual void set_form (const matform_t f, const recursive_type_t t)
 set matrix format
 
virtual real entry (const idx_t i, const idx_t j) const
 return matrix coefficient (i, j)
 
virtual const complex centry (const idx_t i, const idx_t j) const
 return matrix coefficient (i, j)
 
TMatrix * block (const uint i, const uint j)
 return block at block index (i, j)
 
const TMatrix * block (const uint i, const uint j) const
 return block at block index (i, j)
 
void set_block (const uint i, const uint j, TMatrix *A)
 set matrix block at block index (i,j) to matrix A
 
void replace_block (TMatrix *A, TMatrix *B)
 replace matrix block A by matrix B (don't delete A !)
 
TMatrix * bc_block (const TBlockCluster *t) const
 return subblock of matrix corresponding to block cluster t
 
TMatrix * bc_block (const TCluster *tau, const TCluster *sigma) const
 return subblock of matrix corresponding to block cluster (tau, sigma)
 
void clear_blocks ()
 clear pointers to all sub blocks
 
virtual void to_real ()
 convert data to real valued representation (if possible)
 
virtual void to_complex ()
 convert data to complex valued representation (if possible)
 
virtual void adjust_value_type ()
 make value type of this and all sub blocks consistent
 
virtual bool is_blocked () const
 return true, if matrix is blocked
 
virtual void scale (const real alpha)
 compute this ≔ α·this
 
virtual void add (const real alpha, const TMatrix *matrix)
 compute this ≔ this + α · matrix
 
virtual void mul_vec (const real alpha, const TVector *x, const real beta, TVector *y, const matop_t op=MATOP_NORM) const
 compute y ≔ β·y + α·op(M)·x, with M = this
 
virtual void cscale (const complex alpha)
 compute this ≔ α·this
 
virtual void cadd (const complex alpha, const TMatrix *matrix)
 compute this ≔ this + α · matrix
 
virtual void cmul_vec (const complex alpha, const TVector *x, const complex beta, TVector *y, const matop_t op=MATOP_NORM) const
 compute y ≔ β·y + α·op(M)·x, with M = this
 
template<typename T_list >
void collect_leaves (T_list &leaf_list) const
 collect matrix blocks corresponding to leaves in list leaf_list
 
virtual void transpose ()
 transpose matrix
 
virtual void conjugate ()
 conjugate matrix coefficients
 
virtual void truncate (const TTruncAcc &acc)
 truncate all rank-blocks in matrix to accuracy acc
 
virtual void print (const uint ofs=0) const
 print matrix to stdout
 
virtual TMatrix * create () const
 return matrix of same class (but no content)
 
virtual TMatrix * copy () const
 return copy of matrix
 
virtual TMatrix * copy (const TTruncAcc &acc, const bool coarsen=false) const
 copy matrix wrt. accuracy acc and optional coarsening
 
virtual void copy_to (TMatrix *A) const
 copy matrix into A
 
virtual void copy_to (TMatrix *A, const TTruncAcc &acc, const bool coarsen=false) const
 copy matrix into A with accuracy acc and optional coarsening
 
virtual size_t byte_size () const
 return size in bytes used by this object
 
virtual void copy_struct (const TMatrix *M)
 copy complete structural information from given matrix
 
virtual typeid_t type () const
 return type ID of matrix
 
virtual bool is_type (const typeid_t t) const
 return true if local matrix is of type t
 
virtual void read (TByteStream &s)
 read data from stream s and copy to matrix
 
virtual void build (TByteStream &s)
 use data from stream s to build matrix
 
virtual void write (TByteStream &s) const
 write data to stream s
 
virtual size_t bs_size () const
 returns size of object in bytestream
 
virtual void check_data () const
 test data for invalid values, e.g. INF and NAN
 
- Public Member Functions inherited from TMatrix
 TMatrix (const bool acomplex=false)
 construct zero sized matrix
 
 TMatrix (const TBlockCluster *c)
 construct matrix of size defined by block cluster c
 
 TMatrix (const TBlockIndexSet &bis)
 construct matrix of size defined by block cluster c
 
 TMatrix (const TMatrix &A)
 copy constructor
 
virtual ~TMatrix ()
 dtor
 
int id () const
 return ID
 
void set_id (const int aid)
 set ID
 
TIndexSet row_is () const
 return row index set
 
TIndexSet col_is () const
 return column index set
 
TBlockIndexSet block_is () const
 return block index set
 
virtual idx_t row_ofs () const
 return first index (number) in row
 
virtual idx_t col_ofs () const
 return first index (number) in column
 
virtual void set_ofs (const idx_t r, const idx_t c)
 set index set offsets
 
virtual void set_block_is (const TBlockIndexSet &is)
 set block index set of matrix
 
bool is_nonsym () const
 return true if matrix is unsymmetric
 
bool is_symmetric () const
 return true if matrix is symmetric
 
bool is_hermitian () const
 return true if matrix is hermitian
 
matform_t form () const
 return matrix format
 
void set_nonsym ()
 set matrix to be unsymmetric
 
void set_symmetric ()
 set matrix to be symmetric
 
void set_hermitian ()
 set matrix to be hermitian
 
virtual bool is_zero () const
 return true, if matrix is zero
 
virtual bool is_dense () const
 return true, if matrix is dense
 
virtual bool is_self_adjoint () const
 return true, if operator is self adjoint
 
const TProcSet & procs () const
 return matrix processor set
 
uint nprocs () const
 return number of processors in local set
 
void set_procs (const TProcSet &ps)
 set processor set of matrix
 
bool is_real () const
 return true if matrix is real valued
 
bool is_complex () const
 return true if matrix is complex valued
 
void set_complex (const bool b, const bool force=false)
 
const TBlockCluster * cluster () const
 return corresponding block cluster of matrix
 
virtual void apply (const TVector *x, TVector *y, const matop_t op) const
 
virtual void apply_add (const real alpha, const TVector *x, TVector *y, const matop_t op) const
 
virtual TVector * domain_vector () const
 return vector in domain space
 
virtual TVector * range_vector () const
 return vector in range space
 
virtual TMatrix * mul_right (const real alpha, const TMatrix *B, const matop_t op_A, const matop_t op_B) const
 compute α·op(A)·op(B), with A = this
 
virtual TMatrix * mul_left (const real alpha, const TMatrix *A, const matop_t op_A, const matop_t op_B) const
 compute α·op(A)·op(B), with B = this
 
virtual TMatrix * cmul_right (const complex alpha, const TMatrix *B, const matop_t op_A, const matop_t op_B) const
 compute α·op(A)·op(B), with A = this
 
virtual TMatrix * cmul_left (const complex alpha, const TMatrix *A, const matop_t op_A, const matop_t op_B) const
 compute α·op(A)·op(B), with B = this
 
virtual size_t global_byte_size () const
 
virtual TVector * row_vector () const
 return appropriate row vector object for matrix
 
virtual TVector * col_vector () const
 return appropriate column vector object for matrix
 
virtual void sum (const TProcSet &p, const uint pid, const uint nparts, TByteStream *bs, const TTruncAcc &acc)
 
- Public Member Functions inherited from TTypeInfo
virtual std::string typestr () const
 return string representation of type
 
- Public Member Functions inherited from TLockable
TMutex & mutex ()
 give access to internal mutex
 
void lock ()
 lock local mutex
 
void unlock ()
 unlock local mutex
 
size_t byte_size () const
 return size in bytes used by this object