c_matrix.h

Go to the documentation of this file.

/*
 *  SPDX-FileCopyrightText: Copyright 2021, Siavash Ameli <sameli@berkeley.edu>
 *  SPDX-License-Identifier: BSD-3-Clause
 *  SPDX-FileType: SOURCE
 *
 *  This program is free software: you can redistribute it and/or modify it
 *  under the terms of the license found in the LICENSE.txt file in the root
 *  directory of this source tree.
 */
 
 
#ifndef _C_LINEAR_OPERATOR_C_MATRIX_H_
#define _C_LINEAR_OPERATOR_C_MATRIX_H_
 
 
// =======
// Headers
// =======
 
#include "../_definitions/types.h"  // FlagType, IndexType, LongIndexType
#include "./c_linear_operator.h"  // cLinearOperator
 
 
// ========
// c Matrix
// ========
 
 
template <typename DataType>
class cMatrix : virtual public cLinearOperator<DataType>
{
    public:
 
        // Member methods
        cMatrix();
        
        explicit cMatrix(const FlagType A_is_symmetric_);
 
        virtual ~cMatrix();
 
        DataType get_eigenvalue(
                const DataType* known_parameters,
                const DataType known_eigenvalue,
                const DataType* inquiry_parameters) const;
 
        virtual FlagType is_identity_matrix() const = 0;
 
        virtual void set_symmetry(const FlagType symmetric);
 
        virtual void dot_plus(
                const DataType* vector,
                const DataType alpha,
                DataType* product) = 0;
 
        virtual void transpose_dot_plus(
                const DataType* vector,
                const DataType alpha,
                DataType* product) = 0;
 
    protected:
 
        // Member data
        FlagType A_is_symmetric;
};
 
 
#endif  // _C_LINEAR_OPERATOR_C_MATRIX_H_