matrix-engine 1.1.0__tar.gz

matrix_engine-1.1.0/.vscode/c_cpp_properties.json

@@ -0,0 +1,15 @@
+{
+    "configurations": [
+        {
+            "name": "Win32",
+            "includePath": [
+                "${workspaceFolder}/include",
+                "${workspaceFolder}/**"
+            ],
+            "compilerPath": "cl.exe",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "windows-msvc-x64"
+        }
+    ],
+    "version": 4
+}

matrix_engine-1.1.0/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run vector_demo",
+            "type": "cppvsdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/Debug/vector_demo.exe",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}",
+            "environment": [],
+            "console": "integratedTerminal",
+            "preLaunchTask": "Build vector_demo"
+        }
+    ]
+}

matrix_engine-1.1.0/.vscode/tasks.json

@@ -0,0 +1,19 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build vector_demo",
+            "type": "shell",
+            "command": "cmake",
+            "args": [
+                "--build",
+                "${workspaceFolder}/build"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}

matrix_engine-1.1.0/CMakeLists.txt

@@ -0,0 +1,77 @@
+cmake_minimum_required(VERSION 3.16)
+
+project(cpp_math LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+enable_testing()
+
+set(PYBIND11_FINDPYTHON ON)
+find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
+find_package(pybind11 REQUIRED)
+
+# Header-only C++ library
+add_library(cpp_math INTERFACE)
+
+target_include_directories(cpp_math
+    INTERFACE
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+)
+
+# Python extension module
+pybind11_add_module(_matrix_engine
+    python/bindings.cpp
+)
+
+target_link_libraries(_matrix_engine
+    PRIVATE
+        cpp_math
+)
+
+target_include_directories(_matrix_engine
+    PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+)
+
+# Demo executable
+add_executable(vector_demo
+    examples/vector_demo.cpp
+)
+
+target_link_libraries(vector_demo
+    PRIVATE
+        cpp_math
+)
+
+function(add_cpp_math_test name source)
+    add_executable(${name} ${source})
+    target_link_libraries(${name}
+        PRIVATE
+            cpp_math
+    )
+    add_test(NAME ${name} COMMAND ${name})
+endfunction()
+
+add_cpp_math_test(test_vector_basics tests/cpp/test_vector_basics.cpp)
+add_cpp_math_test(test_vector_logic tests/cpp/test_vector_logic.cpp)
+add_cpp_math_test(test_matrix_basics tests/cpp/test_matrix_basics.cpp)
+add_cpp_math_test(test_matrix_linalg tests/cpp/test_matrix_linalg.cpp)
+add_cpp_math_test(test_matrix_logic tests/cpp/test_matrix_logic.cpp)
+add_cpp_math_test(test_validation tests/cpp/test_validation.cpp)
+add_cpp_math_test(test_templates tests/cpp/test_templates.cpp)
+
+# Put the compiled .pyd next to your Python package
+set_target_properties(_matrix_engine PROPERTIES
+    LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/matrix_engine
+    LIBRARY_OUTPUT_DIRECTORY_DEBUG ${CMAKE_CURRENT_SOURCE_DIR}/matrix_engine
+    LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_CURRENT_SOURCE_DIR}/matrix_engine
+    RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/matrix_engine
+    RUNTIME_OUTPUT_DIRECTORY_DEBUG ${CMAKE_CURRENT_SOURCE_DIR}/matrix_engine
+    RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_CURRENT_SOURCE_DIR}/matrix_engine
+)
+
+# Optional install command
+install(TARGETS _matrix_engine
+    LIBRARY DESTINATION matrix_engine
+    RUNTIME DESTINATION matrix_engine
+)

matrix_engine-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Noah Ryan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

matrix_engine-1.1.0/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.2
+Name: matrix_engine
+Version: 1.1.0
+Summary: C++ matrix and vector engine with pybind11 bindings
+Author: Noah Ryan
+License: MIT License
+         
+         Copyright (c) 2026 Noah Ryan
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+         
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: Repository, https://github.com/njryan-boou/Scientific-data-processing-backend-built-with-FastAPI
+Project-URL: Issues, https://github.com/njryan-boou/Scientific-data-processing-backend-built-with-FastAPI/issues
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# Matrix Engine
+
+Header-only C++ vector and matrix templates with Python bindings built through
+pybind11.
+
+## Features
+
+- Header-only C++ templates: `VectorT<T>` and `MatrixT<T>`
+- Python API using double-based aliases: `Vector` and `Matrix`
+- Vector arithmetic, dot product, magnitude, normalization, and 3D cross product
+- Matrix arithmetic, transpose, matrix multiplication, matrix-vector multiplication, and determinant for 2x2 and 3x3 matrices
+- Elementwise comparison and logical mask operators
+- Row iteration for matrices in Python
+- Custom validation helpers and exception types exposed to Python
+- C++ tests through CTest and Python tests through `unittest`
+
+## Layout
+
+```text
+cpp_math/
+  include/              C++ headers
+  matrix_engine/        Python package files and built extension output
+  python/               pybind11 bindings
+  tests/cpp/            C++ tests
+  tests/python/         Python tests
+  examples/             C++ examples
+```
+
+## C++ Usage
+
+```cpp
+#include "Matrix.hpp"
+#include "Vector.hpp"
+
+#include <iostream>
+
+int main()
+{
+    Vector v({1.0, 2.0, 3.0});
+    Vector w({4.0, 5.0, 6.0});
+
+    std::cout << v.dot(w) << "\n";
+
+    Matrix A({{1.0, 2.0}, {3.0, 4.0}});
+    Matrix B({{5.0, 6.0}, {7.0, 8.0}});
+
+    std::cout << A.matmul(B);
+}
+```
+
+The default aliases use `double`:
+
+```cpp
+using Vector = VectorT<double>;
+using Matrix = MatrixT<double>;
+```
+
+You can also use other numeric types:
+
+```cpp
+VectorT<float> vf({1.0f, 2.0f});
+MatrixT<int> mi({{1, 2}, {3, 4}});
+```
+
+## Python Usage
+
+```python
+import matrix_engine as me
+
+v = me.Vector([1.0, 2.0, 3.0])
+w = me.Vector([4.0, 5.0, 6.0])
+
+print(v @ w)          # dot product
+print(v + w)          # elementwise addition
+print(v < w)          # elementwise mask: 1.0 for true, 0.0 for false
+
+A = me.Matrix([[1.0, 2.0], [3.0, 4.0]])
+B = me.Matrix([[5.0, 6.0], [7.0, 8.0]])
+
+print(A @ B)          # matrix multiplication
+print(A.determinant())
+
+for row in A:
+    print(row)        # rows are Vector instances
+```
+
+## Validation And Exceptions
+
+The Python API exposes custom exception classes:
+
+```python
+import matrix_engine as me
+
+try:
+    me.Matrix([[1.0, 2.0, 3.0]]).determinant()
+except me.ShapeError as exc:
+    print(exc)
+```
+
+Available exception types:
+
+- `LinalgError`
+- `ShapeError`
+- `DimensionError`
+- `IndexError`
+- `EmptyMatrixError`
+- `ValueError`
+
+Validation helpers are available under `me.validation`:
+
+```python
+me.validation.square(matrix)
+me.validation.same_shape(lhs, rhs)
+me.validation.multiplication(lhs, rhs)
+```
+
+Most operations call validation internally, so users usually do not need to call
+these helpers directly.
+
+## Build
+
+From the repository root:
+
+```powershell
+cmake -S cpp_math -B cpp_math/build
+cmake --build cpp_math/build
+```
+
+From inside `cpp_math`:
+
+```powershell
+cmake -S . -B build
+cmake --build build
+```
+
+The extension module is built into:
+
+```text
+cpp_math/matrix_engine/
+```
+
+## Install For Python Development
+
+From inside `cpp_math`:
+
+```powershell
+pip install -e .
+```
+
+If you are working from the repository root without installing, add `cpp_math`
+to `PYTHONPATH` or insert it into `sys.path`:
+
+```python
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd() / "cpp_math"))
+```
+
+## Tests
+
+Build first:
+
+```powershell
+cmake --build cpp_math/build
+```
+
+Run C++ tests:
+
+```powershell
+ctest --test-dir cpp_math/build -C Debug --output-on-failure
+```
+
+Run Python tests:
+
+```powershell
+python cpp_math/tests/python/run_tests.py
+```
+
+The GitHub Actions workflow in `.github/workflows/tests.yml` runs both the C++
+and Python test suites.
+
+## Current Limitations
+
+These methods are declared but not implemented yet:
+
+- `Matrix.inverse()`
+- `Matrix.adjugate()`
+- `Matrix.rref()`
+- `Matrix.rank()`
+- `Vector.solve()`
+
+They validate inputs where appropriate and then raise `ValueError`.
+
+## License
+
+MIT. See `LICENSE`.

matrix_engine-1.1.0/README.md

@@ -0,0 +1,197 @@
+# Matrix Engine
+
+Header-only C++ vector and matrix templates with Python bindings built through
+pybind11.
+
+## Features
+
+- Header-only C++ templates: `VectorT<T>` and `MatrixT<T>`
+- Python API using double-based aliases: `Vector` and `Matrix`
+- Vector arithmetic, dot product, magnitude, normalization, and 3D cross product
+- Matrix arithmetic, transpose, matrix multiplication, matrix-vector multiplication, and determinant for 2x2 and 3x3 matrices
+- Elementwise comparison and logical mask operators
+- Row iteration for matrices in Python
+- Custom validation helpers and exception types exposed to Python
+- C++ tests through CTest and Python tests through `unittest`
+
+## Layout
+
+```text
+cpp_math/
+  include/              C++ headers
+  matrix_engine/        Python package files and built extension output
+  python/               pybind11 bindings
+  tests/cpp/            C++ tests
+  tests/python/         Python tests
+  examples/             C++ examples
+```
+
+## C++ Usage
+
+```cpp
+#include "Matrix.hpp"
+#include "Vector.hpp"
+
+#include <iostream>
+
+int main()
+{
+    Vector v({1.0, 2.0, 3.0});
+    Vector w({4.0, 5.0, 6.0});
+
+    std::cout << v.dot(w) << "\n";
+
+    Matrix A({{1.0, 2.0}, {3.0, 4.0}});
+    Matrix B({{5.0, 6.0}, {7.0, 8.0}});
+
+    std::cout << A.matmul(B);
+}
+```
+
+The default aliases use `double`:
+
+```cpp
+using Vector = VectorT<double>;
+using Matrix = MatrixT<double>;
+```
+
+You can also use other numeric types:
+
+```cpp
+VectorT<float> vf({1.0f, 2.0f});
+MatrixT<int> mi({{1, 2}, {3, 4}});
+```
+
+## Python Usage
+
+```python
+import matrix_engine as me
+
+v = me.Vector([1.0, 2.0, 3.0])
+w = me.Vector([4.0, 5.0, 6.0])
+
+print(v @ w)          # dot product
+print(v + w)          # elementwise addition
+print(v < w)          # elementwise mask: 1.0 for true, 0.0 for false
+
+A = me.Matrix([[1.0, 2.0], [3.0, 4.0]])
+B = me.Matrix([[5.0, 6.0], [7.0, 8.0]])
+
+print(A @ B)          # matrix multiplication
+print(A.determinant())
+
+for row in A:
+    print(row)        # rows are Vector instances
+```
+
+## Validation And Exceptions
+
+The Python API exposes custom exception classes:
+
+```python
+import matrix_engine as me
+
+try:
+    me.Matrix([[1.0, 2.0, 3.0]]).determinant()
+except me.ShapeError as exc:
+    print(exc)
+```
+
+Available exception types:
+
+- `LinalgError`
+- `ShapeError`
+- `DimensionError`
+- `IndexError`
+- `EmptyMatrixError`
+- `ValueError`
+
+Validation helpers are available under `me.validation`:
+
+```python
+me.validation.square(matrix)
+me.validation.same_shape(lhs, rhs)
+me.validation.multiplication(lhs, rhs)
+```
+
+Most operations call validation internally, so users usually do not need to call
+these helpers directly.
+
+## Build
+
+From the repository root:
+
+```powershell
+cmake -S cpp_math -B cpp_math/build
+cmake --build cpp_math/build
+```
+
+From inside `cpp_math`:
+
+```powershell
+cmake -S . -B build
+cmake --build build
+```
+
+The extension module is built into:
+
+```text
+cpp_math/matrix_engine/
+```
+
+## Install For Python Development
+
+From inside `cpp_math`:
+
+```powershell
+pip install -e .
+```
+
+If you are working from the repository root without installing, add `cpp_math`
+to `PYTHONPATH` or insert it into `sys.path`:
+
+```python
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd() / "cpp_math"))
+```
+
+## Tests
+
+Build first:
+
+```powershell
+cmake --build cpp_math/build
+```
+
+Run C++ tests:
+
+```powershell
+ctest --test-dir cpp_math/build -C Debug --output-on-failure
+```
+
+Run Python tests:
+
+```powershell
+python cpp_math/tests/python/run_tests.py
+```
+
+The GitHub Actions workflow in `.github/workflows/tests.yml` runs both the C++
+and Python test suites.
+
+## Current Limitations
+
+These methods are declared but not implemented yet:
+
+- `Matrix.inverse()`
+- `Matrix.adjugate()`
+- `Matrix.rref()`
+- `Matrix.rank()`
+- `Vector.solve()`
+
+They validate inputs where appropriate and then raise `ValueError`.
+
+## License
+
+MIT. See `LICENSE`.