initial push
This commit is contained in:
@@ -0,0 +1,131 @@
|
||||
/**++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
*
|
||||
* 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: tensor
|
||||
* File Name: vector.hpp
|
||||
* Revision: 0.1.0
|
||||
* Date: 21-06-2026
|
||||
* Author: Michelle Bausager
|
||||
*
|
||||
* Description:
|
||||
* Defines the vector object that will be used in the rest of the libraries.
|
||||
*
|
||||
*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
|
||||
#pragma once
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
// INCLUDE DESCRIPTION
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
#include <config/types.hpp> // panic::uint_t, panic::int_t, and panic::real_t
|
||||
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
// DEFINE DESCRIPTION
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
// TYPE DESCRIPTION
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
// Type Name : panic::tensor::vector
|
||||
//
|
||||
// Description:
|
||||
// Dynamic vector storing panic::real_t values.
|
||||
// The vector owns its memory and releases it in the destructor.
|
||||
//
|
||||
// Member Variables:
|
||||
// length panic::uint_t
|
||||
// Number of elements in the vector.
|
||||
//
|
||||
// data panic::real_t*
|
||||
// Pointer to the allocated vector data.
|
||||
//
|
||||
// Notes:
|
||||
// This vector uses dynamic allocation with new[] and delete[].
|
||||
// Copying performs a deep copy.
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
namespace panic{
|
||||
namespace tensor{
|
||||
|
||||
struct vector{
|
||||
panic::uint_t length;
|
||||
panic::real_t* data;
|
||||
|
||||
// empty contructor
|
||||
vector();
|
||||
|
||||
// contructor with size allocation
|
||||
vector(panic::uint_t size);
|
||||
|
||||
// contructor with size allocation and sets it all to a value
|
||||
vector(panic::uint_t size, panic::real_t value);
|
||||
|
||||
// copy-contructor
|
||||
// vector a(3);
|
||||
// vector b = a;
|
||||
vector(const vector& other);
|
||||
|
||||
// de-contructor, releases memory
|
||||
~vector();
|
||||
|
||||
// copy-assignment
|
||||
//vector a(5);
|
||||
//vector b(3);
|
||||
//b = a;
|
||||
vector& operator=(const vector& other);
|
||||
|
||||
// function returns size.
|
||||
// const tells compiler that the fuction don't edit the objert.
|
||||
panic::uint_t size() const;
|
||||
|
||||
// function to resize data vector (I need a new that don't save the vlaues)
|
||||
bool resize(panic::uint_t new_size);
|
||||
|
||||
// fill data with value
|
||||
bool fill(panic::real_t value);
|
||||
|
||||
// lets you read and write v[index]
|
||||
panic::real_t& operator[](panic::uint_t index);
|
||||
|
||||
// lets you read v[index] from a const vector
|
||||
const panic::real_t& operator[](panic::uint_t index) const;
|
||||
|
||||
// lets you read and write v.at(index)
|
||||
panic::real_t& at(panic::uint_t index);
|
||||
|
||||
// lets you read v.at(index) from a const vector
|
||||
const panic::real_t& at(panic::uint_t index) const;
|
||||
|
||||
};
|
||||
|
||||
} // namespace tensor
|
||||
} // namespace panic
|
||||
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
// VARIABLE DESCRIPTION
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
// FUNCTION PROTOTYPE
|
||||
//---------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user