ergo
mat::MatrixTriangular< Treal, Tmatrix > Class Template Reference

Upper non-unit triangular matrix. More...

#include <MatrixBase.h>

Public Types

typedef VectorGeneral< Treal, typename Tmatrix::VectorType > VectorType
 
typedef Treal real
 

Public Member Functions

 MatrixTriangular ()
 Default constructor
More...
 
 MatrixTriangular (const MatrixTriangular< Treal, Tmatrix > &tri)
 Copy constructor
More...
 
MatrixTriangular< Treal, Tmatrix > & operator= (const MatrixTriangular< Treal, Tmatrix > &tri)
 
MatrixTriangular< Treal, Tmatrix > & operator= (int const k)
 Set matrix to zero or identity: A = 0 or A = 1. More...
 
void assign_from_sparse (std::vector< int > const &rowind, std::vector< int > const &colind, std::vector< Treal > const &values, SizesAndBlocks const &newRows, SizesAndBlocks const &newCols)
 Assign from sparse matrix given by three vectors. More...
 
void add_values (std::vector< int > const &rowind, std::vector< int > const &colind, std::vector< Treal > const &values)
 Add given set of values to the matrix (+=). More...
 
void get_values (std::vector< int > const &rowind, std::vector< int > const &colind, std::vector< Treal > &values) const
 Get values given by row and column index lists. More...
 
void get_all_values (std::vector< int > &rowind, std::vector< int > &colind, std::vector< Treal > &values) const
 Get all values and corresponding row and column index lists, in matrix. More...
 
void inch (const MatrixGeneral< Treal, Tmatrix > &SPD, const Treal threshold, const side looking=left, const inchversion version=unstable)
 
void inch (const MatrixSymmetric< Treal, Tmatrix > &SPD, const Treal threshold, const side looking=left, const inchversion version=unstable)
 
void thresh (Treal const threshold, normType const norm)
 
Treal frob () const
 
Treal eucl (Treal const requestedAccuracy, int maxIter=-1) const
 
Treal eucl_thresh (Treal const threshold)
 
Treal eucl_thresh_congr_trans_measure (Treal const threshold, MatrixSymmetric< Treal, Tmatrix > &trA)
 
void frob_thresh (Treal threshold)
 
size_t nnz () const
 
size_t nvalues () const
 
void write_to_buffer (void *buffer, const int n_bytes) const
 
void read_from_buffer (void *buffer, const int n_bytes)
 
void random ()
 
template<typename TRule >
void setElementsByRule (TRule &rule)
 Uses rule depending on the row and column indexes to set matrix elements The Trule class should have the function "Treal = set(int row,int col)" which is used to set the elements. More...
 
MatrixTriangular< Treal, Tmatrix > & operator+= (XY< Treal, MatrixTriangular< Treal, Tmatrix > > const &sm)
 B += alpha * A. More...
 
std::string obj_type_id () const
 

Protected Member Functions

void writeToFileProt (std::ofstream &file) const
 
void readFromFileProt (std::ifstream &file)
 

Detailed Description

template<typename Treal, typename Tmatrix>
class mat::MatrixTriangular< Treal, Tmatrix >

Upper non-unit triangular matrix.

This class belongs to the matrix API

Treal: Type for real numbers

Tmatrix: The matrix class

See also
MatrixBase
MatrixGeneral
MatrixSymmetric

Member Typedef Documentation

◆ real

template<typename Treal , typename Tmatrix >
typedef Treal mat::MatrixTriangular< Treal, Tmatrix >::real

◆ VectorType

template<typename Treal , typename Tmatrix >
typedef VectorGeneral<Treal, typename Tmatrix::VectorType> mat::MatrixTriangular< Treal, Tmatrix >::VectorType

Constructor & Destructor Documentation

◆ MatrixTriangular() [1/2]

template<typename Treal , typename Tmatrix >
mat::MatrixTriangular< Treal, Tmatrix >::MatrixTriangular ( )
inline

Default constructor

◆ MatrixTriangular() [2/2]

template<typename Treal , typename Tmatrix >
mat::MatrixTriangular< Treal, Tmatrix >::MatrixTriangular ( const MatrixTriangular< Treal, Tmatrix > &  tri)
inlineexplicit

Copy constructor

Member Function Documentation

◆ add_values()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::add_values ( std::vector< int > const &  rowind,
std::vector< int > const &  colind,
std::vector< Treal > const &  values 
)
inline

Add given set of values to the matrix (+=).

The values should be in upper triangle.

◆ assign_from_sparse()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::assign_from_sparse ( std::vector< int > const &  rowind,
std::vector< int > const &  colind,
std::vector< Treal > const &  values,
SizesAndBlocks const &  newRows,
SizesAndBlocks const &  newCols 
)
inline

Assign from sparse matrix given by three vectors.

The vectors contain row indices, column indices and values. The indices start at zero. The elements to be added must be in upper triangle. Information about sizes and blocks for rows as well as columns must also be given.

Warning
All indexing start at zero.

Referenced by mainFun().

◆ eucl()

◆ eucl_thresh()

template<typename Treal , typename Tmatrix >
Treal mat::MatrixTriangular< Treal, Tmatrix >::eucl_thresh ( Treal const  threshold)

◆ eucl_thresh_congr_trans_measure()

template<typename Treal , typename Tmatrix >
Treal mat::MatrixTriangular< Treal, Tmatrix >::eucl_thresh_congr_trans_measure ( Treal const  threshold,
MatrixSymmetric< Treal, Tmatrix > &  trA 
)

◆ frob()

template<typename Treal , typename Tmatrix >
Treal mat::MatrixTriangular< Treal, Tmatrix >::frob ( ) const
inline

Referenced by mainFun().

◆ frob_thresh()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::frob_thresh ( Treal  threshold)
inline

◆ get_all_values()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::get_all_values ( std::vector< int > &  rowind,
std::vector< int > &  colind,
std::vector< Treal > &  values 
) const
inline

Get all values and corresponding row and column index lists, in matrix.

Only upper triangle values are returned.

Warning
All indexing start at zero.

References mat::MatrixTriangular< Treal, Tmatrix >::nnz().

Referenced by mainFun().

◆ get_values()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::get_values ( std::vector< int > const &  rowind,
std::vector< int > const &  colind,
std::vector< Treal > &  values 
) const
inline

Get values given by row and column index lists.

Input arrays contain row and column indices. The wanted elements must in upper triangle. The output array contains values for the given indices.

Warning
All indexing start at zero.

Referenced by mainFun().

◆ inch() [1/2]

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::inch ( const MatrixGeneral< Treal, Tmatrix > &  SPD,
const Treal  threshold,
const side  looking = left,
const inchversion  version = unstable 
)
inline

Referenced by mainFun().

◆ inch() [2/2]

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::inch ( const MatrixSymmetric< Treal, Tmatrix > &  SPD,
const Treal  threshold,
const side  looking = left,
const inchversion  version = unstable 
)
inline

◆ nnz()

template<typename Treal , typename Tmatrix >
size_t mat::MatrixTriangular< Treal, Tmatrix >::nnz ( ) const
inline

◆ nvalues()

template<typename Treal , typename Tmatrix >
size_t mat::MatrixTriangular< Treal, Tmatrix >::nvalues ( ) const
inline

◆ obj_type_id()

template<typename Treal , typename Tmatrix >
std::string mat::MatrixTriangular< Treal, Tmatrix >::obj_type_id ( ) const
inline

◆ operator+=()

template<typename Treal , typename Tmatrix >
MatrixTriangular< Treal, Tmatrix > & mat::MatrixTriangular< Treal, Tmatrix >::operator+= ( XY< Treal, MatrixTriangular< Treal, Tmatrix > > const &  sm)
inline

B += alpha * A.

◆ operator=() [1/2]

template<typename Treal , typename Tmatrix >
MatrixTriangular<Treal, Tmatrix>& mat::MatrixTriangular< Treal, Tmatrix >::operator= ( const MatrixTriangular< Treal, Tmatrix > &  tri)
inline

◆ operator=() [2/2]

template<typename Treal , typename Tmatrix >
MatrixTriangular<Treal, Tmatrix>& mat::MatrixTriangular< Treal, Tmatrix >::operator= ( int const  k)
inline

Set matrix to zero or identity: A = 0 or A = 1.

    Only zero and one are valid arguments.

◆ random()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::random ( )
inline

Referenced by mainFun().

◆ read_from_buffer()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::read_from_buffer ( void *  buffer,
const int  n_bytes 
)
inline

References mat::matrix_triang.

◆ readFromFileProt()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::readFromFileProt ( std::ifstream &  file)
inlineprotected

References mat::matrix_triang.

◆ setElementsByRule()

template<typename Treal , typename Tmatrix >
template<typename TRule >
void mat::MatrixTriangular< Treal, Tmatrix >::setElementsByRule ( TRule &  rule)
inline

Uses rule depending on the row and column indexes to set matrix elements The Trule class should have the function "Treal = set(int row,int col)" which is used to set the elements.

Referenced by mainFun().

◆ thresh()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::thresh ( Treal const  threshold,
normType const  norm 
)

References mat::frobNorm.

◆ write_to_buffer()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::write_to_buffer ( void *  buffer,
const int  n_bytes 
) const
inline

References mat::matrix_triang.

◆ writeToFileProt()

template<typename Treal , typename Tmatrix >
void mat::MatrixTriangular< Treal, Tmatrix >::writeToFileProt ( std::ofstream &  file) const
inlineprotected

References mat::matrix_triang.


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