SparseMatrix< ScalarType > Class Template Reference

#include <sparse_matrix.h>

List of all members.

Public Types
typedef std::pair< int, int >	IndexType
Public Member Functions
virtual ScalarType &	A (int row, int col)
	return the value of the matrix
virtual void	CreateSparse (std::vector< IndexType > Entries)
virtual void	Initalize (int dimension)
	initilaization of the system
virtual bool	IsSymmetric ()
	return true if the rapresention of sparse matriz is symmetric
virtual int	Size ()
	return the dimension of the matrix
virtual void	Zero ()
Public Attributes
std::vector< int >	_Ai
std::vector< int >	_Ap
std::vector< double >	_Ax
int	_dimension

---

Detailed Description

template<class ScalarType>
class SparseMatrix< ScalarType >

this class define the interface to use sparse matrix you must extend this class and implement the code of each function in order to the system solver you're using. For details on implementation see system_interface_LDL.h as example

Definition at line 11 of file sparse_matrix.h.

---

Member Typedef Documentation

template<class ScalarType>

typedef std::pair<int,int> SparseMatrix< ScalarType >::IndexType

Definition at line 19 of file sparse_matrix.h.

---

Member Function Documentation

template<class ScalarType>

virtual ScalarType& SparseMatrix< ScalarType >::A	(	int	row,
		int	col
	)		[inline, virtual]

return the value of the matrix

Reimplemented in SystemLDL.

Definition at line 35 of file sparse_matrix.h.

template<class ScalarType>

virtual void SparseMatrix< ScalarType >::CreateSparse

(

std::vector< IndexType >

Entries

)

[inline, virtual]

create a sparse matrix given a set of entries as vector of pair of int

Reimplemented in SystemLDL.

Definition at line 31 of file sparse_matrix.h.

template<class ScalarType>

virtual void SparseMatrix< ScalarType >::Initalize

(

int

dimension

)

[inline, virtual]

initilaization of the system

Reimplemented in SystemLDL.

Definition at line 26 of file sparse_matrix.h.

template<class ScalarType>

virtual bool SparseMatrix< ScalarType >::IsSymmetric

(

)

[inline, virtual]

return true if the rapresention of sparse matriz is symmetric

Reimplemented in SystemLDL.

Definition at line 39 of file sparse_matrix.h.

template<class ScalarType>

virtual int SparseMatrix< ScalarType >::Size

(

)

[inline, virtual]

return the dimension of the matrix

Reimplemented in SystemLDL.

Definition at line 46 of file sparse_matrix.h.

template<class ScalarType>

virtual void SparseMatrix< ScalarType >::Zero

(

void

)

[inline, virtual]

Reimplemented in SystemLDL.

Definition at line 42 of file sparse_matrix.h.

---

Member Data Documentation

template<class ScalarType>

std::vector<int> SparseMatrix< ScalarType >::_Ai

Definition at line 16 of file sparse_matrix.h.

template<class ScalarType>

std::vector<int> SparseMatrix< ScalarType >::_Ap

Definition at line 15 of file sparse_matrix.h.

template<class ScalarType>

std::vector<double> SparseMatrix< ScalarType >::_Ax

Definition at line 17 of file sparse_matrix.h.

template<class ScalarType>

int SparseMatrix< ScalarType >::_dimension

Definition at line 21 of file sparse_matrix.h.

---

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

• sparse_matrix.h