RCMatrix_utility< N, T > Class Template Reference

Class that provides utility functions for RCMatrix_interface. More...

#include <RCMatrix_utility.h>

Static Public Member Functions
static void	diag (const RCMatrix_interface< N, T > *matrix, const std::vector< T > &diag)
	Generate a diagonal matrix. More...
static T	symmetricity_error (const RCMatrix_interface< N, T > *matrix)
	Measure the uniform norm of the symmetericity error. More...
static bool	report (const RCMatrix_interface< N, T > *matrix, std::string name)
	Report matrix properties. More...

Detailed Description

template<class N, class T>
class RCMatrix_utility< N, T >

Class that provides utility functions for RCMatrix_interface.

Member Function Documentation

diag()

template<class N , class T >

static void RCMatrix_utility< N, T >::diag ( const RCMatrix_interface< N, T > *  matrix, const std::vector< T > &  diag  )

inlinestatic

Generate a diagonal matrix.

Parameters

[out]	matrix	Resulting diagonal matrix.
[in]	diag	Diagonal entries.

report()

template<class N , class T >

static bool RCMatrix_utility< N, T >::report ( const RCMatrix_interface< N, T > *  matrix, std::string  name  )

inlinestatic

Report matrix properties.

Parameters

[in]	matrix	Matrix to examine.
[in]	name	Name of the matrix used in the reporting text.

Returns

if the matrix is symmetric and diagonals are all positive, false otherwise.

symmetricity_error()

template<class N , class T >

static T RCMatrix_utility< N, T >::symmetricity_error ( const RCMatrix_interface< N, T > *  matrix )

inlinestatic

Measure the uniform norm of the symmetericity error.

Parameters

[in]

matrix

Matrix to measure the error.

Returns

The uniform norm.

---

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

• include/shiokaze/math/RCMatrix_utility.h