Add triagularity tests

Author: rreusser

README.md

@@ -49,11 +49,14 @@ Test whether the pairwise inner product of all column pairs is less than `tol`.
 #### `orthogonal( a [, tol], [, onFalse] )`
 Checks for squareness, column normality, and pair-wise column orthogonality to check if the matrix is orthogonal. `tol` is passed to the `columnsNormal` and `columnsOrthogonal`
 
+#### `upperTriangular( a, [, tol] [, onFalse] )`
+Check whether all entries below the diagonal are within `tol` of zero. Works on tall and wide two-dimensional ndarrays.
+
+#### `lowerTriangular( a, [, tol] [, onFalse] )`
+Check whether all entries above the diagonal are within `tol` of zero. Works on tall and wide two-dimensional ndarrays.
 
 ### TO DO:
 
-- `upperTriangular( a, b, [, tol] [, onFalse] )`
-- `lowerTriangular( a, b, [, tol] [, onFalse] )`
 - `diagonal( a, [, tol] [, onFalse] )`
 - separate column methods to allow testing of specific pair-wise columns (or maybe that's simple enough that it's unnecessary)
 

index.js

@@ -164,13 +164,57 @@ var orthogonal = function(a, tol, onFalse) {
   return true;
 };
 
+var upperTriangular = function(a, tol, onFalse) {
+  if( tol === undefined ) {
+    tol = 0.0;
+  }
+
+  if( a.dimension !== 2 ) {
+    output(onFalse,'upperTriangular():: can only test for triangularity of two-dimensional arrays');
+    return false;
+  }
+
+  for(var i=1; i<a.shape[0]; i++) {
+    for(var j=0; j<i; j++) {
+      if( Math.abs(a.get(i,j)) > tol ) {
+        output(onFalse,'upperTriangular():: A[' + i + ',' + j + '] (= ' + a.get(i,j) + ') > ' + tol + '.');
+        return false;
+      }
+    }
+  }
+
+  return true;
+};
+
+var lowerTriangular = function(a, tol, onFalse) {
+  if( tol === undefined ) {
+    tol = 0.0;
+  }
+
+  if( a.dimension !== 2 ) {
+    output(onFalse,'lowerTriangular():: can only test for triangularity of two-dimensional arrays');
+    return false;
+  }
+
+  for(var i=0; i<a.shape[0]; i++) {
+    for(var j=i+1; j<a.shape[1]; j++) {
+      if( Math.abs(a.get(i,j)) > tol ) {
+        output(onFalse,'lowerTriangular():: A[' + i + ',' + j + '] (= ' + a.get(i,j) + ') > ' + tol + '.');
+        return false;
+      }
+    }
+  }
+
+  return true;
+};
+
 
 
 exports.approximatelyEqual = approximatelyEqual;
 exports.symmetric = symmetric;
 exports.columnsOrthogonal = columnsOrthogonal;
 exports.columnsNormalized = columnsNormalized;
 exports.orthogonal = orthogonal;
-//exports.upperTriangular = upperTriangular;
-//exports.lowerTriangular = lowerTriangular;
+exports.upperTriangular = upperTriangular;
+exports.lowerTriangular = lowerTriangular;
 //exports.diagonal = diagonal;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ndarray-tests",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Test numerical properties of ndarrays",
   "main": "index.js",
   "scripts": {

test/test.js

@@ -176,3 +176,106 @@ describe('orthogonal',function() {
 });
 
 
+
+describe('upperTriangular',function() {
+
+  var upperTall, almostUpperTall, upperWide, almostUpperWide;
+
+  beforeEach(function() {
+    upperTall       = ndarray([1,2,3,0,4,5,0,0,6,0,0,0],[4,3]);
+    almostUpperTall = ndarray([1,2,3,1e-4,4,5,0,0,6,0,0,0],[4,3]);
+    upperWide       = ndarray([1,2,3,4,0,5,6,7,0,0,8,9],[3,4]);
+    almostUpperWide = ndarray([1,2,3,4,1e-4,5,6,7,0,0,8,9],[3,4]);
+  });
+
+  describe('tall matrices',function() {
+    it('true if exactly upper triangular',function() {
+      assert.isTrue( ndtest.upperTriangular(upperTall) );
+    });
+
+    it('true if within tolerance',function() {
+      assert.isTrue( ndtest.upperTriangular(almostUpperTall,1e-2) );
+    });
+
+    it('false if no tolerance provided and not exactly upper triangular',function() {
+      assert.isFalse( ndtest.upperTriangular(almostUpperTall) );
+    });
+
+    it('false if not within tolerance',function() {
+      assert.isFalse( ndtest.upperTriangular(almostUpperTall,1e-8) );
+    });
+  });
+
+  describe('wide matrices',function() {
+    it('true if exactly upper triangular',function() {
+      assert.isTrue( ndtest.upperTriangular(upperWide) );
+    });
+
+    it('true if within tolerance',function() {
+      assert.isTrue( ndtest.upperTriangular(almostUpperWide,1e-2) );
+    });
+
+    it('false if no tolerance provided and not exactly upper triangular',function() {
+      assert.isFalse( ndtest.upperTriangular(almostUpperWide) );
+    });
+
+    it('false if not within tolerance',function() {
+      assert.isFalse( ndtest.upperTriangular(almostUpperWide,1e-8) );
+    });
+  });
+
+});
+
+
+
+describe('lowerTriangular',function() {
+
+  var lowerTall, almostLowerTall, lowerWide, almostLowerWide;
+
+  beforeEach(function() {
+    lowerTall       = ndarray([1,0,0,1,1,0,1,1,1,1,1,1],[4,3]);
+    almostLowerTall = ndarray([1,1e-4,0,1,1,0,1,1,1,1,1,1],[4,3]);
+    lowerWide       = ndarray([1,0,0,0,2,3,0,0,4,5,6,0,7,8,9,10],[3,4]);
+    almostLowerWide = ndarray([1,1e-4,0,0,2,3,0,0,4,5,6,0,7,8,9,10],[3,4]);
+  });
+
+  describe('tall matrices',function() {
+    it('true if exactly lower triangular',function() {
+      assert.isTrue( ndtest.lowerTriangular(lowerTall) );
+    });
+
+    it('true if within tolerance',function() {
+      assert.isTrue( ndtest.lowerTriangular(almostLowerTall,1e-2) );
+    });
+
+    it('false if no tolerance provided and not exactly lower triangular',function() {
+      assert.isFalse( ndtest.lowerTriangular(almostLowerTall) );
+    });
+
+    it('false if not within tolerance',function() {
+      assert.isFalse( ndtest.lowerTriangular(almostLowerTall,1e-8) );
+    });
+  });
+
+  describe('wide matrices',function() {
+    it('true if exactly lower triangular',function() {
+      assert.isTrue( ndtest.lowerTriangular(lowerWide) );
+    });
+
+    it('true if within tolerance',function() {
+      assert.isTrue( ndtest.lowerTriangular(almostLowerWide,1e-2) );
+    });
+
+    it('false if no tolerance provided and not exactly lower triangular',function() {
+      assert.isFalse( ndtest.lowerTriangular(almostLowerWide) );
+    });
+
+    it('false if not within tolerance',function() {
+      assert.isFalse( ndtest.lowerTriangular(almostLowerWide,1e-8) );
+    });
+  });
+
+
+});
+
+