c_matrix_operations.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_BASIC_ALGEBRA_C_MATRIX_OPERATIONS_H_
#define _C_BASIC_ALGEBRA_C_MATRIX_OPERATIONS_H_
 
// =======
// Headers
// =======
 
#include "../_definitions/types.h"  // IndexType, LongIndexType, FlagType
 
// Restrict qualifier
#if defined(_MSC_VER)
    #define RESTRICT __restrict
#elif defined(__INTEL_COMPILER)
    #define RESTRICT __restrict
#elif defined(__CUDA__) || defined(__GNUC__) || defined(__clang__)
    #define RESTRICT __restrict__
#else
    #define RESTRICT
#endif
 
 
// ===================
// c Matrix Operations
// ===================
 
 
template <typename DataType>
class cMatrixOperations
{
    public:
 
        // dense matvec
        static void dense_matvec(
                const DataType* RESTRICT A,
                const DataType* RESTRICT b,
                const LongIndexType num_rows,
                const LongIndexType num_columns,
                const FlagType A_is_row_major,
                const FlagType A_is_symmetric,
                DataType* RESTRICT c);
 
        // dense matvec plus
        static void dense_matvec_plus(
                const DataType* RESTRICT A,
                const DataType* RESTRICT b,
                const DataType alpha,
                const LongIndexType num_rows,
                const LongIndexType num_columns,
                const FlagType A_is_row_major,
                const FlagType A_is_symmetric,
                DataType* RESTRICT c);
 
        // dense transposed matvec
        static void dense_transposed_matvec(
                const DataType* RESTRICT A,
                const DataType* RESTRICT b,
                const LongIndexType num_rows,
                const LongIndexType num_columns,
                const FlagType A_is_row_major,
                const FlagType A_is_symmetric,
                DataType* RESTRICT c);
 
        // dense transposed matvec plus
        static void dense_transposed_matvec_plus(
                const DataType* RESTRICT A,
                const DataType* RESTRICT b,
                const DataType alpha,
                const LongIndexType num_rows,
                const LongIndexType num_columns,
                const FlagType A_is_row_major,
                const FlagType A_is_symmetric,
                DataType* RESTRICT c);
 
        // CSR matvec
        static void csr_matvec(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_column_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const DataType* RESTRICT b,
                const LongIndexType num_rows,
                DataType* RESTRICT c);
 
        // CSR matvec plus
        static void csr_matvec_plus(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_column_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const DataType* RESTRICT b,
                const DataType alpha,
                const LongIndexType num_rows,
                DataType* RESTRICT c);
 
        // CSR transposed matvec
        static void csr_transposed_matvec(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_column_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const FlagType A_is_symmetric,
                const DataType* RESTRICT b,
                const LongIndexType num_rows,
                const LongIndexType num_columns,
                DataType* RESTRICT c);
 
        // CSR transposed matvec plus
        static void csr_transposed_matvec_plus(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_column_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const FlagType A_is_symmetric,
                const DataType* RESTRICT b,
                const DataType alpha,
                const LongIndexType num_rows,
                DataType* RESTRICT c);
 
        // CSC matvec
        static void csc_matvec(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_row_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const FlagType A_is_symmetric,
                const DataType* RESTRICT b,
                const LongIndexType num_rows,
                const LongIndexType num_columns,
                DataType* RESTRICT c);
 
        // CSC matvec plus
        static void csc_matvec_plus(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_row_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const FlagType A_is_symmetric,
                const DataType* RESTRICT b,
                const DataType alpha,
                const LongIndexType num_columns,
                DataType* RESTRICT c);
 
        // CSC transposed matvec
        static void csc_transposed_matvec(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_row_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const DataType* RESTRICT b,
                const LongIndexType num_columns,
                DataType* RESTRICT c);
 
        // CSC transposed matvec plus
        static void csc_transposed_matvec_plus(
                const DataType* RESTRICT A_data,
                const LongIndexType* RESTRICT A_row_indices,
                const LongIndexType* RESTRICT A_index_pointer,
                const DataType* RESTRICT b,
                const DataType alpha,
                const LongIndexType num_columns,
                DataType* RESTRICT c);
 
        // Create Band Matrix
        static void create_band_matrix(
                DataType* RESTRICT A,
                const LongIndexType num_rows,
                const LongIndexType num_columns,
                const FlagType A_is_row_major,
                const DataType* RESTRICT diagonals,
                const DataType* RESTRICT supdiagonals,
                const IndexType non_zero_size,
                const FlagType tridiagonal);
};
 
#endif  // _C_BASIC_ALGEBRA_C_MATRIX_OPERATIONS_H_