Abstract base class for matrices, templated by the type of object that is stored in them and the type of matrix. The MATRIX_TYPE template argument is used as part of the Curiously Recurring Template Pattern, see http://en.wikipedia.org/wiki/Curiously_Recurring_Template_Pattern The pattern is used to force the inlining of the round bracket access functions by ensuring that they are NOT virtual functions. More...

#include <matrices.h>

Inheritance diagram for oomph::Matrix< T, MATRIX_TYPE >:

Public Member Functions
	Matrix ()
	(Empty) constructor

	Matrix (const Matrix &matrix)=delete
	Broken copy constructor.

void	operator= (const Matrix &)=delete
	Broken assignment operator.

virtual	~Matrix ()
	Virtual (empty) destructor.

virtual unsigned long	nrow () const =0
	Return the number of rows of the matrix.

virtual unsigned long	ncol () const =0
	Return the number of columns of the matrix.

T	operator() (const unsigned long &i, const unsigned long &j) const
	Round brackets to give access as a(i,j) for read only (we're not providing a general interface for component-wise write access since not all matrix formats allow efficient direct access!) The function uses the MATRIX_TYPE template parameter to call the get_entry() function which must be defined in all derived classes that are to be fully instantiated.

T &	operator() (const unsigned long &i, const unsigned long &j)
	Round brackets to give access as a(i,j) for read-write access. The function uses the MATRIX_TYPE template parameter to call the entry() function which must be defined in all derived classes that are to be fully instantiated. If the particular Matrix does not allow write access, the function should break with an error message.

virtual void	output (std::ostream &outfile) const
	Output function to print a matrix row-by-row, in the form a(0,0) a(0,1) ... a(1,0) a(1,1) ... ... to the stream outfile. Broken virtual since it might not be sensible to implement this for some sparse matrices.

virtual void	output_bottom_right_zero_helper (std::ostream &outfile) const =0
	Output the "bottom right" entry regardless of it being zero or not (this allows automatic detection of matrix size in e.g. matlab, python). This functionality was moved from the function sparse_indexed_output(...) because at the moment, generalisation of this functionality does not work in parallel. CRDoubleMatrix has an nrow() function but it should it should use nrow_local() - which is the N variable in the underlaying CRMatrix.

virtual void	sparse_indexed_output_helper (std::ostream &outfile, const double &cutoff=0.0) const =0
	Indexed output function to print a matrix to the stream outfile as i,j,a(i,j) for a(i,j)!=0 only. Final optional argument specifies max. size of entries which are set to zero on output.

void	sparse_indexed_output (std::ostream &outfile, const unsigned &precision=0, const bool &output_bottom_right_zero=false, const double &cutoff=0.0) const
	Indexed output function to print a matrix to the stream outfile as i,j,a(i,j) for a(i,j)!=0 only with specified precision (if precision=0 then nothing is changed). If optional boolean flag is set to true we also output the "bottom right" entry regardless of it being zero or not (this allows automatic detection of matrix size in e.g. matlab, python). Final optional argument specifies max. size of entries which are set to zero on output.

void	sparse_indexed_output (std::string filename, const unsigned &precision=0, const bool &output_bottom_right_zero=false, const double &cutoff=0.0) const
	Indexed output function to print a matrix to the file named filename as i,j,a(i,j) for a(i,j)!=0 only with specified precision. If optional boolean flag is set to true we also output the "bottom right" entry regardless of it being zero or not (this allows automatic detection of matrix size in e.g. matlab, python). Final optional argument specifies max. size of entries which are set to zero on output.

void	sparse_indexed_output_with_cutoff (std::ostream &outfile, const double &cutoff=0.0) const
	Indexed output function to print a matrix to the stream outfile as i,j,a(i,j) for a(i,j)!=0. Final optional argument specifies max. size of entries which are set to zero on output.

void	sparse_indexed_output_with_cutoff (std::string filename, const double &cutoff=0.0) const
	Indexed output function to print a matrix to the stream outfile as i,j,a(i,j) for a(i,j)!=0. Final optional argument specifies max. size of entries which are set to zero on output.

Protected Member Functions
void	range_check (const unsigned long &i, const unsigned long &j) const
	Range check to catch when an index is out of bounds, if so, it issues a warning message and dies by throwing an `OomphLibError`.

Detailed Description

template<class T, class MATRIX_TYPE>
class oomph::Matrix< T, MATRIX_TYPE >

Abstract base class for matrices, templated by the type of object that is stored in them and the type of matrix. The MATRIX_TYPE template argument is used as part of the Curiously Recurring Template Pattern, see http://en.wikipedia.org/wiki/Curiously_Recurring_Template_Pattern The pattern is used to force the inlining of the round bracket access functions by ensuring that they are NOT virtual functions.

Definition at line 74 of file matrices.h.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Matrix() [1/2]

◆ Matrix() [2/2]

◆ ~Matrix()

Member Function Documentation

◆ ncol()

◆ nrow()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=()

◆ output()

◆ output_bottom_right_zero_helper()

◆ range_check()

◆ sparse_indexed_output() [1/2]

◆ sparse_indexed_output() [2/2]

◆ sparse_indexed_output_helper()

◆ sparse_indexed_output_with_cutoff() [1/2]

◆ sparse_indexed_output_with_cutoff() [2/2]