cCSCMatrix< DataType > Class Template Reference

Container for CSC matrices. More...

#include <c_csc_matrix.h>

Inheritance diagram for cCSCMatrix< DataType >:

Collaboration diagram for cCSCMatrix< DataType >:

Public Member Functions
	cCSCMatrix ()
	Default constructor.
	cCSCMatrix (const DataType *A_data_, const LongIndexType *A_indices_, const LongIndexType *A_index_pointer_, const LongIndexType num_rows_, const LongIndexType num_columns_, const FlagType A_is_symmetric_)
	Constructor.
virtual	~cCSCMatrix ()
	Destructor.
virtual FlagType	is_identity_matrix () const
	Checks whether the matrix is identity.
LongIndexType	get_nnz () const
	Returns the number of non-zero elements of the sparse matrix.
virtual void	dot (const DataType *vector, DataType *product)
	Matrix vector product.
virtual void	dot_plus (const DataType *vector, const DataType alpha, DataType *product)
	Matrix vector product written in place.
virtual void	transpose_dot (const DataType *vector, DataType *product)
	Transposed-matrix vector product.
virtual void	transpose_dot_plus (const DataType *vector, const DataType alpha, DataType *product)
	Transposed-matrix vector product written in place.
Public Member Functions inherited from cMatrix< DataType >
	cMatrix ()
	Default constructor.
	cMatrix (const FlagType A_is_symmetric_)
	Constructor.
virtual	~cMatrix ()
	Destructor.
DataType	get_eigenvalue (const DataType *known_parameters, const DataType known_eigenvalue, const DataType *inquiry_parameters) const
	This virtual function is implemented from its pure virtual function of the base class. In this class, this functio has no use and was only implemented so that this class be able to be instantiated (due to the pure virtual function).
virtual void	set_symmetry (const FlagType symmetric)
	Specify whether the matrix is symmetic or non-symmetric.
Public Member Functions inherited from cLinearOperator< DataType >
	cLinearOperator ()
	Default constructor.
virtual	~cLinearOperator ()
	Destructor.
void	set_parameters (DataType *parameters_)
	Sets the scalar parameter this->parameters. Parameter is initialized to NULL. However, before calling dot or transpose_dot functions, the parameters must be set.
Public Member Functions inherited from cLinearOperatorBase
	cLinearOperatorBase ()
	Default constructor.
	cLinearOperatorBase (const LongIndexType num_rows_, const LongIndexType num_columns_)
	Constructor with setting num_rows and num_columns.
virtual	~cLinearOperatorBase ()
	Destructor.
LongIndexType	get_num_rows () const
	Returns the number of rows of the matrix.
LongIndexType	get_num_columns () const
	Returns the number of columns of the matrix.
IndexType	get_num_parameters () const
	Returns the number of parameters of the linear operator.
FlagType	is_eigenvalue_relation_known () const
	Returns a flag that determines whether a relation between the parameters of the operator and its eigenvalue(s) is known.

Protected Attributes
const DataType *	A_data
const LongIndexType *	A_indices
const LongIndexType *	A_index_pointer
Protected Attributes inherited from cMatrix< DataType >
FlagType	A_is_symmetric
Protected Attributes inherited from cLinearOperator< DataType >
DataType *	parameters
Protected Attributes inherited from cLinearOperatorBase
const LongIndexType	num_rows
const LongIndexType	num_columns
FlagType	eigenvalue_relation_known
IndexType	num_parameters

Detailed Description

template<typename DataType>
class cCSCMatrix< DataType >

Container for CSC matrices.

The cCSCMatrix holds a two-dimensional compressed sparse column matrix, and can perofrom matrix-vector product and transposed matrix-vector product.

See also

cMatrix, cDenseMatrix, cCSRMatrix, cCSCAffineMatrixFunction, cuCSCMatrix

Definition at line 43 of file c_csc_matrix.h.

Constructor & Destructor Documentation

cCSCMatrix() [1/2]

template<typename DataType >

cCSCMatrix< DataType >::cCSCMatrix

(

)

Default constructor.

Definition at line 34 of file c_csc_matrix.cpp.

                                :
    A_data(NULL),
    A_indices(NULL),
    A_index_pointer(NULL)
{
}

cCSCMatrix() [2/2]

template<typename DataType >

cCSCMatrix< DataType >::cCSCMatrix	(	const DataType *	A_data_,
		const LongIndexType *	A_indices_,
		const LongIndexType *	A_index_pointer_,
		const LongIndexType	num_rows_,
		const LongIndexType	num_columns_,
		const FlagType	A_is_symmetric_
	)

Constructor.

Parameters

[in]	A_data_	1D array of the data content of sparse matrix. The size of the array is the nnz of the matrix.
[in]	A_indices_	1D array indicating the row of each element in A_data_ . The size of this array is the nnz of the matrix.
[in]	A_index_pointer_	1D array pointing to the start of new rows in A_indices_ . The size of this array is num_rows+1 . The first element of this array is 0 and the last element of this array is the nnz of the matrix.
[in]	num_rows_	Number of rows of A
[in]	num_columns_	Number of columns of A
[in]	A_is_symmetric_	Boolean. If A is symmetric, set this value to 1, otherwise 0.

Definition at line 68 of file c_csc_matrix.cpp.

                                       :
 
    // Base class constructors
    cLinearOperatorBase(num_rows_, num_columns_),
    cMatrix<DataType>(A_is_symmetric_),
 
    // Initializer list
    A_data(A_data_),
    A_indices(A_indices_),
    A_index_pointer(A_index_pointer_)
{
}

~cCSCMatrix()

template<typename DataType >

cCSCMatrix< DataType >::~cCSCMatrix ( )

virtual

Destructor.

Definition at line 96 of file c_csc_matrix.cpp.

{
}

Member Function Documentation

dot()

template<typename DataType >

void cCSCMatrix< DataType >::dot ( const DataType *  vector, DataType *  product  )

virtual

Matrix vector product.

Performs the matrix vector product \( \boldsymbol{y} = \mathbf{A} \boldsymbol{x} \).

Parameters

[in]	vector	A one-dimensional input vector \( \boldsymbol{x} \) with size the of the number of columns of the matrix \( \mathbf{A} \).
[out]	product	A one-dimensional output vector \( \boldsymbol{y} \) with the size of the number of rows of \( \mathbf{A} \). This vector will be overwritten.

See also

cCSCMatrix::dot_plus, cCSCMatrix::transposed_dot cCSCMatrix::transposed_dot_plus

Implements cLinearOperator< DataType >.

Definition at line 211 of file c_csc_matrix.cpp.

{
    cMatrixOperations<DataType>::csc_matvec(
            this->A_data,
            this->A_indices,
            this->A_index_pointer,
            this->A_is_symmetric,
            vector,
            this->num_rows,
            this->num_columns,
            product);
}

References cMatrixOperations< DataType >::csc_matvec().

Here is the call graph for this function:

dot_plus()

template<typename DataType >

void cCSCMatrix< DataType >::dot_plus ( const DataType *  vector, const DataType  alpha, DataType *  product  )

virtual

Matrix vector product written in place.

Performs the matrix vector product \( \boldsymbol{y} = \boldsymbol{y} + \alpha \mathbf{A} \boldsymbol{x} \).

Parameters

[in]	vector	A one-dimensional input vector \( \boldsymbol{x} \) with size the of the number of columns of the matrix \( \mathbf{A} \).
[in]	alpha	A scalar.
[out]	product	A one-dimensional output vector \( \boldsymbol{y} \) with the size of the number of rows of \( \mathbf{A} \).

See also

cCSCMatrix::dot, cCSCMatrix::transposed_dot cCSCMatrix::transposed_dot_plus

Implements cMatrix< DataType >.

Definition at line 250 of file c_csc_matrix.cpp.

{
    cMatrixOperations<DataType>::csc_matvec_plus(
            this->A_data,
            this->A_indices,
            this->A_index_pointer,
            this->A_is_symmetric,
            vector,
            alpha,
            this->num_columns,
            product);
}

References cMatrixOperations< DataType >::csc_matvec_plus().

Here is the call graph for this function:

get_nnz()

template<typename DataType >

LongIndexType cCSCMatrix< DataType >::get_nnz

(

)

const

Returns the number of non-zero elements of the sparse matrix.

The nnz of a CSC matrix can be obtained from the last element of A_index_pointer. The size of array A_index_pointer is one plus the number of columns of the matrix.

Returns

The nnz of the matrix.

Definition at line 183 of file c_csc_matrix.cpp.

{
    return this->A_index_pointer[this->num_columns];
}

is_identity_matrix()

template<typename DataType >

FlagType cCSCMatrix< DataType >::is_identity_matrix ( ) const

virtual

Checks whether the matrix is identity.

The identity check is primarily performed in the cAffineMatrixFunction class.

Returns

Returns 1 if the input matrix is identity, and 0 otherwise.

See also

cAffineMatrixFunction

Implements cMatrix< DataType >.

Definition at line 115 of file c_csc_matrix.cpp.

{
    FlagType matrix_is_identity = 1;
    LongIndexType index_pointer;
    LongIndexType row;
    DataType matrix_element;
    const DataType diagonal = 1.0;
    const DataType off_diagonal = 0.0;
 
    // Check matrix element-wise
    #if defined(USE_OPENMP) && (USE_OPENMP == 1)
    #pragma omp parallel for \
        schedule(static) \
        if (!omp_in_parallel()) \
        default(none) \
        shared(matrix_is_identity, diagonal, off_diagonal) \
        private(index_pointer, row, matrix_element)
    #endif
    for (LongIndexType column=0; column < this->num_columns; ++column)
    {
        if (matrix_is_identity)
        {
            for (index_pointer=this->A_index_pointer[column];
                 index_pointer < this->A_index_pointer[column+1];
                 ++index_pointer)
            {
                row = this->A_indices[index_pointer];
 
                if (!((this->A_is_symmetric) && (column >= row)))
                {
                    matrix_element = this->A_data[index_pointer];
 
                    if (((row == column) && \
                         (!c_arithmetics::is_equal(matrix_element,
                                                   diagonal))) || \
                        ((row != column) && \
                         (!c_arithmetics::is_equal(matrix_element,
                                                   off_diagonal))))
                    {
                        #if defined(USE_OPENMP) && (USE_OPENMP == 1)
                        #pragma omp atomic write
                        #endif
                        matrix_is_identity = 0;
 
                        break;
                    }
                }
            }
        }
    }
 
    return matrix_is_identity;
}

References c_arithmetics::is_equal().

Here is the call graph for this function:

transpose_dot()

template<typename DataType >

void cCSCMatrix< DataType >::transpose_dot ( const DataType *  vector, DataType *  product  )

virtual

Transposed-matrix vector product.

Performs the matrix vector product \( \boldsymbol{y} = \mathbf{A}^{\intercal} \boldsymbol{x} \).

Parameters

[in]	vector	A one-dimensional input vector \( \boldsymbol{x} \) with size the of the number of columns of the matrix \( \mathbf{A} \).
[out]	product	A one-dimensional output vector \( \boldsymbol{y} \) with the size of the number of rows of \( \mathbf{A} \). This vector will be overwritten.

See also

cCSCMatrix::dot_plus, cCSCMatrix::dot cCSCMatrix::transposed_dot_plus

Implements cLinearOperator< DataType >.

Definition at line 289 of file c_csc_matrix.cpp.

{
    cMatrixOperations<DataType>::csc_transposed_matvec(
            this->A_data,
            this->A_indices,
            this->A_index_pointer,
            vector,
            this->num_columns,
            product);
}

References cMatrixOperations< DataType >::csc_transposed_matvec().

Here is the call graph for this function:

transpose_dot_plus()

template<typename DataType >

void cCSCMatrix< DataType >::transpose_dot_plus ( const DataType *  vector, const DataType  alpha, DataType *  product  )

virtual

Transposed-matrix vector product written in place.

Performs the matrix vector product \( \boldsymbol{y} = \boldsymbol{y} + \alpha \mathbf{A}^{\intercal} \boldsymbol{x} \).

Parameters

[in]	vector	A one-dimensional input vector \( \boldsymbol{x} \) with size the of the number of columns of the matrix \( \mathbf{A} \).
[in]	alpha	A scalar.
[out]	product	A one-dimensional output vector \( \boldsymbol{y} \) with the size of the number of rows of \( \mathbf{A} \).

See also

cCSCMatrix::dot_plus, cCSCMatrix::transposed_dot cCSCMatrix::dot

Implements cMatrix< DataType >.

Definition at line 327 of file c_csc_matrix.cpp.

{
    cMatrixOperations<DataType>::csc_transposed_matvec_plus(
            this->A_data,
            this->A_indices,
            this->A_index_pointer,
            vector,
            alpha,
            this->num_columns,
            product);
}

References cMatrixOperations< DataType >::csc_transposed_matvec_plus().

Here is the call graph for this function:

Member Data Documentation

A_data

template<typename DataType >

const DataType* cCSCMatrix< DataType >::A_data

protected

Definition at line 85 of file c_csc_matrix.h.

A_index_pointer

template<typename DataType >

const LongIndexType* cCSCMatrix< DataType >::A_index_pointer

protected

Definition at line 87 of file c_csc_matrix.h.

A_indices

template<typename DataType >

const LongIndexType* cCSCMatrix< DataType >::A_indices

protected

Definition at line 86 of file c_csc_matrix.h.

---

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

• /home/runner/work/imate/imate/imate/_c_linear_operator/c_csc_matrix.h
• /home/runner/work/imate/imate/imate/_c_linear_operator/c_csc_matrix.cpp