summaryrefslogtreecommitdiffstats
path: root/vendor/markbaker/matrix/classes/src/Functions/diagonal.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/markbaker/matrix/classes/src/Functions/diagonal.php')
-rw-r--r--vendor/markbaker/matrix/classes/src/Functions/diagonal.php32
1 files changed, 32 insertions, 0 deletions
diff --git a/vendor/markbaker/matrix/classes/src/Functions/diagonal.php b/vendor/markbaker/matrix/classes/src/Functions/diagonal.php
new file mode 100644
index 0000000..8993db3
--- /dev/null
+++ b/vendor/markbaker/matrix/classes/src/Functions/diagonal.php
@@ -0,0 +1,32 @@
+<?php
+
+/**
+ *
+ * Function code for the matrix diagonal() function
+ *
+ * @copyright Copyright (c) 2018 Mark Baker (https://github.com/MarkBaker/PHPMatrix)
+ * @license https://opensource.org/licenses/MIT MIT
+ */
+
+namespace Matrix;
+
+/**
+ * Returns the diagonal of a matrix or an array.
+ *
+ * @param Matrix|array $matrix Matrix or an array to treat as a matrix.
+ * @return Matrix The new matrix
+ * @throws Exception If argument isn't a valid matrix or array.
+ */
+if (!function_exists(__NAMESPACE__ . '\\diagonal')) {
+ function diagonal($matrix): Matrix
+ {
+ if (is_array($matrix)) {
+ $matrix = new Matrix($matrix);
+ }
+ if (!$matrix instanceof Matrix) {
+ throw new Exception('Must be Matrix or array');
+ }
+
+ return Functions::diagonal($matrix);
+ }
+}