BLAS.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_BLAS_HPP
#define CUBBYFLOW_BLAS_HPP

namespace CubbyFlow
{
template <typename S, typename V, typename M>
struct BLAS
{
    using ScalarType = S;
    using VectorType = V;
    using MatrixType = M;

    static void Set(ScalarType s, VectorType* result);

    static void Set(const VectorType& v, VectorType* result);

    static void Set(ScalarType s, MatrixType* result);

    static void Set(const MatrixType& m, MatrixType* result);

    [[nodiscard]] static ScalarType Dot(const VectorType& a,
                                        const VectorType& b);

    static void AXPlusY(ScalarType a, const VectorType& x, const VectorType& y,
                        VectorType* result);

    static void MVM(const MatrixType& m, const VectorType& v,
                    VectorType* result);

    static void Residual(const MatrixType& a, const VectorType& x,
                         const VectorType& b, VectorType* result);

    [[nodiscard]] static ScalarType L2Norm(const VectorType& v);

    [[nodiscard]] static ScalarType LInfNorm(const VectorType& v);
};
}  // namespace CubbyFlow

#include <Core/Math/BLAS-Impl.hpp>

#endif