diff --git a/test/spec/ol/array.test.js b/test/spec/ol/array.test.js index c232ddc616..409b297865 100644 --- a/test/spec/ol/array.test.js +++ b/test/spec/ol/array.test.js @@ -2,6 +2,300 @@ goog.provide('ol.test.array'); describe('ol.array', function() { + describe('binarySearch', function() { + + var insertionPoint = function(position) { + return -(position + 1); + }; + var revNumCompare = function(a, b) { + return b - a; + }; + + describe('default comparison on array of String(s)', function() { + var a = [ + '1000', '9', 'AB', 'ABC', 'ABCABC', 'ABD', 'ABDA', 'B', 'B', 'B', + 'C', 'CA', 'CC', 'ZZZ', 'ab', 'abc', 'abcabc', 'abd', 'abda', 'b', + 'c', 'ca', 'cc', 'zzz' + ]; + + it('should find \'1000\' at index 0', function() { + expect(ol.array.binarySearch(a, '1000')).to.be(0); + }); + it('should find \'zzz\' at index ' + (a.length - 1), function() { + expect(ol.array.binarySearch(a, 'zzz')).to.be(a.length - 1); + }); + it('should find \'C\' at index 10', function() { + expect(ol.array.binarySearch(a, 'C')).to.be(10); + }); + it('should find \'B\' at index 7 || 8 || 9', function() { + var pos = ol.array.binarySearch(a, 'B'); + expect(pos == 7 || pos == 8 || pos == 9).to.be.ok(); + }); + it('should not find \'100\'', function() { + var pos = ol.array.binarySearch(a, '100'); + expect(pos < 0).to.be.ok(); + }); + it('should have an insertion point of 0 for \'100\'', function() { + var pos = ol.array.binarySearch(a, '100'); + expect(insertionPoint(pos)).to.be(0); + }); + it('should not find \'zzz0\'', function() { + var pos = ol.array.binarySearch(a, 'zzz0'); + expect(pos < 0).to.be.ok(); + }); + it('should have an insertion point of ' + (a.length) + ' for \'zzz0\'', + function() { + var pos = ol.array.binarySearch(a, 'zzz0'); + expect(insertionPoint(pos)).to.be(a.length); + } + ); + it('should not find \'BA\'', function() { + var pos = ol.array.binarySearch(a, 'zzz0'); + expect(pos < 0).to.be.ok(); + }); + it('should have an insertion point of 10 for \'BA\'', + function() { + var pos = ol.array.binarySearch(a, 'BA'); + expect(insertionPoint(pos)).to.be(10); + } + ); + }); + + describe('0 length array with default comparison', function() { + var b = []; + it('should not find \'a\'', function() { + expect(ol.array.binarySearch(b, 'a') < 0).to.be.ok(); + }); + it('should have an insertion point of 0 for \'a\'', + function() { + var pos = ol.array.binarySearch(b, 'a'); + expect(insertionPoint(pos)).to.be(0); + } + ); + }); + + describe('single element array with default lexiographical comparison', + function() { + var c = ['only item']; + it('should find \'only item\' at index 0', function() { + expect(ol.array.binarySearch(c, 'only item')).to.be(0); + }); + it('should not find \'a\'', function() { + expect(ol.array.binarySearch(c, 'a') < 0).to.be.ok(); + }); + it('should have an insertion point of 0 for \'a\'', + function() { + var pos = ol.array.binarySearch(c, 'a'); + expect(insertionPoint(pos)).to.be(0); + } + ); + it('should not find \'z\'', function() { + expect(ol.array.binarySearch(c, 'z') < 0).to.be.ok(); + }); + it('should have an insertion point of 1 for \'z\'', + function() { + var pos = ol.array.binarySearch(c, 'z'); + expect(insertionPoint(pos)).to.be(1); + } + ); + } + ); + + describe('default comparison on array of Number(s)', function() { + var d = [-897123.9, -321434.58758, -1321.3124, -324, -9, -3, 0, 0, 0, + 0.31255, 5, 142.88888708, 334, 342, 453, 54254]; + it('should find -897123.9 at index 0', function() { + expect(ol.array.binarySearch(d, -897123.9)).to.be(0); + }); + it('should find 54254 at index ' + (d.length - 1), function() { + expect(ol.array.binarySearch(d, 54254)).to.be(d.length - 1); + }); + it('should find -3 at index 5', function() { + expect(ol.array.binarySearch(d, -3)).to.be(5); + }); + it('should find 0 at index 6 || 7 || 8', function() { + var pos = ol.array.binarySearch(d, 0); + expect(pos == 6 || pos == 7 || pos == 8).to.be(true); + }); + it('should not find -900000', function() { + var pos = ol.array.binarySearch(d, -900000); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of 0 for -900000', function() { + var pos = ol.array.binarySearch(d, -900000); + expect(insertionPoint(pos)).to.be(0); + }); + // TODO The original tests also use a string here, I cannot see why. + it('should not find \'54255\'', function() { + var pos = ol.array.binarySearch(d, '54255'); + expect(pos < 0).to.be(true); + }); + // TODO The original tests also use a string here, I cannot see why. + it('should have an insertion point of ' + (d.length) + ' for \'54255\'', + function() { + var pos = ol.array.binarySearch(d, '54255'); + expect(insertionPoint(pos)).to.be(d.length); + } + ); + it('should not find 1.1', function() { + var pos = ol.array.binarySearch(d, 1.1); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of 10 for 1.1', function() { + var pos = ol.array.binarySearch(d, 1.1); + expect(insertionPoint(pos)).to.be(10); + }); + }); + + describe('custom comparison function, which reverse orders numbers', + function() { + var e = [54254, 453, 342, 334, 142.88888708, 5, 0.31255, 0, 0, 0, -3, + -9, -324, -1321.3124, -321434.58758, -897123.9]; + it('should find 54254 at index 0', function() { + var pos = ol.array.binarySearch(e, 54254, revNumCompare); + expect(pos).to.be(0); + }); + it('should find -897123.9 at index ' + (e.length - 1), function() { + var pos = ol.array.binarySearch(e, -897123.9, revNumCompare); + expect(pos).to.be(e.length - 1); + }); + it('should find -3 at index 10', function() { + var pos = ol.array.binarySearch(e, -3, revNumCompare); + expect(pos).to.be(10); + }); + // TODO this test differs from the original one, which checks 7, 9, 10. + it('should find 0 at index 7 || 8 || 9', function() { + var pos = ol.array.binarySearch(e, 0, revNumCompare); + expect(pos == 7 || pos == 8 || pos == 9).to.be(true); + }); + it('should not find 54254.1', function() { + var pos = ol.array.binarySearch(e, 54254.1, revNumCompare); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of 0 for 54254.1', function() { + var pos = ol.array.binarySearch(e, 54254.1, revNumCompare); + expect(insertionPoint(pos)).to.be(0); + }); + it('should not find -897124', function() { + var pos = ol.array.binarySearch(e, -897124, revNumCompare); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of ' + e.length + ' for -897124', + function() { + var pos = ol.array.binarySearch(e, -897124, revNumCompare); + expect(insertionPoint(pos)).to.be(e.length); + } + ); + it('should not find 1.1', function() { + var pos = ol.array.binarySearch(e, 1.1, revNumCompare); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of 0 for 1.1', function() { + var pos = ol.array.binarySearch(e, 1.1, revNumCompare); + expect(insertionPoint(pos)).to.be(6); + }); + } + ); + + describe('0 length array with custom comparison function', function() { + var f = []; + it('should not find 0', function() { + var pos = ol.array.binarySearch(f, 0, revNumCompare); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of 0 for 0', function() { + var pos = ol.array.binarySearch(f, 0, revNumCompare); + expect(insertionPoint(pos)).to.be(0); + }); + }); + + describe('single element array with custom comparison function', + function() { + var g = [1]; + it('shouldn find 1 at index 0', function() { + var pos = ol.array.binarySearch(g, 1, revNumCompare); + expect(pos).to.be(0); + }); + it('should not find 2', function() { + var pos = ol.array.binarySearch(g, 2, revNumCompare); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of 0 for 2', function() { + var pos = ol.array.binarySearch(g, 2, revNumCompare); + expect(insertionPoint(pos)).to.be(0); + }); + it('should not find 0', function() { + var pos = ol.array.binarySearch(g, 0, revNumCompare); + expect(pos < 0).to.be(true); + }); + it('should have an insertion point of 1 for 0', function() { + var pos = ol.array.binarySearch(g, 0, revNumCompare); + expect(insertionPoint(pos)).to.be(1); + }); + } + ); + + describe('finding first index when multiple candidates', function() { + it('should find the index of the first 0', function() { + // TODO here our implementation is different from the goog-one + // we need to ensure this is intended. + expect(ol.array.binarySearch([0, 0, 1], 0)).to.be(0); + }); + it('should find the index of the first 1', function() { + expect(ol.array.binarySearch([0, 1, 1], 1)).to.be(1); + }); + }); + + describe('Don\'t use Array#slice, Function#apply and Function#call', + function() { + var a = [1, 5, 7, 11, 13, 16, 19, 24, 28, 31, 33, 36, 40, 50, 52, 55]; + var calls = { + 'Array#slice': false, + 'Function#apply': false, + 'Function#call': false + }; + var origArraySlice; + var origFunctionApply; + var origFunctionCall; + + it('does not use potentially slow methods (default & custom compare)', + function() { + // Mockup (I failed to use sinon.spy and beforeEach-hooks) + origArraySlice = Array.prototype.slice; + origFunctionApply = Function.prototype.apply; + origFunctionCall = Function.prototype.call; + Array.prototype.slice = function() { + calls['Array#slice'] = true; + }; + Function.prototype.apply = function() { + calls['Function#apply'] = true; + }; + Function.prototype.call = function() { + calls['Function#call'] = true; + }; + + // Now actually call and test the method twice + ol.array.binarySearch(a, 48); + ol.array.binarySearch(a, 13, function(a, b) { + return a > b ? 1 : a < b ? -1 : 0; + }); + + // Restore mocked up methods + Array.prototype.slice = origArraySlice; + Function.prototype.apply = origFunctionApply; + Function.prototype.call = origFunctionCall; + + // Expectations + expect(calls['Array#slice']).to.be(false); + expect(calls['Function#apply']).to.be(false); + expect(calls['Function#call']).to.be(false); + } + ); + } + ); + + }); + describe('binaryFindNearest', function() { it('returns expected value', function() { var arr = [1000, 500, 100];