122 lines
4.2 KiB
C++
122 lines
4.2 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: <module-name>
|
|
* File Name: <file-name>
|
|
* Revision: 0.1.0
|
|
* Date: <yyyy-mm-dd>
|
|
* Author: Michelle Bausager
|
|
*
|
|
* Description:
|
|
* <short description of what this file/module does>
|
|
*
|
|
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
|
|
// includes like:
|
|
// #include <stdint.h>
|
|
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
// DEFINE DESCRIPTION
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
// difinitions like:
|
|
// #define TEST_FALG 1
|
|
|
|
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
// VARIABLE DESCRIPTION
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
// Variable difinition like:
|
|
// static uint32_t AmountOfCool = 0;
|
|
|
|
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
// FUNCTION PROTOTYPE
|
|
//---------------------------------------------------------------------------------------------------------------------------
|
|
// Function prototypes like:
|
|
// static void TestLeds(void);
|
|
|
|
|
|
|
|
// Function distription like:
|
|
//--------------------------------------------------------------------------------------------------------------------------
|
|
// Function Name : panic::math::matmul_serial
|
|
// Revision : 0.1.0
|
|
// Date : 2026-06-19
|
|
//
|
|
// Description:
|
|
// Performs serial matrix multiplication:
|
|
//
|
|
// out = a * b
|
|
//
|
|
// Inputs:
|
|
// a const panic::Matrix&
|
|
// Left-hand input matrix.
|
|
//
|
|
// b const panic::Matrix&
|
|
// Right-hand input matrix.
|
|
//
|
|
// Outputs:
|
|
// out panic::Matrix&
|
|
// Output matrix. Must be allocated before calling this function.
|
|
// The function writes the result into this matrix.
|
|
//
|
|
// Returns:
|
|
// panic::Status
|
|
// panic::Status::Ok Matrix multiplication completed successfully.
|
|
// panic::Status::SizeError Matrix dimensions are incompatible.
|
|
// panic::Status::NullError One or more internal data pointers are null.
|
|
//
|
|
// Notes:
|
|
// This function does not allocate memory.
|
|
// The output matrix must have dimensions
|
|
//--------------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
// or
|
|
|
|
|
|
//--------------------------------------------------------------------------------------------------------------------------
|
|
// Function Name : panic::math::sqrt
|
|
// Revision : 0.1.0
|
|
// Date : 2026-06-19
|
|
//
|
|
// Description:
|
|
// Computes an approximation of the square root of a scalar value.
|
|
//
|
|
// Inputs:
|
|
// x panic::float_t
|
|
// Input value.
|
|
//
|
|
// Outputs:
|
|
// None.
|
|
//
|
|
// Returns:
|
|
// panic::float_t
|
|
// Approximate square root of x.
|
|
//
|
|
// Notes:
|
|
// This implementation is written from scratch and is intended to be readable
|
|
// and portable rather than maximally optimized.
|
|
//--------------------------------------------------------------------------------------------------------------------------
|
|
|
|
|