cCSCAffineMatrixFunction< DataType > Class Template Reference

#include <c_csc_affine_matrix_function.h>

Inheritance diagram for cCSCAffineMatrixFunction< DataType >:

Collaboration diagram for cCSCAffineMatrixFunction< DataType >:

Public Member Functions
	cCSCAffineMatrixFunction (const DataType *A_data_, const LongIndexType *A_indices_, const LongIndexType *A_index_pointer_, const LongIndexType num_rows_, const LongIndexType num_columns_)
	Constructor. Matrix B is assumed to be the identity matrix. More...
	cCSCAffineMatrixFunction (const DataType *A_data_, const LongIndexType *A_indices_, const LongIndexType *A_index_pointer_, const LongIndexType num_rows_, const LongIndexType num_colums_, const DataType *B_data_, const LongIndexType *B_indices_, const LongIndexType *B_index_pointer_)
virtual	~cCSCAffineMatrixFunction ()
virtual void	dot (const DataType *vector, DataType *product)
	Computes the matrix vector product: More...
virtual void	transpose_dot (const DataType *vector, DataType *product)
	Computes the matrix vector product: More...
Public Member Functions inherited from cAffineMatrixFunction< DataType >
	cAffineMatrixFunction (const LongIndexType num_rows_, const LongIndexType num_columns_)
	Constructor. More...
virtual	~cAffineMatrixFunction ()
	Virtual destructor. More...
void	set_parameters (DataType *t)
DataType	get_eigenvalue (const DataType *known_parameters, const DataType known_eigenvalue, const DataType *inquiry_parameters) const
	This function defines an analytic relationship between a given set of parameters and the corresponding eigenvalue of the operator. Namely, given a set of parameters and a known eigenvalue of the operator for that specific set of parameters, this function obtains the eigenvalue of the operator for an other given set of parameters. More...
Public Member Functions inherited from cLinearOperator< DataType >
	cLinearOperator ()
	Default constructor. More...
	cLinearOperator (const LongIndexType num_rows_, const LongIndexType num_columns_)
	Constructor with setting num_rows and num_columns. More...
virtual	~cLinearOperator ()
LongIndexType	get_num_rows () const
LongIndexType	get_num_columns () const
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. More...
IndexType	get_num_parameters () const
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. More...

Protected Attributes
cCSCMatrix< DataType >	A
cCSCMatrix< DataType >	B
Protected Attributes inherited from cAffineMatrixFunction< DataType >
bool	B_is_identity
Protected Attributes inherited from cLinearOperator< DataType >
const LongIndexType	num_rows
const LongIndexType	num_columns
FlagType	eigenvalue_relation_known
DataType *	parameters
IndexType	num_parameters

Additional Inherited Members
Protected Member Functions inherited from cAffineMatrixFunction< DataType >
void	_add_scaled_vector (const DataType *input_vector, const LongIndexType vector_size, const DataType scale, DataType *output_vector) const
	Performs the operation \( \boldsymbol{c} = \boldsymbol{c} + \alpha * \boldsymbol{b} \), where \( \boldsymbol{b} \) is an input vector scaled by \( \alpha \) and \( \boldsymbol{c} \) it the output vector. More...

Detailed Description

template<typename DataType>
class cCSCAffineMatrixFunction< DataType >

Definition at line 30 of file c_csc_affine_matrix_function.h.

Constructor & Destructor Documentation

cCSCAffineMatrixFunction() [1/2]

template<typename DataType >

cCSCAffineMatrixFunction< DataType >::cCSCAffineMatrixFunction	(	const DataType *	A_data_,
		const LongIndexType *	A_indices_,
		const LongIndexType *	A_index_pointer_,
		const LongIndexType	num_rows_,
		const LongIndexType	num_columns_
	)

Constructor. Matrix B is assumed to be the identity matrix.

Definition at line 29 of file c_csc_affine_matrix_function.cpp.

                                         :
 
    // Base class constructor
    cAffineMatrixFunction<DataType>(num_rows_, num_columns_),
 
    // Initializer list
    A(A_data_, A_indices_, A_index_pointer_, num_rows_, num_columns_)
{
    // This constructor is called assuming B is identity
    this->B_is_identity = true;
 
    // When B is identity, the eigenvalues of A+tB are known for any t
    this->eigenvalue_relation_known = 1;
}

References cAffineMatrixFunction< DataType >::B_is_identity, and cLinearOperator< DataType >::eigenvalue_relation_known.

cCSCAffineMatrixFunction() [2/2]

template<typename DataType >

cCSCAffineMatrixFunction< DataType >::cCSCAffineMatrixFunction	(	const DataType *	A_data_,
		const LongIndexType *	A_indices_,
		const LongIndexType *	A_index_pointer_,
		const LongIndexType	num_rows_,
		const LongIndexType	num_colums_,
		const DataType *	B_data_,
		const LongIndexType *	B_indices_,
		const LongIndexType *	B_index_pointer_
	)

Definition at line 55 of file c_csc_affine_matrix_function.cpp.

                                              :
 
    // Base class constructor
    cAffineMatrixFunction<DataType>(num_rows_, num_columns_),
 
    // Initializer list
    A(A_data_, A_indices_, A_index_pointer_, num_rows_, num_columns_),
    B(B_data_, B_indices_, B_index_pointer_, num_rows_, num_columns_)
{
    // Matrix B is assumed to be non-zero. Check if it is identity or generic
    if (this->B.is_identity_matrix())
    {
        this->B_is_identity = true;
        this->eigenvalue_relation_known = 1;
    }
}

References cCSCAffineMatrixFunction< DataType >::B, cAffineMatrixFunction< DataType >::B_is_identity, and cLinearOperator< DataType >::eigenvalue_relation_known.

~cCSCAffineMatrixFunction()

template<typename DataType >

cCSCAffineMatrixFunction< DataType >::~cCSCAffineMatrixFunction

virtual

Definition at line 86 of file c_csc_affine_matrix_function.cpp.

{
}

Member Function Documentation

dot()

template<typename DataType >

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

virtual

Computes the matrix vector product:

\[ \boldsymbol{c} = (\mathbf{A} + t \mathbf{B}) \boldsymbol{b}. \]

Parameters

[in]	vector	The input vector :math:\\boldsymbol{b} is given by vector. If \( \mathbf{A} \) and \( \mathbf{B} \) are \( m \times n \) matrices, the length of input c vector is n.
[out]	product	The output of the product, \( \boldsymbol{c} \), is written in-place into this array. Let m be the number of rows of \( \mathbf{A} \) and \( \mathbf{B} \), then, the output vector product is 1D column array of length m.

Implements cLinearOperator< DataType >.

Definition at line 112 of file c_csc_affine_matrix_function.cpp.

{
    // Matrix A times vector
    this->A.dot(vector, product);
    LongIndexType min_vector_size;
 
    // Matrix B times vector to be added to the product
    if (this->B_is_identity)
    {
        // Check parameter is set
        assert((this->parameters != NULL) && "Parameter is not set.");
 
        // Find minimum of the number of rows and columns
        min_vector_size = \
            (this->num_rows < this->num_columns) ? \
            this->num_rows : this->num_columns;
 
        // Adding input vector to product
        this->_add_scaled_vector(vector, min_vector_size,
                                 this->parameters[0], product);
    }
    else
    {
        // Check parameter is set
        assert((this->parameters != NULL) && "Parameter is not set.");
 
        // Adding parameter times B times input vector to the product
        this->B.dot_plus(vector, this->parameters[0], product);
    }
}

transpose_dot()

template<typename DataType >

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

virtual

Computes the matrix vector product:

\[ \boldsymbol{c} = (\mathbf{A} + t \mathbf{B})^{\intercal} \boldsymbol{b}. \]

Parameters

[in]	vector	The input vector \( \boldsymbol{b} \) is given by vector. If \( \mathbf{A} \) and \( \mathbf{B} \) are \( m \times n \) matrices, the length of input vector is n.
[out]	product	The output of the product, \( \boldsymbol{c} \), is written in-place into this array. Let n be the number of columns of \( \mathbf{A} \) and \( \mathbf{B} \), then, the output vector product is 1D column array of length m.

Implements cLinearOperator< DataType >.

Definition at line 168 of file c_csc_affine_matrix_function.cpp.

{
    // Matrix A times vector
    this->A.transpose_dot(vector, product);
    LongIndexType min_vector_size;
 
    // Matrix B times vector to be added to the product
    if (this->B_is_identity)
    {
        // Check parameter is set
        assert((this->parameters != NULL) && "Parameter is not set.");
 
        // Find minimum of the number of rows and columns
        min_vector_size = \
            (this->num_rows < this->num_columns) ? \
            this->num_rows : this->num_columns;
 
        // Adding input vector to product
        this->_add_scaled_vector(vector, min_vector_size,
                                 this->parameters[0], product);
    }
    else
    {
        // Check parameter is set
        assert((this->parameters != NULL) && "Parameter is not set.");
 
        // Adding "parameter * B * input vector" to the product
        this->B.transpose_dot_plus(vector, this->parameters[0], product);
    }
}

Member Data Documentation

A

template<typename DataType >

cCSCMatrix<DataType> cCSCAffineMatrixFunction< DataType >::A

protected

Definition at line 65 of file c_csc_affine_matrix_function.h.

B

template<typename DataType >

cCSCMatrix<DataType> cCSCAffineMatrixFunction< DataType >::B

protected

Definition at line 66 of file c_csc_affine_matrix_function.h.

Referenced by cCSCAffineMatrixFunction< DataType >::cCSCAffineMatrixFunction().

---

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

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