306 lines
8.6 KiB
C++
306 lines
8.6 KiB
C++
/**++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
*
|
|
*
|
|
* PANIC
|
|
* Portable Algorithms and Numerics In C++
|
|
*
|
|
* Scientific computing from scratch, with feeling.
|
|
*
|
|
* Copyright (c) 2026 Michelle Bausager
|
|
*
|
|
* This file is part of PANIC.
|
|
*
|
|
* PANIC is free software licensed under the GNU General Public License v3.0 or later.
|
|
* You may redistribute and/or modify it under the terms of the GPL.
|
|
*
|
|
* PANIC is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
|
|
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the LICENSE file for the full license text.
|
|
*
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
*
|
|
* Project Name: PANIC
|
|
* Module Name: math
|
|
* File Name: div.hpp
|
|
* Revision: 0.1.0
|
|
* Date: 30-07-2026
|
|
* Author: Michelle Bausager
|
|
*
|
|
* Description:
|
|
* Functions to divide panic::tensor
|
|
*
|
|
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
*
|
|
* @file mul.hpp
|
|
* @brief Public API for multiplying operations on PANIC vectors and matrices.
|
|
*
|
|
* This header contains the declarations that users of the math module should call.
|
|
* The comments here describe how each function is used, what dimensions are required,
|
|
* and what is returned on failure.
|
|
*
|
|
* Implementation details, OpenMP thresholds, and explicit template instantiations are
|
|
* kept in mul.cpp.
|
|
*
|
|
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
|
|
#pragma once
|
|
|
|
#include <tensor/vector.hpp> // for panic::vector
|
|
#include <tensor/matrix.hpp> // for panic::matrix
|
|
|
|
namespace panic{
|
|
namespace math{
|
|
|
|
|
|
/**
|
|
* @brief Divides a scalar to every element of a vector.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* c[i] = a[i] / k
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param a Input vector.
|
|
* @param k Scalar value multiplied to each element of @p a.
|
|
* @param c Output vector. Resized to match @p a.
|
|
*
|
|
* @return true if @p c was resized and filled successfully.
|
|
* @return false if resizing @p c failed.
|
|
*
|
|
* @note This overload writes the result into an existing vector to avoid
|
|
* unnecessary temporary allocations.
|
|
*/
|
|
template <typename T>
|
|
bool div(const panic::tensor::vector<T>& a, const T k, panic::tensor::vector<T>& c);
|
|
|
|
|
|
/**
|
|
* @brief Returns a new vector containing a scalar divided to every element.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* result[i] = a[i] / k
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param a Input vector.
|
|
* @param k Scalar value miltiplied to each element of @p a.
|
|
*
|
|
* @return A new vector containing the result.
|
|
* @return An empty vector if the operation fails.
|
|
*
|
|
* @note This overload is convenient, but may allocate a new vector.
|
|
*/
|
|
template <typename T>
|
|
panic::tensor::vector<T> div(const panic::tensor::vector<T>& a, const T k);
|
|
|
|
|
|
/**
|
|
* @brief Divide a vector elementwise too a vector.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* c[i] = a[i] / b[i]
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param a First vector.
|
|
* @param b Second vector. Must have size of @p a
|
|
* @param c Output vector. Resized to match @p a.
|
|
*
|
|
* @return true if @p c was resized and filled successfully.
|
|
* @return false if vector sizes do not match or resizing @p c failed.
|
|
*/
|
|
template <typename T>
|
|
bool div(const panic::tensor::vector<T>& a, const panic::tensor::vector<T>& b, panic::tensor::vector<T>& c);
|
|
|
|
/**
|
|
* @brief Returns a new vector containing a vector diveded elementwise.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* result[i] = a[i] / b[i]
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param a First vector.
|
|
* @param b Second vector. Must have size of @p a
|
|
* @param k Scalar value multiplied to each element of @p a.
|
|
*
|
|
* @return A new vector containing the result.
|
|
* @return An empty vector if the operation fails.
|
|
*
|
|
* @note This overload is convenient, but may allocate a new vector.
|
|
*/
|
|
template <typename T>
|
|
panic::tensor::vector<T> div(const panic::tensor::vector<T>& a, const panic::tensor::vector<T>& b);
|
|
|
|
|
|
|
|
/**
|
|
* @brief Divides a scalar to every element of a matix.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* C(i,j) = A(i,j) / k
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A Input matrix.
|
|
* @param k Scalar value multiplied to each element of @p A.
|
|
* @param C Output Matrix. Resized to match @p A.
|
|
*
|
|
* @return true if @p C was resized and filled successfully.
|
|
* @return false if resizing @p C failed.
|
|
*
|
|
* @note This overload writes the result into an existing vector to avoid
|
|
* unnecessary temporary allocations.
|
|
*/
|
|
template <typename T>
|
|
bool div(const panic::tensor::matrix<T>& A, const T k, panic::tensor::matrix<T>& C);
|
|
|
|
/**
|
|
* @brief Returns a new matrix containing a scalar diveded to every element.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* result(i,j) = A(i,j) / k
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A Input matrix.
|
|
* @param k Scalar value multiplied to each element of @p A.
|
|
*
|
|
* @return A new matrix containing the result.
|
|
* @return An empty matrix if the operation fails.
|
|
*
|
|
* @note This overload is convenient, but may allocate a new vector.
|
|
*/
|
|
template <typename T>
|
|
panic::tensor::matrix<T> div(const panic::tensor::matrix<T>& A, const T k);
|
|
|
|
/**
|
|
* @brief Divides a matrix elementwise too a matrix.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* C(i,j) = A(i,j) / B(i,j)
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A First matrix.
|
|
* @param B Second matrix. Must have size of @p A.
|
|
* @param C Output matrix. Resized to match @p A.
|
|
*
|
|
* @return true if @p C was resized and filled successfully.
|
|
* @return false if vector sizes do not match or resizing @p c failed.
|
|
*/
|
|
template <typename T>
|
|
bool div(const panic::tensor::matrix<T>& A, const panic::tensor::matrix<T>& B, panic::tensor::matrix<T>& C);
|
|
|
|
/**
|
|
* @brief Returns a new matrix containing a matrix divided elementwise.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* result(i,j) = A(i,j) / B(i,j)
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A Input matrix.
|
|
* @param B Second matrix. Must have size of @p A.
|
|
*
|
|
* @return A new matrix containing the result.
|
|
* @return An empty matrix if the operation fails.
|
|
*
|
|
* @note This overload is convenient, but may allocate a new vector.
|
|
*/
|
|
template <typename T>
|
|
panic::tensor::matrix<T> div(const panic::tensor::matrix<T>& A, const panic::tensor::matrix<T>& B);
|
|
|
|
|
|
/**
|
|
* @brief Divides a vector rowwise too a matrix.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* C(i,j) = A(i,j) / b[j]
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A Matrix.
|
|
* @param b Vector. Must have size of @p A.cols().
|
|
* @param C Output matrix. Resized to match @p A.
|
|
*
|
|
* @return true if @p C was resized and filled successfully.
|
|
* @return false if vector sizes do not match or resizing @p c failed.
|
|
*/
|
|
template <typename T>
|
|
bool div_rowwise(const panic::tensor::matrix<T>& A, const panic::tensor::vector<T>& b, panic::tensor::matrix<T>& C);
|
|
|
|
/**
|
|
* @brief Divides a vector rowwise too a matrix.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* result(i,j) = A(i,j) / b[j]
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A Matrix.
|
|
* @param b Vector. Must have size of @p A.cols().
|
|
*
|
|
* @return A new matrix containing the result.
|
|
* @return An empty matrix if the operation fails.
|
|
*
|
|
* @note This overload is convenient, but may allocate a new vector.
|
|
*/
|
|
template <typename T>
|
|
panic::tensor::matrix<T> div_rowwise(const panic::tensor::matrix<T>& A, const panic::tensor::vector<T>& b);
|
|
|
|
/**
|
|
* @brief Divides a vector colwise too a matrix.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* C(i,j) = A(i,j) / b[i]
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A Matrix.
|
|
* @param b Vector. Must have size of @p A.rows().
|
|
* @param C Output matrix. Resized to match @p A.
|
|
*
|
|
* @return true if @p C was resized and filled successfully.
|
|
* @return false if vector sizes do not match or resizing @p c failed.
|
|
*/
|
|
template <typename T>
|
|
bool div_colwise(const panic::tensor::matrix<T>& A, const panic::tensor::vector<T>& b, panic::tensor::matrix<T>& C);
|
|
|
|
/**
|
|
* @brief Divides a vector colwise too a matrix.
|
|
*
|
|
* Computes:
|
|
* @code
|
|
* result(i,j) = A(i,j) / b[i]
|
|
* @endcode
|
|
*
|
|
* @tparam T Numeric element type.
|
|
* @param A Matrix.
|
|
* @param b Vector. Must have size of @p A.rows().
|
|
*
|
|
* @return A new matrix containing the result.
|
|
* @return An empty matrix if the operation fails.
|
|
*
|
|
* @note This overload is convenient, but may allocate a new vector.
|
|
*/
|
|
template <typename T>
|
|
panic::tensor::matrix<T> div_colwise(const panic::tensor::matrix<T>& A, const panic::tensor::vector<T>& b);
|
|
|
|
|
|
|
|
|
|
} // namespace math
|
|
} // namespace panic
|