c_vector_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_VECTOR_OPERATIONS_H_
#define _C_BASIC_ALGEBRA_C_VECTOR_OPERATIONS_H_
 
// =======
// Headers
// =======
 
#include "../_definitions/types.h"  // LongIndexType
 
// 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
 
 
// =================
// Vector Operations
// =================
 
 
template <typename DataType>
class cVectorOperations
{
    public:
 
        // copy vector
        static void copy_vector(
                const DataType* RESTRICT input_vector,
                const LongIndexType vector_size,
                DataType* RESTRICT output_vector);
 
        // copy scaled vector
        static void copy_scaled_vector(
                const DataType* RESTRICT input_vector,
                const LongIndexType vector_size,
                const DataType scale,
                DataType* RESTRICT output_vector);
 
        // subtract scaled vector
        static void subtract_scaled_vector(
                const DataType* RESTRICT input_vector,
                const LongIndexType vector_size,
                const DataType scale,
                DataType* RESTRICT output_vector);
 
        // inner product
        static DataType inner_product(
                const DataType* RESTRICT vector1,
                const DataType* RESTRICT vector2,
                const LongIndexType vector_size);
 
        // euclidean norm
        static DataType euclidean_norm(
                const DataType* RESTRICT vector,
                const LongIndexType vector_size);
 
        // normalize vector in place
        static DataType normalize_vector_in_place(
                DataType* RESTRICT vector,
                const LongIndexType vector_size);
 
        // normalize vector and copy
        static DataType normalize_vector_and_copy(
                const DataType* RESTRICT vector,
                const LongIndexType vector_size,
                DataType* RESTRICT output_vector);
};
 
#endif  // _C_BASIC_ALGEBRA_C_VECTOR_OPERATIONS_H_