Add support for matrices (#58)

This PR fixes issues #56 and #57.

- Added support for 2D matrices
    - Supported operations:
        - Addition
        - Subtraction
        - Multiplication (both scalar and matrix)
        - Inverse
        - Power (with positive integers only)
        - Submatrix
        - Join matrices on the left or right
        - Transpose
    - Supported generation methods
        - Zeros (`Matrix::zeros`)
        - Ones (`Matrix::ones`)
        - Diagonal (`Matrix::diag`)
- Changed numerous handling mechanisms
- ARM platforms now are officially supported, including Windows on ARM
and ARM Linux.
- Added more functions to the Python API.

<summary>

**Changelog**

<details>

- **Fix accuracy issues for `exp`.**
- **Fix build errors**
- **Add `#include` for `<cstdint>`**
- **Upgrade Windows version**
  
  Signed-off-by: Andy Zhang <[email protected]>#
  Using Python to show GUI
- **Trying to fix build issue on Windows**
- **Fixed Windows build issues**
- **Added support for 2D matrices**
  - Removed imgui directory for switching to Python tkinter.
  - Add matrix support `mat2d.hpp`
- [BREAKING] `Number` objects now round to 10 decimal places by default.
  - [BREAKING] Steppable public headers are now in `include/steppable`.
- **Small fixes to improve accuracy of `ref` result.**
  - Automatically rounds off numbers in matrix after `ref` operation.
- `roundOff` now supports simplifying the zero polarity to always ensure
positive zero.
  - Fix build issues.
- **Fix rounding issues**
- **Allow building on ARM**
- **Improve precision of `Number` operations.**
- [BREAKING] `Number` does not support implicit conversions from now on.
- **Fixed build issues with Nanobind.**
- Added back `const` qualifier to Number::operator/ and
Number::operator*.
- **Cleaned up configuration files**
- **Enable special build hacks to be specified.**
- Changed localization behavior: when no translations are found,
defaults to en-US
  - Allow value inspections to be specified
  - Change rounding behavior to pad numbers automatically
- **Fixed bugs in multiply**
  - [#56] Fix `isPowerOfTen` detection flaw
  - [WIP] Trying to address matrix rref issues.
- **Fixed bugs in multiply**
  - [#57] Fix `isPowerOfTen` handling flaw
- **Fixed rounding errors**
  - Address segmentation fault in util.cpp by adding empty checks
  - Fix incorrect rounding of negative decimals (like -2.99) to -1
- **Reformat**
- **Add matrix symbols and pretty-printing using better symbols**
- **Added unary operator support to `Number` and `Fraction`**
  
- Unary operators are now supported for `Number` and `Fraction`. One can
now use `+number` and `-number` to get the
  positive / negative instances of the number.
  - Python bindings now include the unary operators.
- `*.pyi` files have been updated to include signatures of unary
operators.
  - `Matrix` objects now support addition.
- **Add operators for matrices**
  
  - Add `operator-`, `operator*`, `operator==` to `Matrix`
  - Add mat2d test targets
- Add concepts to diffrentiate different types of objects (std::string,
.present() methods and numeric)
- Add support for assertIsEqual and assertIsNotEqual for other types of
data
- **Moved out bindings to separate modules**
  
  - Added bindings for `Matrix` to Python
- Added support for implicit conversion between Python numerals and
Steppable `Number`
- Fix build errors by renaming `assert` to `_assertCondition` method in
testing.cpp
- **Add determinant for matrices**
  
  - Add the `det` function.
- [BREAKING] `ref` now refer to the `rref` function. The `ref` function
now does row echelon form without reduction.
  - Add the bindings for `det` and `ref` to Python.
- **Allow matrix joining laterally.**
  
  - Matrices can now be joined using the `<<` and `>>` operators
  - [BREAKING] Matrix indices are now standardized to be (row, column)
- **Add `rank` method for matrix.**
  
  - Add `rank` method to `Matrix`
  - Add corresponding bindings
  - Add support for iterating through the matrix, in C++ and Python
  - Changed order of Matrix::zeros arguments
  - Add literal `_n` to specify a number
- **Allow matrix powers**
  
  - Allow matrix powers
  - Allow matrix inverse by specifying -1 as power.
- **Fix build errors**
  - Add parameters to Python
  - Add `diag` method to Python bindings.
- **Add documentation to Python binding stubs**
- [BREAKING] Change stub file names to underscores to prevent accessing
  - Add documentation
  - Corrected typing annotations in stubs
- **Add copyright headers**
  - Not requiring too many GIthub Actions for pull requests
- **Fixed build errors**
  
  - Fixed return type of Matrix::diag.

</details>
</summary>

Author: ZCG-coder

.github/workflows/benchmark.yml

@@ -6,9 +6,6 @@ on:
     push:
         branches: ["develop"]
 
-    pull_request:
-        branches: ["main"]
-
     workflow_dispatch:
 
 jobs:

.github/workflows/cmake-multi-platform.yml

@@ -10,9 +10,6 @@ on:
             - "**.hpp"
             - "**.py"
             - "**.yml"
-
-    pull_request:
-        branches: ["main"]
 jobs:
     build:
         runs-on: ${{ matrix.os }}
@@ -26,22 +23,27 @@ jobs:
             #
             # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list.
             matrix:
-                os: [ubuntu-latest, windows-2019, macos-13, macos-14, macos-15]
-                build_type: [Release]
+                os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, windows-11-arm, macos-13, macos-14, macos-15]
+                build_type: [Debug, Release]
                 c_compiler: [clang, cl]
                 python_version: ['3.11', '3.12', '3.13']
                 include:
-                    - os: windows-2019
+                    - os: windows-latest
+                      c_compiler: cl
+                      cpp_compiler: cl
+                      cmake_extra_options: ''
+                    - os: windows-11-arm
                       c_compiler: cl
                       cpp_compiler: cl
                       cmake_extra_options: ''
                     - os: ubuntu-latest
                       c_compiler: clang
                       cpp_compiler: clang++
                       cmake_extra_options: '-GNinja'
-                    # - os: macos-latest
-                    #   c_compiler: gcc
-                    #   cpp_compiler: g++
+                    - os: ubuntu-24.04-arm
+                      c_compiler: clang
+                      cpp_compiler: clang++
+                      cmake_extra_options: ''
                     - os: macos-13
                       c_compiler: clang
                       cpp_compiler: clang++
@@ -55,10 +57,14 @@ jobs:
                       cpp_compiler: clang++
                       cmake_extra_options: '-GNinja'
                 exclude:
-                    - os: windows-2019
+                    - os: windows-latest
+                      c_compiler: clang
+                    - os: windows-11-arm
                       c_compiler: clang
                     - os: ubuntu-latest
                       c_compiler: cl
+                    - os: ubuntu-24.04-arm
+                      c_compiler: cl
                     - os: macos-13
                       c_compiler: cl
                     - os: macos-14
@@ -79,17 +85,6 @@ jobs:
                 echo "CMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}" >> "$GITHUB_ENV"
                 echo "CMAKE_OPTIONS=${{ matrix.cmake_extra_options }}" >> "$GITHUB_ENV"
 
-            - name: Set up Homebrew
-              if: ${{ matrix.os == 'macos-13' || matrix.os == 'macos-14' || matrix.os == 'macos-15' || matrix.os == 'ubuntu-latest'}}
-              id: set-up-homebrew
-              uses: Homebrew/actions/setup-homebrew@master
-
-            - name: Install LLVM
-              if: ${{ matrix.os == 'macos-13' || matrix.os == 'macos-14' || matrix.os == 'macos-15' || matrix.os == 'ubuntu-latest' }}
-              run: |
-                brew install llvm ninja
-                echo "PATH=$(brew --prefix llvm)/bin:$PATH" >> "$GITHUB_ENV"
-
             - name: Set up Python
               uses: actions/setup-python@v5
               with:
@@ -108,6 +103,6 @@ jobs:
               uses: actions/[email protected]
               with:
                 # Artifact name
-                name: PyBuild ${{ matrix.os }}-cp${{ matrix.python_version }}
+                name: steppable-${{ matrix.os }}-cp${{ matrix.python_version }}-${{ matrix.build_type }}
                 # A file, directory or wildcard pattern that describes what to upload
                 path: ${{ steps.strings.outputs.py-build-output-dir }}

.idea/.name

@@ -1,10 +1,35 @@
 {
   "configurations": [
+    {
+      "name": "Matrix::rref",
+      "type": "cppdbg",
+      "request": "launch",
+      "program": "${workspaceFolder}/build/src/matrix_ref",
+      "args": [],
+      "cwd": "${workspaceFolder}",
+      "environment": [],
+      "externalConsole": true,
+      "MIMode": "lldb",
+      "internalConsoleOptions": "openOnSessionStart",
+      "preLaunchTask": "CMake: build",
+      "setupCommands": [
+        {
+          "description": "Enable pretty-printing for gdb",
+          "text": "-enable-pretty-printing",
+          "ignoreFailures": true
+        },
+        {
+          "description": "Set Disassembly Flavor to Intel",
+          "text": "-gdb-set disassembly-flavor intel",
+          "ignoreFailures": true
+        }
+      ]
+    },
     {
       "name": "Division",
       "type": "cppdbg",
       "request": "launch",
-      "program": "${workspaceFolder}/build/src/division",
+      "program": "${workspaceFolder}/build/src/calc_division",
       "args": [
         "1",
         "2"
@@ -14,6 +39,7 @@
       "environment": [],
       "externalConsole": false,
       "MIMode": "lldb",
+      "internalConsoleOptions": "openOnSessionStart",
       "setupCommands": [
         {
           "description": "Enable pretty-printing for gdb",
@@ -31,13 +57,14 @@
       "name": "Add",
       "type": "cppdbg",
       "request": "launch",
-      "program": "${workspaceFolder}/build/src/add",
+      "program": "${workspaceFolder}/build/src/calc_add",
       "args": [
         "-5",
         "6"
       ],
       "cwd": "${workspaceFolder}/build",
       "preLaunchTask": "CMake: build",
+      "internalConsoleOptions": "openOnSessionStart",
       "setupCommands": [
         {
           "description": "Enable pretty-printing for gdb",
@@ -50,14 +77,15 @@
       "type": "cppdbg",
       "request": "launch",
       "name": "Multiply",
-      "program": "${workspaceFolder}/build/src/multiply",
+      "program": "${workspaceFolder}/build/src/calc_multiply",
       "args": [
         "56",
         "76",
         "+profile"
       ],
       "cwd": "${workspaceFolder}",
-      "preLaunchTask": "CMake: build"
+      "preLaunchTask": "CMake: build",
+      "internalConsoleOptions": "openOnSessionStart",
     }
   ]
 }

.idea/Steppable.iml

@@ -20,6 +20,8 @@
 #  SOFTWARE.                                                                                        #
 #####################################################################################################
 
+INCLUDE(cmake/build_special_hacks.cmake)
+
 CMAKE_MINIMUM_REQUIRED(VERSION 3.20)
 PROJECT(Steppable)
 
@@ -109,11 +111,11 @@ SET(COMPONENTS
     calc::root
     calc::subtract
     calc::trig
-)
+    matrix::ref)
 # NEW_COMPONENT: PATCH Do NOT remove the previous comment.
 
 SET(TARGETS ${COMPONENTS} util)
-SET(TEST_TARGETS_TEMP util fraction number factors format ${COMPONENTS})
+SET(TEST_TARGETS_TEMP util fraction number mat2d factors format ${COMPONENTS})
 
 FOREACH(TEST_TARGET IN LISTS TEST_TARGETS_TEMP)
     SET(TARGET_NAME "test")
@@ -131,7 +133,6 @@ ENDFOREACH()
 ADD_SUBDIRECTORY(src/)
 ADD_SUBDIRECTORY(lib/)
 ADD_SUBDIRECTORY(tests/)
-ADD_SUBDIRECTORY(gui/)
 ADD_SUBDIRECTORY(include/) # The CMakeLists file there adds the include/ directory to everything
 
 FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin)

.idea/dictionaries/project.xml

@@ -0,0 +1,11 @@
+IF(STP_DEB_CALC_DIVISION_RESULT_INSPECT)
+    ADD_COMPILE_DEFINITIONS(STP_DEB_CALC_DIVISION_RESULT_INSPECT)
+ENDIF()
+
+IF(STP_DEB_CALC_MULTIPLY_RESULT_INSPECT)
+    ADD_COMPILE_DEFINITIONS(STP_DEB_CALC_MULTIPLY_RESULT_INSPECT)
+ENDIF()
+
+IF(STP_DEB_MATRIX_REF_RESULT_INSPECT)
+    ADD_COMPILE_DEFINITIONS(STP_DEB_MATRIX_REF_RESULT_INSPECT)
+ENDIF()