Taucs_matrix<T>

Navigation: Up, Table of Contents, Package Overview, Bibliography, Index, Title Page , Acknowledging CGAL

CGAL::Taucs_matrix<T>

The class Taucs_matrix is a C++ wrapper around TAUCS' matrix type taucs_ccs_matrix.

This kind of matrix can be either symmetric or not. Symmetric matrices store only the lower triangle.

The full template declaration is:

template<
class T>
struct Taucs_matrix;

Taucs_matrix<T>::NT

Taucs_matrix<T> M ( int dim, bool is_symmetric = false);
	Create a square matrix initialized with zeros.

Parameters:

Taucs_matrix<T> M ( int rows, int columns, bool is_symmetric = false);
	Create a rectangular matrix initialized with zeros.

Parameters:

int	M.row_dimension ()	Return the matrix number of rows.
int	M.column_dimension ()	Return the matrix number of columns.
T	M.get_coef ( int i, int j)	Read access to a matrix coefficient. Preconditions: 0 <= i < row_dimension(). 0 <= j < column_dimension().
void	M.set_coef ( int i, int j, T val, bool new_coef = false)
		Write access to a matrix coefficient: a_ij <- val. Optimizations: For symmetric matrices, Taucs_matrix stores only the lower triangle set_coef() does nothing if (i, j) belongs to the upper triangle. Caller can optimize this call by setting new_coef to true if the coefficient does not already exist in the matrix. Preconditions: 0 <= i < row_dimension(). 0 <= j < column_dimension().
void	M.add_coef ( int i, int j, T val)	Write access to a matrix coefficient: a_ij <- a_ij + val. Optimization: For symmetric matrices, Taucs_matrix stores only the lower triangle add_coef() does nothing if (i, j) belongs to the upper triangle. Preconditions: 0 <= i < row_dimension(). 0 <= j < column_dimension().
const taucs_ccs_matrix*	M.get_taucs_matrix ()	Construct and return the TAUCS matrix wrapped by this object. The TAUCS matrix returned by this method is valid only until the next call to get_coef(), set_coef() or add_coef().