Add doc blocks

Author: andrewdalpino

CHANGELOG.md

@@ -1,6 +1,6 @@
 - 2.2.0
     - Implemented Singular Value Decomposition (SVD)
-    - Implemented matrix pseudo (Moore-Penrose) inverse
+    - Implemented matrix (Moore-Penrose) pseudoinverse
     - Tensor objects now throw namespaced exceptions
     - Optimized Reduced Row Echelon Form (RREF)
     - Optimize eigendecomposition for symmetric matrices

ext/include/linear_algebra.c

@@ -7,6 +7,13 @@
 #include <lapacke.h>
 #include "kernel/operators.h"
 
+/**
+ * Matrix-matrix multiplication i.e. linear transformation of matrices A and B.
+ * 
+ * @param return_value
+ * @param a
+ * @param b
+ */
 void tensor_matmul(zval * return_value, zval * a, zval * b)
 {
     unsigned int i, j;
@@ -64,6 +71,13 @@ void tensor_matmul(zval * return_value, zval * a, zval * b)
     efree(vc);
 }
 
+/**
+ * Dot product between vectors A and B.
+ * 
+ * @param return_value
+ * @param a
+ * @param b
+ */
 void tensor_dot(zval * return_value, zval * a, zval * b)
 {
     unsigned int i;
@@ -85,6 +99,12 @@ void tensor_dot(zval * return_value, zval * a, zval * b)
     RETVAL_DOUBLE(sigma);
 }
 
+/**
+ * Return the multiplicative inverse of a square matrix A.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_inverse(zval * return_value, zval * a)
 {
     unsigned int i, j;
@@ -140,6 +160,12 @@ void tensor_inverse(zval * return_value, zval * a)
     efree(pivots);
 }
 
+/**
+ * Return the (Moore-Penrose) pseudoinverse of a general matrix A.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_pseudoinverse(zval * return_value, zval * a)
 {
     unsigned int i, j;
@@ -201,6 +227,12 @@ void tensor_pseudoinverse(zval * return_value, zval * a)
     efree(vb);
 }
 
+/**
+ * Return the row echelon form of matrix A.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_ref(zval * return_value, zval * a)
 {
     unsigned int i, j;
@@ -265,6 +297,12 @@ void tensor_ref(zval * return_value, zval * a)
     efree(pivots);
 }
 
+/**
+ * Compute the Cholesky decomposition of matrix A and return the lower triangular matrix.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_cholesky(zval * return_value, zval * a)
 {
     unsigned int i, j;
@@ -314,6 +352,12 @@ void tensor_cholesky(zval * return_value, zval * a)
     efree(va);
 }
 
+/**
+ * Compute the LU factorization of matrix A and return a tuple with lower, upper, and permutation matrices.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_lu(zval * return_value, zval * a)
 {
     unsigned int i, j;
@@ -404,6 +448,12 @@ void tensor_lu(zval * return_value, zval * a)
     efree(pivots); 
 }
 
+/**
+ * Compute the eigendecomposition of a general matrix A and return the eigenvalues and eigenvectors in a tuple.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_eig(zval * return_value, zval * a)
 {
     unsigned int i, j;
@@ -466,6 +516,12 @@ void tensor_eig(zval * return_value, zval * a)
     efree(vr);
 }
 
+/**
+ * Compute the eigendecomposition of a symmetric matrix A and return the eigenvalues and eigenvectors in a tuple.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_eig_symmetric(zval * return_value, zval * a)
 {
     unsigned int i, j;
@@ -524,6 +580,12 @@ void tensor_eig_symmetric(zval * return_value, zval * a)
     efree(wr);
 }
 
+/**
+ * Compute the singular value decomposition of a matrix A and return the singular values, and unitary matrices U and VT in a tuple.
+ * 
+ * @param return_value
+ * @param a
+ */
 void tensor_svd(zval * return_value, zval * a)
 {
     unsigned int i, j;

ext/include/settings.c

@@ -6,6 +6,12 @@
 #include <cblas.h>
 #include "kernel/operators.h"
 
+/**
+ * Sets the number of threads to use when parallel processesing.
+ * 
+ * @param return_value
+ * @param threads
+ */
 void tensor_set_num_threads(zval * return_value, zval * threads)
 {
     int n = zephir_get_intval(threads);
@@ -15,6 +21,11 @@ void tensor_set_num_threads(zval * return_value, zval * threads)
     RETURN_TRUE;
 }
 
+/**
+ * Return the number of threads to use when parallel processesing.
+ * 
+ * @param return_value
+ */
 void tensor_get_num_threads(zval * return_value)
 {
     long threads = openblas_get_num_threads();

package.xml

@@ -10,7 +10,7 @@
         <email>[email protected]</email>
 		<active>yes</active>
 	</lead>
-	<date>2021-02-20</date>
+	<date>2021-02-28</date>
 	<version>
 		<release>2.2.0</release>
 		<api>2.2.0</api>
@@ -22,8 +22,10 @@
 	<license uri="https://github.com/RubixML/Tensor/blob/master/LICENSE">MIT</license>
     <notes>
         - Implemented Singular Value Decomposition (SVD)
+        - Implemented matrix (Moore-Penrose) pseudoinverse
         - Tensor objects now throw namespaced exceptions
         - Optimized Reduced Row Echelon Form (RREF)
+        - Optimize eigendecomposition for symmetric matrices
     </notes>
 	<contents>
         <dir name="/">