HLIBpro  2.7
T2DMatrixVis Class Referenceabstract

Implements 2D based matrix visualisation.

#include <TMatrixVis.hh>

Inheritance diagram for T2DMatrixVis:
TMatrixVis TPDFMatrixVis TPSMatrixVis

Public Member Functions

 T2DMatrixVis ()
 construct matrix visualisation object
 
T2DMatrixVisborder (const bool b)
 turn on/off printing of matrix block border (default: on)
 
T2DMatrixViscolor (const bool b)
 turn on/off color usage for visualization (default: on)
 
T2DMatrixVisstructure (const bool b)
 turn on/off printing of structure of matrix (default: on)
 
T2DMatrixVisindexset (const bool b)
 turn on/off printing of indexsets (default: off)
 
T2DMatrixVisid (const bool b)
 turn on/off printing of id (default: off)
 
T2DMatrixVisnonempty (const bool b)
 turn on/off printing of only nonempty blocks (default: off)
 
T2DMatrixVisonly_local (const bool b)
 turn on/off printing of local/non-local matrix blocks (default: off)
 
T2DMatrixVisneighbours (const bool b)
 turn on/off printing of neighbourhood relation (default: off)
 
T2DMatrixVisentries (const bool b)
 turn on/off printing of matrix coefficients (default: off)
 
T2DMatrixVispattern (const bool b)
 turn on/off printing of sparsity pattern (default: off)
 
T2DMatrixVissparse_pattern (const bool b)
 turn on/off printing of sparsity pattern of sparse matrices only (default: off)
 
T2DMatrixVissvd (const bool b)
 turn on/off printing of SVD of matrix-blocks (default: off)
 
T2DMatrixVisrank_col (const bool b, const size_t max_rank=0, const std::string &cmap="default")
 
T2DMatrixVismem_col (const bool b, const std::string &cmap="default")
 turn on/off colouring matrix blocks according to memory consumption (default: off)
 
T2DMatrixVismax_size_ratio (const double r)
 
T2DMatrixVismax_level (const size_t l)
 set maximal level in matrix (no blocks on levels below will be printed) (default: 0 [off])
 
T2DMatrixVissvd_ref (const double ref_max, const double ref_min=Limits::epsilon< double >())
 
virtual void print (const TMatrix *A, const std::string &filename) const
 print matrix A to file filename
 

Member Function Documentation

◆ max_size_ratio()

T2DMatrixVis& max_size_ratio ( const double  r)

set maximal allowed ratio of block size compared to largest block size (default: 1000); if ratio is exceeded, block will not be printed to limit file size for very large matrices

◆ rank_col()

T2DMatrixVis& rank_col ( const bool  b,
const size_t  max_rank = 0,
const std::string &  cmap = "default" 
)

turn on/off colouring matrix blocks according to rank compared with max_rank (default: off) if max_rank is 0, it is compared with block local maximal rank

◆ svd_ref()

T2DMatrixVis& svd_ref ( const double  ref_max,
const double  ref_min = Limits::epsilon< double >() 
)

set value of largest/smallest singular value to compare with for each block;

  • if ref_max/ref_min 0, the largest/smallest local singular values per block are used
  • good choice for ref_max is ∥A∥₂