Add global settings class

andrewdalpino · andrewdalpino · commit 7719c80fb8be · 2021-02-13T21:03:58.000-06:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![PHP from Packagist](https://img.shields.io/packagist/php-v/rubix/tensor.svg?style=flat&colorB=8892BF)](https://www.php.net/) [![Latest Stable Version](https://img.shields.io/packagist/v/rubix/tensor.svg?style=flat&colorB=orange)](https://packagist.org/packages/rubix/tensor) [![Build](https://github.com/RubixML/Tensor/workflows/Build/badge.svg)](https://github.com/RubixML/Tensor/actions) [![Downloads from Packagist](https://img.shields.io/packagist/dt/rubix/tensor.svg?style=flat&colorB=red)](https://packagist.org/packages/rubix/tensor) [![GitHub](https://img.shields.io/github/license/RubixML/Tensor)](https://github.com/RubixML/Tensor/blob/master/LICENSE.md)
 
-Tensor is a library and extension that provides objects for scientific computing in [PHP](https://php.net). It is used by libraries such as [Rubix ML](https://rubixml.com) to build and accelerate machine learning algorithms such as neural networks.
+Tensor is a library and extension that provides objects for scientific computing in [PHP](https://php.net). The multithreaded extension is especially suited for applications where efficient computing of large sets of numbers is required. In some cases, the extension is 340X faster than the same operation in PHPland. Tensor is used by libraries such as [Rubix ML](https://rubixml.com) to build and accelerate machine learning algorithms such as neural networks and linear regressions.
 
 ## Installation
 Install Tensor into your project with [Composer](https://getcomposer.org/):
@@ -61,7 +61,9 @@ php -m | grep tensor
 
 ## Performance Comparison
 
-![Tensor Performance](https://raw.githubusercontent.com/RubixML/Tensor/master/docs/images/tensor-performance-mnist.png)
+![Tensor Performance MNIST](https://raw.githubusercontent.com/RubixML/Tensor/master/docs/images/tensor-performance-mnist.png)
+
+![Tensor Performance Benchmarks](https://raw.githubusercontent.com/RubixML/Tensor/master/docs/images/tensor-performance-benchmarks.png)
 
 ## Funding
 Rubix ML is funded by donations from the community. You can become a sponsor by making a contribution to one of our funding sources below.
diff --git a/benchmarks/LinearAlgebra/MatmulBench.php b/benchmarks/LinearAlgebra/MatmulBench.php
@@ -22,15 +22,15 @@ class MatmulBench
 
     public function setUp() : void
     {
-        $this->a = Matrix::uniform(1000, 1000);
+        $this->a = Matrix::uniform(500, 500);
 
-        $this->b = Matrix::uniform(1000, 1000);
+        $this->b = Matrix::uniform(500, 500);
     }
 
     /**
      * @Subject
      * @Iterations(5)
-     * @OutputTimeUnit("milliseconds", precision=3)
+     * @OutputTimeUnit("seconds", precision=3)
      */
     public function matmul() : void
     {
diff --git a/benchmarks/LinearAlgebra/VectorDotProductBench.php b/benchmarks/LinearAlgebra/VectorDotProductBench.php
@@ -22,15 +22,15 @@ class VectorDotProductBench
 
     public function setUp() : void
     {
-        $this->a = Vector::uniform(100000);
+        $this->a = Vector::uniform(10000000);
 
-        $this->b = Vector::uniform(100000);
+        $this->b = Vector::uniform(10000000);
     }
 
     /**
      * @Subject
      * @Iterations(5)
-     * @OutputTimeUnit("milliseconds", precision=3)
+     * @OutputTimeUnit("seconds", precision=3)
      */
     public function dot() : void
     {
diff --git a/config.json b/config.json
@@ -13,7 +13,7 @@
         "include/comparison.c",
         "include/linear_algebra.c"
     ],
-    "extra-libs": "-lopenblas -llapacke -lgfortran",
+    "extra-libs": "-lopenblas -llapacke -lgfortran -lpthread",
     "globals": {
         "num_threads": {
             "type": "int",
diff --git a/docs/images/tensor-performance-benchmarks.png b/docs/images/tensor-performance-benchmarks.png
diff --git a/ext/config.m4 b/ext/config.m4
@@ -4,8 +4,8 @@ if test "$PHP_TENSOR" = "yes"; then
 
 	
 
-	if ! test "x-lopenblas -llapacke -lgfortran" = "x"; then
-		PHP_EVAL_LIBLINE(-lopenblas -llapacke -lgfortran, TENSOR_SHARED_LIBADD)
+	if ! test "x-lopenblas -llapacke -lgfortran -lpthread" = "x"; then
+		PHP_EVAL_LIBLINE(-lopenblas -llapacke -lgfortran -lpthread, TENSOR_SHARED_LIBADD)
 	fi
 
 	AC_DEFINE(HAVE_TENSOR, 1, [Whether you have Tensor])
@@ -22,7 +22,8 @@ if test "$PHP_TENSOR" = "yes"; then
 	tensor/decompositions/lu.zep.c
 	tensor/matrix.zep.c
 	tensor/reductions/ref.zep.c
-	tensor/reductions/rref.zep.c include/indexing.c
+	tensor/reductions/rref.zep.c
+	tensor/settings.zep.c include/indexing.c
 	include/arithmetic.c
 	include/comparison.c
 	include/linear_algebra.c"
diff --git a/ext/config.w32 b/ext/config.w32
@@ -10,7 +10,7 @@ if (PHP_TENSOR != "no") {
     AC_DEFINE("ZEPHIR_USE_PHP_JSON", 1, "Whether PHP json extension is present at compile time");
   }
   ADD_SOURCES(configure_module_dirname + "/include", "indexing.c arithmetic.c comparison.c linear_algebra.c", "tensor");
-  ADD_SOURCES(configure_module_dirname + "/tensor", "arithmetic.zep.c arraylike.zep.c comparable.zep.c functional.zep.c statistical.zep.c trigonometric.zep.c tensor.zep.c vector.zep.c columnvector.zep.c matrix.zep.c", "tensor");
+  ADD_SOURCES(configure_module_dirname + "/tensor", "arithmetic.zep.c arraylike.zep.c comparable.zep.c functional.zep.c statistical.zep.c trigonometric.zep.c tensor.zep.c vector.zep.c columnvector.zep.c matrix.zep.c settings.zep.c", "tensor");
 	ADD_SOURCES(configure_module_dirname + "/tensor/decompositions", "cholesky.zep.c lu.zep.c", "tensor");
 	ADD_SOURCES(configure_module_dirname + "/tensor/reductions", "ref.zep.c rref.zep.c", "tensor");
   ADD_FLAG("CFLAGS_TENSOR", "/D ZEPHIR_RELEASE /Oi /Ot /Oy /Ob2 /Gs /GF /Gy /GL");
diff --git a/ext/include/arithmetic.h b/ext/include/arithmetic.h
@@ -1,5 +1,5 @@
-#ifndef TENSOR_TENSOR_ARITHMETIC_H
-#define TENSOR_TENSOR_ARITHMETIC_H
+#ifndef TENSOR_ARITHMETIC_H
+#define TENSOR_ARITHMETIC_H
 
 #include <Zend/zend.h>
 
@@ -17,4 +17,4 @@ void tensor_subtract_scalar(zval * return_value, zval * a, zval * b);
 void tensor_pow_scalar(zval * return_value, zval * a, zval * b);
 void tensor_mod_scalar(zval * return_value, zval * a, zval * b);
 
-#endif
+#endif
diff --git a/ext/include/comparison.h b/ext/include/comparison.h
@@ -1,5 +1,5 @@
-#ifndef TENSOR_ARRAY_COMPARISON_H
-#define TENSOR_ARRAY_COMPARISON_H
+#ifndef TENSOR_COMPARISON_H
+#define TENSOR_COMPARISON_H
 
 #include <Zend/zend.h>
 
diff --git a/ext/include/linear_algebra.c b/ext/include/linear_algebra.c
@@ -96,7 +96,6 @@ void tensor_inverse(zval * return_value, zval * a)
     unsigned int i, j;
     Bucket * row;
     zval rowB, b;
-    lapack_int status;
 
     zend_zephir_globals_def * zephir_globals = ZEPHIR_VGLOBAL;
 
@@ -110,15 +109,17 @@ void tensor_inverse(zval * return_value, zval * a)
 
     double * va = emalloc(n * n * sizeof(double));
 
-    for (i = 0; i < n; i++) {
+    for (i = 0; i < n; ++i) {
         row = Z_ARR(ba[i].val)->arData;
 
-        for (j = 0; j < n; j++) {
+        for (j = 0; j < n; ++j) {
             va[i * n + j] = zephir_get_doubleval(&row[j].val);
         }
     }
 
-    int pivots[n + 1];
+    lapack_int status;
+
+    int pivots[n];
 
     status = LAPACKE_dgetrf(LAPACK_ROW_MAJOR, n, n, va, n, pivots);
 
@@ -134,10 +135,10 @@ void tensor_inverse(zval * return_value, zval * a)
 
     array_init_size(&b, n);
 
-    for (i = 0; i < n; i++) {
+    for (i = 0; i < n; ++i) {
         array_init_size(&rowB, n);
 
-        for (j = 0; j < n; j++) {
+        for (j = 0; j < n; ++j) {
             add_next_index_double(&rowB, va[i * n + j]);
         }
 
diff --git a/ext/tensor.c b/ext/tensor.c
@@ -37,6 +37,7 @@ zend_class_entry *tensor_decompositions_lu_ce;
 zend_class_entry *tensor_matrix_ce;
 zend_class_entry *tensor_reductions_ref_ce;
 zend_class_entry *tensor_reductions_rref_ce;
+zend_class_entry *tensor_settings_ce;
 
 ZEND_DECLARE_MODULE_GLOBALS(tensor)
 
@@ -62,6 +63,7 @@ static PHP_MINIT_FUNCTION(tensor)
 	ZEPHIR_INIT(Tensor_Matrix);
 	ZEPHIR_INIT(Tensor_Reductions_Ref);
 	ZEPHIR_INIT(Tensor_Reductions_Rref);
+	ZEPHIR_INIT(Tensor_Settings);
 	
 	return SUCCESS;
 }
diff --git a/ext/tensor.h b/ext/tensor.h
@@ -18,5 +18,6 @@
 #include "tensor/matrix.zep.h"
 #include "tensor/reductions/ref.zep.h"
 #include "tensor/reductions/rref.zep.h"
+#include "tensor/settings.zep.h"
 
 #endif
diff --git a/ext/tensor/settings.zep.c b/ext/tensor/settings.zep.c
diff --git a/ext/tensor/settings.zep.h b/ext/tensor/settings.zep.h
diff --git a/tensor/settings.zep b/tensor/settings.zep
@@ -0,0 +1,41 @@
+namespace Tensor;
+
+use InvalidArgumentException;
+
+/**
+ * Settings
+ *
+ * @internal
+ *
+ * @category    Scientific Computing
+ * @package     Rubix/Tensor
+ * @author      Andrew DalPino
+ */
+class Settings
+{
+    /**
+     * Set the number of CPU threads to use when multiprocessing.
+     *
+     * @param int threads
+     * @return void
+     */
+    public static function setNumThreads(const int threads) -> void
+    {
+        if unlikely threads < 1 {
+            throw new InvalidArgumentException("The number of threads"
+                . " must be greater than 0, " . strval(threads) . " given.");
+        }
+
+        globals_set("num_threads", threads);
+    }
+
+    /**
+     * Return the number of CPU threads used for multiprocessing.
+     *
+     * @return int
+     */
+     public static function numThreads() -> int
+     {
+        return globals_get("num_threads");
+     }
+}

Original file line number	Diff line number	Diff line change
`@@ -22,15 +22,15 @@ class MatmulBench`
`22`	`22`
`23`	`23`	`public function setUp() : void`
`24`	`24`	`{`
`25`		`- $this->a = Matrix::uniform(1000, 1000);`
	`25`	`+ $this->a = Matrix::uniform(500, 500);`
`26`	`26`
`27`		`- $this->b = Matrix::uniform(1000, 1000);`
	`27`	`+ $this->b = Matrix::uniform(500, 500);`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`/**`
`31`	`31`	`* @Subject`
`32`	`32`	`* @Iterations(5)`
`33`		`- * @OutputTimeUnit("milliseconds", precision=3)`
	`33`	`+ * @OutputTimeUnit("seconds", precision=3)`
`34`	`34`	`*/`
`35`	`35`	`public function matmul() : void`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,15 +22,15 @@ class VectorDotProductBench`
`22`	`22`
`23`	`23`	`public function setUp() : void`
`24`	`24`	`{`
`25`		`- $this->a = Vector::uniform(100000);`
	`25`	`+ $this->a = Vector::uniform(10000000);`
`26`	`26`
`27`		`- $this->b = Vector::uniform(100000);`
	`27`	`+ $this->b = Vector::uniform(10000000);`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`/**`
`31`	`31`	`* @Subject`
`32`	`32`	`* @Iterations(5)`
`33`		`- * @OutputTimeUnit("milliseconds", precision=3)`
	`33`	`+ * @OutputTimeUnit("seconds", precision=3)`
`34`	`34`	`*/`
`35`	`35`	`public function dot() : void`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ if (PHP_TENSOR != "no") {`
`10`	`10`	`AC_DEFINE("ZEPHIR_USE_PHP_JSON", 1, "Whether PHP json extension is present at compile time");`
`11`	`11`	`}`
`12`	`12`	`ADD_SOURCES(configure_module_dirname + "/include", "indexing.c arithmetic.c comparison.c linear_algebra.c", "tensor");`
`13`		`- ADD_SOURCES(configure_module_dirname + "/tensor", "arithmetic.zep.c arraylike.zep.c comparable.zep.c functional.zep.c statistical.zep.c trigonometric.zep.c tensor.zep.c vector.zep.c columnvector.zep.c matrix.zep.c", "tensor");`
	`13`	`+ ADD_SOURCES(configure_module_dirname + "/tensor", "arithmetic.zep.c arraylike.zep.c comparable.zep.c functional.zep.c statistical.zep.c trigonometric.zep.c tensor.zep.c vector.zep.c columnvector.zep.c matrix.zep.c settings.zep.c", "tensor");`
`14`	`14`	`ADD_SOURCES(configure_module_dirname + "/tensor/decompositions", "cholesky.zep.c lu.zep.c", "tensor");`
`15`	`15`	`ADD_SOURCES(configure_module_dirname + "/tensor/reductions", "ref.zep.c rref.zep.c", "tensor");`
`16`	`16`	`ADD_FLAG("CFLAGS_TENSOR", "/D ZEPHIR_RELEASE /Oi /Ot /Oy /Ob2 /Gs /GF /Gy /GL");`