Revamped and documented matrix API as well as added cross-conversion between quaternions and matrices\nALSO added YML and config.ld for using LDoc

Author: TechTastic

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Generate and Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Install Lua and LuaRocks
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y lua5.3 luarocks
+    
+    - name: Install LDoc
+      run: sudo luarocks install ldoc
+    
+    - name: Generate Documentation
+      run: ldoc .
+    
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v2
+      with:
+        path: ./docs
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1 @@
+/docs

config.ld

@@ -0,0 +1,9 @@
+project = 'Advanced Math Library'
+title = 'Advanced Math Documentation'
+description = 'Mathematical APIs for ComputerCraft'
+file = {
+    'datapack/data/advanced_math/rom/apis/',
+    'datapack/data/advanced_math/modules/'
+}
+format = 'markdown'
+dir = 'docs'

datapack/data/advanced_math/help/matrix.txt

@@ -1 +1,40 @@
-WIP
+Functions in the Matrix Math API:
+matrix.new( rows, columns, func )
+matrix.from2DArray( arr )
+matrix.fromVector( vector, row )
+matrix.fromQuaternion( quaternion )
+matrix.identity( rows, columns )
+
+Matrices returned by the above methods have the following fields and methods:
+matrix.rows
+matrix.columns
+matrix:add( matrix or scalar )
+matrix:sub( matrix or scalar )
+matrix:mul( matrix or scalar )
+matrix:div( matrix or scalar )
+matrix:unm()
+matrix:pow( n )
+matrix:tostring()
+matrix:equals( matrix )
+matrix:minor( row, column )
+matrix:determinant()
+matrix:transpose()
+matrix:cofactor()
+matrix:adjugate()
+matrix:inverse()
+matrix:trace()
+matrix:rank()
+matrix:frobenius_norm()
+matrix:max_norm()
+matrix:hadamard_product( matrix )
+matrix:elementwise_div( matrix )
+matrix:is_symmetric()
+matrix:is_diagonal()
+matrix:is_identity()
+matrix:clone()
+matrix:length()
+The +, -, *, /, ^, and # operators can also be used on matrices.
+
+Note: When using a scalar value with add or mul, the operation is applied element-wise to all matrix elements.
+Note: Matrix division by another matrix is performed by multiplying by the inverse.
+Note: The pow operator requires a square matrix and a non-negative integer exponent.

datapack/data/advanced_math/help/quaternion.txt

@@ -3,9 +3,12 @@ quaternion.new( vector, w )
 quaternion.fromAxisAngle( axis, angle )
 quaternion.fromEuler( pitch, yaw, roll )
 quaternion.fromComponents( x, y, z, w )
-quaternion.fromShip()
+quaternion.fromMatrix()
 quaternion.identity()
 
+Deprecated Functions:
+quaternion.fromShip()
+
 Quaternions returned by the above methods have the following fields and methods:
 quaternion.v
 quaternion.a

datapack/data/advanced_math/modules/pid.lua

@@ -1,6 +1,16 @@
 local expect = require "cc.expect"
 local expect = expect.expect
 
+--- A basic PID type and common PID operations. This may be useful
+-- when working with control systems.
+--
+-- An introduction to PIDs can be found on [Wikipedia][wiki].
+--
+-- [wiki]: https://en.wikipedia.org/wiki/Proportional-integral-derivative_controller
+--
+-- @module pid
+-- @since 0.0.0
+
 --- Performs a PID control step if the setpoint is a scalar (number) value
 --
 -- @tparam pid self The PID instance
@@ -132,6 +142,10 @@ local function quaternionStep(self, value, dt)
     return output
 end
 
+--- A PID, with a scalar, vector, or quaternion setpoint, kP, kI, and kD, both as discrete and continuous.
+--
+--
+-- @type Matrix
 local pid = {
     --- Enables/disables the clamping of the output value
     --