CscMatrix Class Reference

Complex CSC matrix. More...

#include <matrix.h>

Public Member Functions
	CscMatrix ()
	CscMatrix (size_t m, size_t n)
	CscMatrix (CscMatrix const &A)
	CscMatrix (size_t m, size_t n, const lArrayView p, const lArrayView i, const cArrayView x)
	~CscMatrix ()
CooMatrix	tocoo () const
cArray	dotT (const cArrayView b) const
size_t	size () const
size_t	rows () const
size_t	cols () const
lArray const &	p () const
lArray const &	i () const
cArray const &	x () const
CscMatrix &	operator*= (double r)
CscMatrix &	operator&= (const CscMatrix &B)
CscMatrix &	operator^= (const CscMatrix &B)
bool	hdfsave (const char *name) const
bool	hdfload (const char *name)

Detailed Description

Complex compressed-storage-column-major-ordered sparse matrix. The data are stored in three arrays,

* p, i, x
* 

The format is that used in UMFPACK with interleaved real and comples parts; for explanation see UMFPACK Uses's Guide.

Constructor & Destructor Documentation

CscMatrix::CscMatrix ( )

inline

CscMatrix::CscMatrix ( size_t  m, size_t  n  )

inline

CscMatrix::CscMatrix ( CscMatrix const &  A )

inline

CscMatrix::CscMatrix ( size_t  m, size_t  n, const lArrayView  p, const lArrayView  i, const cArrayView  x  )

inline

CscMatrix::~CscMatrix ( )

inline

Member Function Documentation

size_t CscMatrix::cols ( ) const

inline

cArray CscMatrix::dotT

(

const cArrayView

b

)

const

Matrix-vector product using a transposed matrix, \( A^T \cdot b \). For ordinary matrix vector product convert this matrix first to CSR format.

Parameters

b	Vector to multiply with.

bool CscMatrix::hdfload

(

const char *

name

)

Load matrix from HDF file.

Parameters

name

Filename.

bool CscMatrix::hdfsave

(

const char *

name

)

const

Save matrix to HDF file.

Parameters

name

Filename.

lArray const& CscMatrix::i ( ) const

inline

CscMatrix & CscMatrix::operator&=

(

const CscMatrix &

B

)

Addition of another CSC matrix. The matrices MUST HAVE THE SAME SPARSE STRUCTURE, as no indices are checked.

CscMatrix & CscMatrix::operator*=

(

double

r

)

Multiplication by a real number.

CscMatrix & CscMatrix::operator^=

(

const CscMatrix &

B

)

Subtraction of another CSC matrix. The matrices MUST HAVE THE SAME SPARSE STRUCTURE, as no indices are checked.

lArray const& CscMatrix::p ( ) const

inline

size_t CscMatrix::rows ( ) const

inline

size_t CscMatrix::size ( ) const

inline

CooMatrix CscMatrix::tocoo

(

)

const

Convert to COO-matrix.

cArray const& CscMatrix::x ( ) const

inline

---

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

• src/matrix.h
• src/matrix.cpp