Rename SVD->isStandardBasisVector

to getStandardBasisIndex

Author: Aweptimum

src/LinearAlgebra/Decomposition/SVD.php

@@ -215,7 +215,7 @@ private static function diagonalize(NumericMatrix $S): array
         foreach ($vectors as $i => $vector)
         {
             // Each column should contain 1 non-zero element
-            $j = self::isStandardBasisVector($vector);
+            $j = self::getStandardBasisIndex($vector);
 
             if ($j === -1) {
                 throw new MatrixException("S Matrix in SVD is not orthogonal:\n" . (string) $S);
@@ -259,15 +259,15 @@ private static function diagonalize(NumericMatrix $S): array
     }
 
     /**
-     * Checks that a vector has a single non-zero entry
+     * Checks that a vector has a single non-zero entry and returns its index
      * 
      * @param Vector $v
      * 
      * @return int The index of the non-zero entry or -1 if either:
      *      1. There are multiple non-zero entries
      *      2. The vector is a zero vector 
      */
-    private static function isStandardBasisVector(Vector $v): int
+    private static function getStandardBasisIndex(Vector $v): int
     {
         if ($v->l2Norm() === 0) {
             return false;
@@ -281,7 +281,7 @@ private static function isStandardBasisVector(Vector $v): int
             if (!Arithmetic::almostEqual($component, 0)) {
                 if ($index === -1) {
                     $index = $i;
-                } else { // If we already found a non-zero component, then return false
+                } else { // If we already found a non-zero component, then return -1
                     return -1;
                 }
             }