set higher and lower methods

Author: larrydiamond

definitions/src/NavigableHash.d.ts

@@ -382,6 +382,12 @@ export declare class NavigableHashSet<K> implements NavigableSet<K> {
     */
     ceiling(key: K): K;
     /**
+    * Returns the least element in this set greater than the given element, or null if there is no such element.
+    * @param {K} item to find ceiling node for
+    * @return {K} the least element greater than the given element, or null if there is no such element
+    */
+    higher(key: K): K;
+    /**
     * Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the action are relayed to the caller.
     * @param {Consumer} consumer - the action to be performed for each element
     */
@@ -392,6 +398,12 @@ export declare class NavigableHashSet<K> implements NavigableSet<K> {
     */
     first(): K;
     /**
+    * Returns the greatest element in this set less than the given element, or null if there is no such element.
+    * @param {K} item to find floor node for
+    * @return {K} the greatest element less than the given element, or null if there is no such element
+    */
+    lower(key: K): K;
+    /**
     * Returns the last (highest) element currently in this set.
     * @return {K} the last (highest) element currently in this set, undefined if there are no elements in this set
     */

definitions/src/NavigableSet.d.ts

@@ -32,12 +32,24 @@ export interface NavigableSet<K> extends JSet<K> {
     */
     ceiling(item: K): K;
     /**
+    * Returns the least element in this set greater than the given element, or null if there is no such element.
+    * @param {K} item to find ceiling node for
+    * @return {K} the least element greater than the given element, or null if there is no such element
+    */
+    higher(item: K): K;
+    /**
     * Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
     * @param {K} item to find floor node for
     * @return {K} the greatest element less than or equal to e, or null if there is no such element
     */
     floor(item: K): K;
     /**
+    * Returns the greatest element in this set less than the given element, or null if there is no such element.
+    * @param {K} item to find floor node for
+    * @return {K} the greatest element less than the given element, or null if there is no such element
+    */
+    lower(item: K): K;
+    /**
     * Returns the first (lowest) element currently in this set.
     * @return {K} the first (lowest) element currently in this set, null if there are no elements in this set
     */

definitions/src/SkipList.d.ts

@@ -371,12 +371,24 @@ export declare class SkipListSet<K> implements NavigableSet<K> {
     */
     floor(key: K): K;
     /**
+    * Returns the greatest element in this set less than the given element, or null if there is no such element.
+    * @param {K} item to find floor node for
+    * @return {K} the greatest element less than the given element, or null if there is no such element
+    */
+    lower(key: K): K;
+    /**
     * Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
     * @param {K} item to find ceiling node for
     * @return {K} the least element greater than or equal to item, or null if there is no such element
     */
     ceiling(key: K): K;
     /**
+    * Returns the least element in this set greater than the given element, or null if there is no such element.
+    * @param {K} item to find ceiling node for
+    * @return {K} the least element greater than the given element, or null if there is no such element
+    */
+    higher(key: K): K;
+    /**
     * Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the action are relayed to the caller.
     * @param {Consumer} consumer - the action to be performed for each element
     */

dist/spec/TestNavigableSet.spec.js

@@ -99,6 +99,14 @@ describe("Test NavigableSet functionality", function () {
         testCeilingString(new TreeSet_1.TreeSet(Collections_1.Collections.getStringComparator()));
         testCeilingString(new SkipList_1.SkipListSet(Collections_1.Collections.getStringComparator()));
     });
+    it("Test higher", function () {
+        testHigherNumber(new NavigableHash_1.NavigableHashSet(Collections_1.Collections.getNumberComparator()));
+        testHigherNumber(new TreeSet_1.TreeSet(Collections_1.Collections.getNumberComparator()));
+        testHigherNumber(new SkipList_1.SkipListSet(Collections_1.Collections.getNumberComparator()));
+        testHigherString(new NavigableHash_1.NavigableHashSet(Collections_1.Collections.getStringComparator()));
+        testHigherString(new TreeSet_1.TreeSet(Collections_1.Collections.getStringComparator()));
+        testHigherString(new SkipList_1.SkipListSet(Collections_1.Collections.getStringComparator()));
+    });
     it("Test floor", function () {
         testFloorNumber(new NavigableHash_1.NavigableHashSet(Collections_1.Collections.getNumberComparator()));
         testFloorNumber(new TreeSet_1.TreeSet(Collections_1.Collections.getNumberComparator()));
@@ -107,6 +115,14 @@ describe("Test NavigableSet functionality", function () {
         testFloorString(new TreeSet_1.TreeSet(Collections_1.Collections.getStringComparator()));
         testFloorString(new SkipList_1.SkipListSet(Collections_1.Collections.getStringComparator()));
     });
+    it("Test lower", function () {
+        testLowerNumber(new NavigableHash_1.NavigableHashSet(Collections_1.Collections.getNumberComparator()));
+        testLowerNumber(new TreeSet_1.TreeSet(Collections_1.Collections.getNumberComparator()));
+        testLowerNumber(new SkipList_1.SkipListSet(Collections_1.Collections.getNumberComparator()));
+        testLowerString(new NavigableHash_1.NavigableHashSet(Collections_1.Collections.getStringComparator()));
+        testLowerString(new TreeSet_1.TreeSet(Collections_1.Collections.getStringComparator()));
+        testLowerString(new SkipList_1.SkipListSet(Collections_1.Collections.getStringComparator()));
+    });
     it("Test tostring", function () {
         testToString(new NavigableHash_1.NavigableHashSet(Collections_1.Collections.getStringComparator()));
         testToString(new TreeSet_1.TreeSet(Collections_1.Collections.getStringComparator()));
@@ -225,6 +241,18 @@ function testCeilingNumber(set) {
     expect(set.ceiling(1)).toEqual(100);
     expect(set.ceiling(99999)).toEqual(null);
 }
+function testHigherNumber(set) {
+    expect(set.higher(456)).toEqual(null);
+    expect(set.size()).toEqual(0);
+    expect(set.isEmpty()).toEqual(true);
+    addTestNumbers(set);
+    expect(set.size()).toEqual(10);
+    expect(set.isEmpty()).toEqual(false);
+    expect(set.higher(456)).toEqual(500);
+    expect(set.higher(600)).toEqual(700);
+    expect(set.higher(1)).toEqual(100);
+    expect(set.higher(99999)).toEqual(null);
+}
 function testCeilingString(set) {
     expect(set.ceiling("notfound")).toEqual(null);
     expect(set.size()).toEqual(0);
@@ -237,6 +265,18 @@ function testCeilingString(set) {
     expect(set.ceiling("aaaaa")).toEqual("eighth");
     expect(set.ceiling("zzzzz")).toEqual(null);
 }
+function testHigherString(set) {
+    expect(set.higher("notfound")).toEqual(null);
+    expect(set.size()).toEqual(0);
+    expect(set.isEmpty()).toEqual(true);
+    addTestStrings(set);
+    expect(set.size()).toEqual(10);
+    expect(set.isEmpty()).toEqual(false);
+    expect(set.higher("notfound")).toEqual("second");
+    expect(set.higher("first")).toEqual("fourth");
+    expect(set.higher("aaaaa")).toEqual("eighth");
+    expect(set.higher("zzzzz")).toEqual(null);
+}
 function testFloorNumber(set) {
     expect(set.floor(456)).toEqual(null);
     expect(set.size()).toEqual(0);
@@ -261,6 +301,30 @@ function testFloorString(set) {
     expect(set.floor("aaaaa")).toEqual(null);
     expect(set.floor("zzzzz")).toEqual("third");
 }
+function testLowerNumber(set) {
+    expect(set.lower(456)).toEqual(null);
+    expect(set.size()).toEqual(0);
+    expect(set.isEmpty()).toEqual(true);
+    addTestNumbers(set);
+    expect(set.size()).toEqual(10);
+    expect(set.isEmpty()).toEqual(false);
+    expect(set.lower(456)).toEqual(400);
+    expect(set.lower(600)).toEqual(500);
+    expect(set.lower(1)).toEqual(null);
+    expect(set.lower(99999)).toEqual(1000);
+}
+function testLowerString(set) {
+    expect(set.lower("notfound")).toEqual(null);
+    expect(set.size()).toEqual(0);
+    expect(set.isEmpty()).toEqual(true);
+    addTestStrings(set);
+    expect(set.size()).toEqual(10);
+    expect(set.isEmpty()).toEqual(false);
+    expect(set.lower("notfound")).toEqual("ninth");
+    expect(set.lower("first")).toEqual("fifth");
+    expect(set.lower("aaaaa")).toEqual(null);
+    expect(set.lower("zzzzz")).toEqual("third");
+}
 function testToString(set) {
     jasts_1.TestString.equals("Empty set should stringify to []", JSON.stringify(set), '[]');
     expect(set.size()).toEqual(0);

dist/src/NavigableHash.js

@@ -1254,6 +1254,18 @@ var NavigableHashSet = /** @class */ (function () {
         return node.getKey();
     };
     /**
+    * Returns the least element in this set greater than the given element, or null if there is no such element.
+    * @param {K} item to find ceiling node for
+    * @return {K} the least element greater than the given element, or null if there is no such element
+    */
+    NavigableHashSet.prototype.higher = function (key) {
+        var node = this.impl.higherEntry(key);
+        if ((node === undefined) || (node === null)) {
+            return null;
+        }
+        return node.getKey();
+    };
+    /**
     * Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the action are relayed to the caller.
     * @param {Consumer} consumer - the action to be performed for each element
     */
@@ -1275,6 +1287,18 @@ var NavigableHashSet = /** @class */ (function () {
         return node.getKey();
     };
     /**
+    * Returns the greatest element in this set less than the given element, or null if there is no such element.
+    * @param {K} item to find floor node for
+    * @return {K} the greatest element less than the given element, or null if there is no such element
+    */
+    NavigableHashSet.prototype.lower = function (key) {
+        var node = this.impl.lowerEntry(key);
+        if ((node === undefined) || (node === null)) {
+            return null;
+        }
+        return node.getKey();
+    };
+    /**
     * Returns the last (highest) element currently in this set.
     * @return {K} the last (highest) element currently in this set, undefined if there are no elements in this set
     */

dist/src/SkipList.js

@@ -1234,6 +1234,18 @@ var SkipListSet = /** @class */ (function () {
         return node.getKey();
     };
     /**
+    * Returns the greatest element in this set less than the given element, or null if there is no such element.
+    * @param {K} item to find floor node for
+    * @return {K} the greatest element less than the given element, or null if there is no such element
+    */
+    SkipListSet.prototype.lower = function (key) {
+        var node = this.impl.lowerEntry(key);
+        if ((node === undefined) || (node === null)) {
+            return null;
+        }
+        return node.getKey();
+    };
+    /**
     * Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
     * @param {K} item to find ceiling node for
     * @return {K} the least element greater than or equal to item, or null if there is no such element
@@ -1246,6 +1258,18 @@ var SkipListSet = /** @class */ (function () {
         return node.getKey();
     };
     /**
+    * Returns the least element in this set greater than the given element, or null if there is no such element.
+    * @param {K} item to find ceiling node for
+    * @return {K} the least element greater than the given element, or null if there is no such element
+    */
+    SkipListSet.prototype.higher = function (key) {
+        var node = this.impl.higherEntry(key);
+        if ((node === undefined) || (node === null)) {
+            return null;
+        }
+        return node.getKey();
+    };
+    /**
     * Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the action are relayed to the caller.
     * @param {Consumer} consumer - the action to be performed for each element
     */