ergo
mat::MatrixTriangular Class Reference

Upper non-unit triangular matrix. More...

#include <MatrixTriangular.h>

Inheritance diagram for mat::MatrixTriangular:
mat::MatrixBase< Treal, Tmatrix >

List of all members.

Public Types

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

Public Member Functions

 MatrixTriangular ()
 Default constructor.
 MatrixTriangular (const MatrixTriangular< Treal, Tmatrix > &tri)
 Copy constructor.
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.
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.
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 (+=).
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.
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.
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.
MatrixTriangular< Treal,
Tmatrix > & 
operator+= (XY< Treal, MatrixTriangular< Treal, Tmatrix > > const &sm)
 B += alpha * A.
std::string obj_type_id () const

Protected Member Functions

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

Detailed Description

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

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

Constructor & Destructor Documentation

mat::MatrixTriangular::MatrixTriangular ( ) [inline]

Default constructor.

mat::MatrixTriangular::MatrixTriangular ( const MatrixTriangular< Treal, Tmatrix > &  tri) [inline, explicit]

Copy constructor.


Member Function Documentation

void mat::MatrixTriangular::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.

void mat::MatrixTriangular::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().

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

Referenced by mainFun().

Treal mat::MatrixTriangular::frob ( ) const [inline]
void mat::MatrixTriangular::frob_thresh ( Treal  threshold) [inline]
void mat::MatrixTriangular::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.

Referenced by mainFun().

void mat::MatrixTriangular::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().

void mat::MatrixTriangular::inch ( const MatrixGeneral< Treal, Tmatrix > &  SPD,
const Treal  threshold,
const side  looking = left,
const inchversion  version = unstable 
) [inline]
void mat::MatrixTriangular::inch ( const MatrixSymmetric< Treal, Tmatrix > &  SPD,
const Treal  threshold,
const side  looking = left,
const inchversion  version = unstable 
) [inline]
size_t mat::MatrixTriangular::nnz ( ) const [inline]
size_t mat::MatrixTriangular::nvalues ( ) const [inline]
std::string mat::MatrixTriangular::obj_type_id ( ) const [inline]

Reimplemented from mat::MatrixBase< Treal, Tmatrix >.

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

B += alpha * A.

MatrixTriangular<Treal, Tmatrix>& mat::MatrixTriangular::operator= ( const MatrixTriangular< Treal, Tmatrix > &  tri) [inline]
MatrixTriangular<Treal, Tmatrix>& mat::MatrixTriangular::operator= ( int const  k) [inline]

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

Only zero and one are valid arguments.

void mat::MatrixTriangular::random ( ) [inline]

Referenced by mainFun().

void mat::MatrixTriangular::read_from_buffer ( void *  buffer,
const int  n_bytes 
) [inline]
void mat::MatrixTriangular::readFromFileProt ( std::ifstream &  file) [inline, protected]
template<typename TRule >
void mat::MatrixTriangular::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().

void mat::MatrixTriangular::thresh ( Treal const  threshold,
normType const  norm 
)

References mat::frobNorm.

void mat::MatrixTriangular::write_to_buffer ( void *  buffer,
const int  n_bytes 
) const [inline]
void mat::MatrixTriangular::writeToFileProt ( std::ofstream &  file) const [inline, protected]

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