A matrix class for general, non-square matrices. More...

#include <Matrix.h>

Inheritance diagram for RDNumeric::Matrix< TYPE >:

Public Types
typedef boost::shared_array< TYPE >	DATA_SPTR

Public Member Functions
	Matrix (unsigned int nRows, unsigned int nCols)
	Initialize with a size.

	Matrix (unsigned int nRows, unsigned int nCols, TYPE val)
	Initialize with a size and default value.

	Matrix (unsigned int nRows, unsigned int nCols, DATA_SPTR data)
	Initialize from a pointer.

	Matrix (const Matrix< TYPE > &other)
	copy constructor

virtual	~Matrix ()

unsigned int	numRows () const
	returns the number of rows

unsigned int	numCols () const
	returns the number of columns

unsigned int	getDataSize () const

virtual TYPE	getVal (unsigned int i, unsigned int j) const
	returns a particular element of the matrix

virtual void	setVal (unsigned int i, unsigned int j, TYPE val)
	sets a particular element of the matrix

virtual void	getRow (unsigned int i, Vector< TYPE > &row) const
	returns a copy of a row of the matrix

virtual void	getCol (unsigned int i, Vector< TYPE > &col) const
	returns a copy of a column of the matrix

TYPE *	getData ()
	returns a pointer to our data array

const TYPE *	getData () const
	returns a const pointer to our data array

Matrix< TYPE > &	assign (const Matrix< TYPE > &other)
	Copy operator.

virtual Matrix< TYPE > &	operator+= (const Matrix< TYPE > &other)
	Matrix addition.

virtual Matrix< TYPE > &	operator-= (const Matrix< TYPE > &other)
	Matrix subtraction.

virtual Matrix< TYPE > &	operator*= (TYPE scale)
	Multiplication by a scalar.

virtual Matrix< TYPE > &	operator/= (TYPE scale)
	division by a scalar

virtual Matrix< TYPE > &	transpose (Matrix< TYPE > &transpose) const
	copies the transpose of this Matrix into another, returns the result

Protected Member Functions
	Matrix ()

Protected Attributes
unsigned int	d_nRows {0}

unsigned int	d_nCols {0}

unsigned int	d_dataSize {0}

DATA_SPTR	d_data

Detailed Description

template<class TYPE>
class RDNumeric::Matrix< TYPE >

A matrix class for general, non-square matrices.

Definition at line 29 of file Matrix.h.

Member Typedef Documentation

◆ DATA_SPTR

template<class TYPE >

typedef boost::shared_array<TYPE> RDNumeric::Matrix< TYPE >::DATA_SPTR

Definition at line 31 of file Matrix.h.

Constructor & Destructor Documentation

◆ Matrix() [1/5]

template<class TYPE >

RDNumeric::Matrix< TYPE >::Matrix	(	unsigned int	nRows,
		unsigned int	nCols
	)

inline

Initialize with a size.

Definition at line 34 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, and RDNumeric::Matrix< TYPE >::d_dataSize.

◆ Matrix() [2/5]

template<class TYPE >

RDNumeric::Matrix< TYPE >::Matrix	(	unsigned int	nRows,
		unsigned int	nCols,
		TYPE	val
	)

inline

Initialize with a size and default value.

Definition at line 42 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, and RDNumeric::Matrix< TYPE >::d_dataSize.

◆ Matrix() [3/5]

template<class TYPE >

RDNumeric::Matrix< TYPE >::Matrix	(	unsigned int	nRows,
		unsigned int	nCols,
		DATA_SPTR	data
	)

inline

Initialize from a pointer.

NOTE: this does not take ownership of the data, if you delete the data externally, this Matrix will be sad.

Definition at line 57 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data.

◆ Matrix() [4/5]

template<class TYPE >

RDNumeric::Matrix< TYPE >::Matrix ( const Matrix< TYPE > & other )

inline

copy constructor

We make a copy of the other vector's data.

Definition at line 65 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_dataSize, and RDNumeric::Matrix< TYPE >::getData().

◆ ~Matrix()

template<class TYPE >

virtual RDNumeric::Matrix< TYPE >::~Matrix ( )

inlinevirtual

Definition at line 76 of file Matrix.h.

◆ Matrix() [5/5]

template<class TYPE >

RDNumeric::Matrix< TYPE >::Matrix ( )

inlineprotected

Definition at line 232 of file Matrix.h.

Member Function Documentation

◆ assign()

template<class TYPE >

Matrix< TYPE > & RDNumeric::Matrix< TYPE >::assign ( const Matrix< TYPE > & other )

inline

Copy operator.

We make a copy of the other Matrix's data.

Definition at line 137 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_dataSize, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, RDNumeric::Matrix< TYPE >::getData(), RDNumeric::Matrix< TYPE >::numCols(), RDNumeric::Matrix< TYPE >::numRows(), and PRECONDITION.

◆ getCol()

template<class TYPE >

virtual void RDNumeric::Matrix< TYPE >::getCol	(	unsigned int	i,
		Vector< TYPE > &	col
	)		const

inlinevirtual

returns a copy of a column of the matrix

Definition at line 115 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, RDNumeric::Vector< TYPE >::getData(), PRECONDITION, and RDNumeric::Vector< TYPE >::size().

◆ getData() [1/2]

template<class TYPE >

TYPE * RDNumeric::Matrix< TYPE >::getData ( )

inline

returns a pointer to our data array

Definition at line 128 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data.

Referenced by RDNumeric::Matrix< TYPE >::assign(), RDNumeric::Matrix< TYPE >::Matrix(), RDNumeric::multiply(), RDNumeric::multiply(), RDNumeric::SquareMatrix< TYPE >::operator*=(), RDNumeric::Matrix< TYPE >::operator+=(), and RDNumeric::Matrix< TYPE >::operator-=().

◆ getData() [2/2]

template<class TYPE >

const TYPE * RDNumeric::Matrix< TYPE >::getData ( ) const

inline

returns a const pointer to our data array

Definition at line 131 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data.

◆ getDataSize()

template<class TYPE >

unsigned int RDNumeric::Matrix< TYPE >::getDataSize ( ) const

inline

Definition at line 84 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_dataSize.

◆ getRow()

template<class TYPE >

virtual void RDNumeric::Matrix< TYPE >::getRow	(	unsigned int	i,
		Vector< TYPE > &	row
	)		const

inlinevirtual

returns a copy of a row of the matrix

Definition at line 104 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, RDNumeric::Vector< TYPE >::getData(), PRECONDITION, and RDNumeric::Vector< TYPE >::size().

◆ getVal()

template<class TYPE >

virtual TYPE RDNumeric::Matrix< TYPE >::getVal	(	unsigned int	i,
		unsigned int	j
	)		const

inlinevirtual

returns a particular element of the matrix

Definition at line 87 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, and PRECONDITION.

Referenced by operator<<().

◆ numCols()

template<class TYPE >

unsigned int RDNumeric::Matrix< TYPE >::numCols ( ) const

inline

returns the number of columns

Definition at line 82 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_nCols.

Referenced by RDNumeric::Matrix< TYPE >::assign(), RDNumeric::multiply(), RDNumeric::multiply(), RDNumeric::Matrix< TYPE >::operator+=(), RDNumeric::Matrix< TYPE >::operator-=(), and operator<<().

◆ numRows()

template<class TYPE >

unsigned int RDNumeric::Matrix< TYPE >::numRows ( ) const

inline

returns the number of rows

Definition at line 79 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_nRows.

Referenced by RDNumeric::Matrix< TYPE >::assign(), RDNumeric::multiply(), RDNumeric::multiply(), RDNumeric::SquareMatrix< TYPE >::operator*=(), RDNumeric::Matrix< TYPE >::operator+=(), RDNumeric::Matrix< TYPE >::operator-=(), and operator<<().

◆ operator*=()

template<class TYPE >

virtual Matrix< TYPE > & RDNumeric::Matrix< TYPE >::operator*= ( TYPE scale )

inlinevirtual

Multiplication by a scalar.

Reimplemented in RDNumeric::SquareMatrix< TYPE >.

Definition at line 184 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, and RDNumeric::Matrix< TYPE >::d_dataSize.

Referenced by RDNumeric::SquareMatrix< TYPE >::operator*=().

◆ operator+=()

template<class TYPE >

virtual Matrix< TYPE > & RDNumeric::Matrix< TYPE >::operator+= ( const Matrix< TYPE > & other )

inlinevirtual

Matrix addition.

Perform a element by element addition of other Matrix to this Matrix

Definition at line 152 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_dataSize, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, RDNumeric::Matrix< TYPE >::getData(), RDNumeric::Matrix< TYPE >::numCols(), RDNumeric::Matrix< TYPE >::numRows(), and PRECONDITION.

◆ operator-=()

template<class TYPE >

virtual Matrix< TYPE > & RDNumeric::Matrix< TYPE >::operator-= ( const Matrix< TYPE > & other )

inlinevirtual

Matrix subtraction.

Perform a element by element subtraction of other Matrix from this Matrix

Definition at line 169 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_dataSize, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, RDNumeric::Matrix< TYPE >::getData(), RDNumeric::Matrix< TYPE >::numCols(), RDNumeric::Matrix< TYPE >::numRows(), and PRECONDITION.

◆ operator/=()

template<class TYPE >

virtual Matrix< TYPE > & RDNumeric::Matrix< TYPE >::operator/= ( TYPE scale )

inlinevirtual

division by a scalar

Definition at line 194 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, and RDNumeric::Matrix< TYPE >::d_dataSize.

◆ setVal()

template<class TYPE >

virtual void RDNumeric::Matrix< TYPE >::setVal	(	unsigned int	i,
		unsigned int	j,
		TYPE	val
	)

inlinevirtual

sets a particular element of the matrix

Definition at line 95 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, and PRECONDITION.

◆ transpose()

template<class TYPE >

virtual Matrix< TYPE > & RDNumeric::Matrix< TYPE >::transpose ( Matrix< TYPE > & transpose ) const

inlinevirtual

copies the transpose of this Matrix into another, returns the result

Parameters

transpose the Matrix to store the results

Returns: the transpose of this matrix. This is just a reference to the argument.

Definition at line 211 of file Matrix.h.

References RDNumeric::Matrix< TYPE >::d_data, RDNumeric::Matrix< TYPE >::d_nCols, RDNumeric::Matrix< TYPE >::d_nRows, PRECONDITION, and RDNumeric::Matrix< TYPE >::transpose().

Referenced by RDNumeric::Matrix< TYPE >::transpose().

Member Data Documentation

◆ d_data

template<class TYPE >

DATA_SPTR RDNumeric::Matrix< TYPE >::d_data

protected

◆ d_dataSize

template<class TYPE >

unsigned int RDNumeric::Matrix< TYPE >::d_dataSize {0}

protected

Definition at line 235 of file Matrix.h.

Referenced by RDNumeric::Matrix< TYPE >::assign(), RDNumeric::Matrix< TYPE >::getDataSize(), RDNumeric::Matrix< TYPE >::Matrix(), RDNumeric::Matrix< TYPE >::Matrix(), RDNumeric::Matrix< TYPE >::Matrix(), RDNumeric::SquareMatrix< TYPE >::operator*=(), RDNumeric::Matrix< TYPE >::operator*=(), RDNumeric::Matrix< TYPE >::operator+=(), RDNumeric::Matrix< TYPE >::operator-=(), and RDNumeric::Matrix< TYPE >::operator/=().

◆ d_nCols

template<class TYPE >

unsigned int RDNumeric::Matrix< TYPE >::d_nCols {0}

protected

Definition at line 234 of file Matrix.h.

Referenced by RDNumeric::Matrix< TYPE >::assign(), RDNumeric::Matrix< TYPE >::getCol(), RDNumeric::Matrix< TYPE >::getRow(), RDNumeric::Matrix< TYPE >::getVal(), RDNumeric::Matrix< TYPE >::numCols(), RDNumeric::SquareMatrix< TYPE >::operator*=(), RDNumeric::Matrix< TYPE >::operator+=(), RDNumeric::Matrix< TYPE >::operator-=(), RDNumeric::Matrix< TYPE >::setVal(), RDNumeric::Matrix< TYPE >::transpose(), and RDNumeric::SquareMatrix< TYPE >::transposeInplace().

◆ d_nRows

template<class TYPE >

unsigned int RDNumeric::Matrix< TYPE >::d_nRows {0}

protected

Definition at line 233 of file Matrix.h.

Referenced by RDNumeric::Matrix< TYPE >::assign(), RDNumeric::Matrix< TYPE >::getCol(), RDNumeric::Matrix< TYPE >::getRow(), RDNumeric::Matrix< TYPE >::getVal(), RDNumeric::Matrix< TYPE >::numRows(), RDNumeric::SquareMatrix< TYPE >::operator*=(), RDNumeric::Matrix< TYPE >::operator+=(), RDNumeric::Matrix< TYPE >::operator-=(), RDNumeric::Matrix< TYPE >::setVal(), RDNumeric::Matrix< TYPE >::transpose(), and RDNumeric::SquareMatrix< TYPE >::transposeInplace().

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

Matrix.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DATA_SPTR

Constructor & Destructor Documentation

◆ Matrix() [1/5]

◆ Matrix() [2/5]

◆ Matrix() [3/5]

◆ Matrix() [4/5]

◆ ~Matrix()

◆ Matrix() [5/5]

Member Function Documentation

◆ assign()

◆ getCol()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getDataSize()

◆ getRow()

◆ getVal()

◆ numCols()

◆ numRows()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ setVal()

◆ transpose()

Member Data Documentation

◆ d_data

◆ d_dataSize

◆ d_nCols

◆ d_nRows