#include <MMatrix.h>

Inheritance diagram for interpolation::MMatrix< Tmplt >:

Collaboration diagram for interpolation::MMatrix< Tmplt >:

Public Member Functions
	MMatrix ()
	default constructor makes an empty MMatrix of size (0,0)
	MMatrix (const MMatrix< Tmplt > &mv)
	Copy constructor makes a deep copy of mv.
	MMatrix (size_t nrows, size_t ncols, Tmplt *data_beginning)
	Construct a matrix and fill with data from memory data_beginning.
	MMatrix (size_t nrows, size_t ncols, Tmplt value)
	Construct a matrix and fill with identical data.
	MMatrix (size_t nrows, size_t ncols)
	Construct a matrix and fill all fields with 0.
	~MMatrix ()
	destructor
size_t	num_row () const
	returns number of rows in the matrix
size_t	num_col () const
	returns number of columns in the matrix
Tmplt	trace () const
	returns sum of terms with row == column, even if matrix is not square
Tmplt	determinant () const
	returns matrix determinant; throws an exception if matrix is not square
MMatrix< Tmplt >	inverse () const
	returns matrix inverse leaving this matrix unchanged
void	invert ()
	turns this matrix into its inverse
MMatrix< Tmplt >	T () const
	returns matrix transpose T (such that M(i,j) = T(j,i))
MVector< m_complex >	eigenvalues () const
	returns a vector of eigenvalues. Throws an exception if either this matrix is not square or the eigenvalues could not be found (e.g. singular matrix or whatever).
std::pair< MVector< m_complex >, MMatrix< m_complex > >	eigenvectors () const
MMatrix< Tmplt >	sub (size_t min_row, size_t max_row, size_t min_col, size_t max_col) const
MVector< Tmplt >	get_mvector (size_t column) const
const Tmplt &	operator() (size_t row, size_t column) const
Tmplt &	operator() (size_t row, size_t column)
MMatrix< Tmplt > &	operator= (const MMatrix< Tmplt > &mm)
MMatrix< double > &	operator= (const MMatrix< double > &mm)
MMatrix< m_complex > &	operator= (const MMatrix< m_complex > &mm)
	MMatrix (const MMatrix< double > &mm)
	MMatrix (const MMatrix< m_complex > &mm)
m_complex	determinant () const
double	determinant () const
void	invert ()
void	invert ()
MMatrix< double >	T () const
MMatrix< m_complex >	T () const
size_t	num_row () const
size_t	num_row () const
size_t	num_col () const
size_t	num_col () const
const double &	operator() (size_t i, size_t j) const
const m_complex &	operator() (size_t i, size_t j) const
double &	operator() (size_t i, size_t j)
m_complex &	operator() (size_t i, size_t j)

Static Public Member Functions
static MMatrix< Tmplt >	Diagonal (size_t i, Tmplt diag_value, Tmplt off_diag_value)
	Construct a square matrix filling on and off diagonal values.

Private Member Functions
void	build_matrix (size_t i, size_t j)
void	build_matrix (size_t i, size_t j, Tmplt *temp)
void	delete_matrix ()
void	delete_matrix ()
void	delete_matrix ()
void	build_matrix (size_t i, size_t j)
void	build_matrix (size_t i, size_t j)
void	build_matrix (size_t i, size_t j, double *data)
void	build_matrix (size_t i, size_t j, m_complex *data)

Static Private Member Functions
static gsl_matrix *	get_matrix (const MMatrix< double > &m)
static gsl_matrix_complex *	get_matrix (const MMatrix< m_complex > &m)

Private Attributes
void *	_matrix

Friends
class	MMatrix< double >
MMatrix< m_complex > &	operator*= (MMatrix< m_complex > &m, m_complex c)
MMatrix< double > &	operator*= (MMatrix< double > &m, double d)
MMatrix< m_complex > &	operator*= (MMatrix< m_complex > &m1, MMatrix< m_complex > m2)
MMatrix< double > &	operator*= (MMatrix< double > &m1, MMatrix< double > m2)
MVector< m_complex >	operator* (MMatrix< m_complex > m, MVector< m_complex > v)
MVector< double >	operator* (MMatrix< double > m, MVector< double > v)
MMatrix< m_complex > &	operator+= (MMatrix< m_complex > &m1, const MMatrix< m_complex > &m2)
MMatrix< double > &	operator+= (MMatrix< double > &m1, const MMatrix< double > &m2)
template<class Tmplt2>
MMatrix< Tmplt2 >	operator+ (MMatrix< Tmplt2 > m1, const MMatrix< Tmplt2 > m2)

Detailed Description

template<class Tmplt>
class interpolation::MMatrix< Tmplt >

C++ wrapper for GSL matrix MMatrix class handles matrix algebra, maths operators and some higher level calculation like matrix inversion, eigenvector analysis etc

Use template to define two types:
(i) MMatrix<double> is a matrix of doubles
(ii) MMatrix<m_complex> is a matrix of m_complex
Maths operators and a few others are defined, but maths operators don't allow operations between types - i.e. you can't multiply a complex matrix by a double matrix. Instead use interface methods like real() and complex() to convert between types first

Definition at line 62 of file MMatrix.h.

Constructor & Destructor Documentation

◆ MMatrix() [1/7]

template<class Tmplt>

template interpolation::MMatrix< Tmplt >::MMatrix ( )

default constructor makes an empty MMatrix of size (0,0)

Definition at line 41 of file MMatrix.cpp.

References _matrix.

Referenced by determinant(), Diagonal(), eigenvalues(), eigenvectors(), get_matrix(), get_matrix(), inverse(), MMatrix(), MMatrix< double >, operator*, operator*, operator*=, operator*=, operator*=, operator*=, operator+=, operator+=, operator=(), sub(), and T().

Here is the caller graph for this function:

◆ MMatrix() [2/7]

template<class Tmplt>

interpolation::MMatrix< Tmplt >::MMatrix ( const MMatrix< Tmplt > & mv )

Copy constructor makes a deep copy of mv.

References MMatrix().

Here is the call graph for this function:

◆ MMatrix() [3/7]

template<class Tmplt>

interpolation::MMatrix< Tmplt >::MMatrix	(	size_t	nrows,
		size_t	ncols,
		Tmplt *	data_beginning )

Construct a matrix and fill with data from memory data_beginning.

Parameters

nrows	number of rows
ncols	number of columns
data_beginning	pointer to the start of a memory block of size nrows*ncols with data laid out <row> <row> <row>. Note MMatrix does not take ownership of memory in data_beginning.

Definition at line 120 of file MMatrix.cpp.

References _matrix, and build_matrix().

Here is the call graph for this function:

◆ MMatrix() [4/7]

template<class Tmplt>

interpolation::MMatrix< Tmplt >::MMatrix	(	size_t	nrows,
		size_t	ncols,
		Tmplt	value )

Construct a matrix and fill with identical data.

Parameters

nrows	number of rows
ncols	number of columns
value	variable to be copied into all items in the matrix

Definition at line 126 of file MMatrix.cpp.

References build_matrix().

Here is the call graph for this function:

◆ MMatrix() [5/7]

template<class Tmplt>

interpolation::MMatrix< Tmplt >::MMatrix	(	size_t	nrows,
		size_t	ncols )

Construct a matrix and fill all fields with 0.

Parameters

nrows	number of rows
ncols	number of columns

Definition at line 135 of file MMatrix.cpp.

References build_matrix().

Here is the call graph for this function:

◆ ~MMatrix()

template<class Tmplt>

template interpolation::MMatrix< Tmplt >::~MMatrix ( )

destructor

Definition at line 155 of file MMatrix.cpp.

References delete_matrix().

Here is the call graph for this function:

◆ MMatrix() [6/7]

interpolation::MMatrix< double >::MMatrix ( const MMatrix< double > & mm )

Definition at line 100 of file MMatrix.cpp.

◆ MMatrix() [7/7]

interpolation::MMatrix< m_complex >::MMatrix ( const MMatrix< m_complex > & mm )

Definition at line 110 of file MMatrix.cpp.

Member Function Documentation

◆ build_matrix() [1/6]

void interpolation::MMatrix< m_complex >::build_matrix	(	size_t	i,
		size_t	j )

private

Definition at line 169 of file MMatrix.cpp.

◆ build_matrix() [2/6]

void interpolation::MMatrix< double >::build_matrix	(	size_t	i,
		size_t	j )

private

Definition at line 163 of file MMatrix.cpp.

◆ build_matrix() [3/6]

template<class Tmplt>

void interpolation::MMatrix< Tmplt >::build_matrix	(	size_t	i,
		size_t	j )

private

Referenced by MMatrix(), MMatrix(), and MMatrix().

Here is the caller graph for this function:

◆ build_matrix() [4/6]

void interpolation::MMatrix< double >::build_matrix	(	size_t	i,
		size_t	j,
		double *	data )

private

Definition at line 175 of file MMatrix.cpp.

◆ build_matrix() [5/6]

void interpolation::MMatrix< m_complex >::build_matrix	(	size_t	i,
		size_t	j,
		m_complex *	data )

private

Definition at line 184 of file MMatrix.cpp.

◆ build_matrix() [6/6]

template<class Tmplt>

void interpolation::MMatrix< Tmplt >::build_matrix	(	size_t	i,
		size_t	j,
		Tmplt *	temp )

private

◆ delete_matrix() [1/3]

void interpolation::MMatrix< m_complex >::delete_matrix ( )

private

Definition at line 70 of file MMatrix.cpp.

◆ delete_matrix() [2/3]

void interpolation::MMatrix< double >::delete_matrix ( )

private

Definition at line 63 of file MMatrix.cpp.

◆ delete_matrix() [3/3]

template<class Tmplt>

void interpolation::MMatrix< Tmplt >::delete_matrix ( )

private

Referenced by ~MMatrix().

Here is the caller graph for this function:

◆ determinant() [1/3]

double interpolation::MMatrix< double >::determinant ( ) const

Definition at line 209 of file MMatrix.cpp.

◆ determinant() [2/3]

m_complex interpolation::MMatrix< m_complex >::determinant ( ) const

Definition at line 196 of file MMatrix.cpp.

◆ determinant() [3/3]

template<class Tmplt>

Tmplt interpolation::MMatrix< Tmplt >::determinant ( ) const

returns matrix determinant; throws an exception if matrix is not square

References MMatrix().

Here is the call graph for this function:

◆ Diagonal()

template<class Tmplt>

MMatrix< Tmplt > interpolation::MMatrix< Tmplt >::Diagonal	(	size_t	i,
		Tmplt	diag_value,
		Tmplt	off_diag_value )

static

Construct a square matrix filling on and off diagonal values.

Parameters

i	number of rows and number of columns
diag_value	fill values with row == column (i.e. on the diagonal) with this value
off_diag_value	fill values with row != column (i.e. off the diagonal) with this value

Definition at line 141 of file MMatrix.cpp.

References MMatrix().

Here is the call graph for this function:

◆ eigenvalues()

template<class Tmplt>

template MVector< m_complex > interpolation::MMatrix< Tmplt >::eigenvalues ( ) const

returns a vector of eigenvalues. Throws an exception if either this matrix is not square or the eigenvalues could not be found (e.g. singular matrix or whatever).

Definition at line 301 of file MMatrix.cpp.

References get_matrix(), interpolation::MVector< Tmplt >::get_vector(), interpolation::m_complex_build(), MMatrix(), num_col(), and num_row().

Here is the call graph for this function:

◆ eigenvectors()

template<class Tmplt>

template std::pair< MVector< m_complex >, MMatrix< m_complex > > interpolation::MMatrix< Tmplt >::eigenvectors ( ) const

Definition at line 316 of file MMatrix.cpp.

References get_matrix(), interpolation::MVector< Tmplt >::get_vector(), MMatrix(), num_col(), and num_row().

Here is the call graph for this function:

◆ get_matrix() [1/2]

template<class Tmplt>

gsl_matrix inline * interpolation::MMatrix< Tmplt >::get_matrix ( const MMatrix< double > & m )

staticprivate

Definition at line 350 of file MMatrix.h.

References _matrix, and MMatrix().

Referenced by eigenvalues(), and eigenvectors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_matrix() [2/2]

template<class Tmplt>

gsl_matrix_complex inline * interpolation::MMatrix< Tmplt >::get_matrix ( const MMatrix< m_complex > & m )

staticprivate

Definition at line 358 of file MMatrix.h.

References _matrix, and MMatrix().

Here is the call graph for this function:

◆ get_mvector()

template<class Tmplt>

template MVector< m_complex > interpolation::MMatrix< Tmplt >::get_mvector ( size_t column ) const

Definition at line 417 of file MMatrix.cpp.

References num_row(), and operator()().

Here is the call graph for this function:

◆ inverse()

template<class Tmplt>

MMatrix< Tmplt > interpolation::MMatrix< Tmplt >::inverse ( ) const

returns matrix inverse leaving this matrix unchanged

Definition at line 222 of file MMatrix.cpp.

References invert(), and MMatrix().

Here is the call graph for this function:

◆ invert() [1/3]

void interpolation::MMatrix< double >::invert ( )

Definition at line 246 of file MMatrix.cpp.

◆ invert() [2/3]

void interpolation::MMatrix< m_complex >::invert ( )

Definition at line 231 of file MMatrix.cpp.

◆ invert() [3/3]

template<class Tmplt>

void interpolation::MMatrix< Tmplt >::invert ( )

turns this matrix into its inverse

Referenced by inverse().

Here is the caller graph for this function:

◆ num_col() [1/3]

size_t interpolation::MMatrix< m_complex >::num_col ( ) const

inline

Definition at line 259 of file MMatrix.h.

◆ num_col() [2/3]

size_t interpolation::MMatrix< double >::num_col ( ) const

inline

Definition at line 252 of file MMatrix.h.

◆ num_col() [3/3]

template<class Tmplt>

size_t interpolation::MMatrix< Tmplt >::num_col ( ) const

returns number of columns in the matrix

Referenced by interpolation::complex(), interpolation::complex(), eigenvalues(), eigenvectors(), interpolation::im(), operator*=, operator*=, interpolation::operator-(), interpolation::operator<<(), interpolation::MMatrix< double >::operator=(), interpolation::MMatrix< double >::operator=(), interpolation::operator==(), interpolation::re(), interpolation::SquarePolynomialVector::SetCoefficients(), interpolation::SquarePolynomialVector::SetCoefficients(), and trace().

Here is the caller graph for this function:

◆ num_row() [1/3]

size_t interpolation::MMatrix< m_complex >::num_row ( ) const

inline

Definition at line 246 of file MMatrix.h.

◆ num_row() [2/3]

size_t interpolation::MMatrix< double >::num_row ( ) const

inline

Definition at line 240 of file MMatrix.h.

◆ num_row() [3/3]

template<class Tmplt>

size_t interpolation::MMatrix< Tmplt >::num_row ( ) const

returns number of rows in the matrix

Referenced by interpolation::complex(), interpolation::complex(), eigenvalues(), eigenvectors(), get_mvector(), interpolation::im(), operator*, operator*, operator*=, operator*=, interpolation::operator-(), interpolation::operator<<(), interpolation::MMatrix< double >::operator=(), interpolation::MMatrix< double >::operator=(), interpolation::operator==(), interpolation::re(), interpolation::SquarePolynomialVector::SetCoefficients(), and trace().

Here is the caller graph for this function:

◆ operator()() [1/6]

m_complex & interpolation::MMatrix< m_complex >::operator()	(	size_t	i,
		size_t	j )

inline

Definition at line 329 of file MMatrix.h.

◆ operator()() [2/6]

double & interpolation::MMatrix< double >::operator()	(	size_t	i,
		size_t	j )

inline

Definition at line 326 of file MMatrix.h.

◆ operator()() [3/6]

const m_complex & interpolation::MMatrix< m_complex >::operator()	(	size_t	i,
		size_t	j ) const

inline

Definition at line 322 of file MMatrix.h.

◆ operator()() [4/6]

const double & interpolation::MMatrix< double >::operator()	(	size_t	i,
		size_t	j ) const

inline

Definition at line 319 of file MMatrix.h.

◆ operator()() [5/6]

template<class Tmplt>

Tmplt & interpolation::MMatrix< Tmplt >::operator()	(	size_t	row,
		size_t	column )

◆ operator()() [6/6]

template<class Tmplt>

const Tmplt & interpolation::MMatrix< Tmplt >::operator()	(	size_t	row,
		size_t	column ) const

Referenced by get_mvector(), sub(), and trace().

Here is the caller graph for this function:

◆ operator=() [1/3]

MMatrix< double > & interpolation::MMatrix< double >::operator= ( const MMatrix< double > & mm )

Definition at line 78 of file MMatrix.cpp.

◆ operator=() [2/3]

MMatrix< m_complex > & interpolation::MMatrix< m_complex >::operator= ( const MMatrix< m_complex > & mm )

Definition at line 89 of file MMatrix.cpp.

◆ operator=() [3/3]

template<class Tmplt>

MMatrix< Tmplt > & interpolation::MMatrix< Tmplt >::operator= ( const MMatrix< Tmplt > & mm )

References MMatrix().

Here is the call graph for this function:

◆ sub()

template<class Tmplt>

template MMatrix< m_complex > interpolation::MMatrix< Tmplt >::sub	(	size_t	min_row,
		size_t	max_row,
		size_t	min_col,
		size_t	max_col ) const

Definition at line 277 of file MMatrix.cpp.

References MMatrix(), and operator()().

Here is the call graph for this function:

◆ T() [1/3]

MMatrix< m_complex > interpolation::MMatrix< m_complex >::T ( ) const

Definition at line 269 of file MMatrix.cpp.

◆ T() [2/3]

MMatrix< double > interpolation::MMatrix< double >::T ( ) const

Definition at line 261 of file MMatrix.cpp.

◆ T() [3/3]

template<class Tmplt>

MMatrix< Tmplt > interpolation::MMatrix< Tmplt >::T ( ) const

returns matrix transpose T (such that M(i,j) = T(j,i))

References MMatrix().

Here is the call graph for this function:

◆ trace()

template<class Tmplt>

template m_complex interpolation::MMatrix< Tmplt >::trace ( ) const

returns sum of terms with row == column, even if matrix is not square

Definition at line 290 of file MMatrix.cpp.

References num_col(), num_row(), and operator()().

Here is the call graph for this function:

◆ MMatrix< double >

template<class Tmplt>

friend class MMatrix< double >

friend

Definition at line 174 of file MMatrix.h.

References MMatrix().

◆ operator* [1/2]

template<class Tmplt>

MVector< double > operator*	(	MMatrix< double >	m,
		MVector< double >	v )

friend

Definition at line 278 of file MMatrix.h.

References _matrix, interpolation::MVector< Tmplt >::_vector, MMatrix(), and num_row().

◆ operator* [2/2]

template<class Tmplt>

MVector< m_complex > operator*	(	MMatrix< m_complex >	m,
		MVector< m_complex >	v )

friend

Definition at line 271 of file MMatrix.h.

References _matrix, interpolation::MVector< Tmplt >::_vector, interpolation::m_complex_build(), MMatrix(), and num_row().

◆ operator*= [1/4]

template<class Tmplt>

MMatrix< double > & operator*=	(	MMatrix< double > &	m,
		double	d )

friend

Definition at line 268 of file MMatrix.h.

References _matrix, and MMatrix().

◆ operator*= [2/4]

template<class Tmplt>

MMatrix< double > & operator*=	(	MMatrix< double > &	m1,
		MMatrix< double >	m2 )

friend

Definition at line 332 of file MMatrix.cpp.

References _matrix, MMatrix(), num_col(), and num_row().

◆ operator*= [3/4]

template<class Tmplt>

MMatrix< m_complex > & operator*=	(	MMatrix< m_complex > &	m,
		m_complex	c )

friend

Definition at line 265 of file MMatrix.h.

References _matrix, and MMatrix().

◆ operator*= [4/4]

template<class Tmplt>

MMatrix< m_complex > & operator*=	(	MMatrix< m_complex > &	m1,
		MMatrix< m_complex >	m2 )

friend

Definition at line 340 of file MMatrix.cpp.

References _matrix, interpolation::m_complex_build(), MMatrix(), num_col(), and num_row().

◆ operator+

template<class Tmplt>

template<class Tmplt2>

MMatrix< Tmplt2 > operator+	(	MMatrix< Tmplt2 >	m1,
		const MMatrix< Tmplt2 >	m2 )

friend

◆ operator+= [1/2]

template<class Tmplt>

MMatrix< double > & operator+=	(	MMatrix< double > &	m1,
		const MMatrix< double > &	m2 )

friend

Definition at line 288 of file MMatrix.h.

References _matrix, and MMatrix().

◆ operator+= [2/2]

template<class Tmplt>

MMatrix< m_complex > & operator+=	(	MMatrix< m_complex > &	m1,
		const MMatrix< m_complex > &	m2 )

friend

Definition at line 285 of file MMatrix.h.

References _matrix, and MMatrix().

Member Data Documentation

◆ _matrix

template<class Tmplt>

void* interpolation::MMatrix< Tmplt >::_matrix

private

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MMatrix() [1/7]

◆ MMatrix() [2/7]

◆ MMatrix() [3/7]

◆ MMatrix() [4/7]

◆ MMatrix() [5/7]

◆ ~MMatrix()

◆ MMatrix() [6/7]

◆ MMatrix() [7/7]

Member Function Documentation

◆ build_matrix() [1/6]

◆ build_matrix() [2/6]

◆ build_matrix() [3/6]

◆ build_matrix() [4/6]

◆ build_matrix() [5/6]

◆ build_matrix() [6/6]

◆ delete_matrix() [1/3]

◆ delete_matrix() [2/3]

◆ delete_matrix() [3/3]

◆ determinant() [1/3]

◆ determinant() [2/3]

◆ determinant() [3/3]

◆ Diagonal()

◆ eigenvalues()

◆ eigenvectors()

◆ get_matrix() [1/2]

◆ get_matrix() [2/2]

◆ get_mvector()

◆ inverse()

◆ invert() [1/3]

◆ invert() [2/3]

◆ invert() [3/3]

◆ num_col() [1/3]

◆ num_col() [2/3]

◆ num_col() [3/3]

◆ num_row() [1/3]

◆ num_row() [2/3]

◆ num_row() [3/3]

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]

◆ operator()() [5/6]

◆ operator()() [6/6]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ sub()

◆ T() [1/3]

◆ T() [2/3]

◆ T() [3/3]

◆ trace()

Friends And Related Symbol Documentation

◆ MMatrix< double >

◆ operator* [1/2]

◆ operator* [2/2]

◆ operator*= [1/4]

◆ operator*= [2/4]

◆ operator*= [3/4]

◆ operator*= [4/4]

◆ operator+

◆ operator+= [1/2]

◆ operator+= [2/2]

Member Data Documentation

◆ _matrix