c_affine_matrix_function.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_AFFINE_MATRIX_FUNCTION_H_
#define _C_LINEAR_OPERATOR_C_AFFINE_MATRIX_FUNCTION_H_
 
 
// =======
// Headers
// =======
 
#include "../_definitions/types.h"  // LongIndexType
#include "./c_linear_operator.h"  // cLinearOperator
 
 
// ========================
// c Affine Matrix Function
// ========================
 
 
template <typename DataType>
class cAffineMatrixFunction : public cLinearOperator<DataType>
{
    public:
 
        // Member methods
        cAffineMatrixFunction();
 
        virtual ~cAffineMatrixFunction();
 
        virtual void set_symmetry(FlagType symmetric) = 0;
 
        DataType get_eigenvalue(
                const DataType* known_parameters,
                const DataType known_eigenvalue,
                const DataType* inquiry_parameters) const;
 
    protected:
 
        // Member methods
        void _add_scaled_vector(
                const DataType* input_vector,
                const LongIndexType vector_size,
                const DataType scale,
                DataType* output_vector) const;
 
        // Member data
        bool B_is_identity;
};
 
 
#endif  // _C_LINEAR_OPERATOR_C_AFFINE_MATRIX_FUNCTION_H_