Testing MultiHashSet

Author: larrydiamond

definitions/src/Collectable.d.ts

@@ -1,20 +1,35 @@
 /**
  * @license
- * Copyright Larry Diamond 2017 All Rights Reserved.
+ * Copyright Larry Diamond 2018 All Rights Reserved.
  *
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://github.com/larrydiamond/typescriptcollectionsframework/LICENSE
  */
+/**
+ * The Collectable interface provides a mechanism to compare objects to see if they are equal.
+ * This is a replacement for the equals method in Java
+ */
 export interface Collectable<T> {
     /**
      * Compares its two arguments for equality
+     *
      * The equals method implements an equivalence relation on non-null object references:
-     * It is reflexive: for any non-null reference value x, x.equals(x) should return true.
-     * It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
-     * It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
-     * It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
+     *
+     * It is reflexive: for any reference value x, x.equals(x) should return true.
+     *
+     * It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
+     *
+     * It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
+     *
+     * It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
+     *
      * For any non-null reference value x, x.equals(null) should return false.
-     * The equals method implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
+     *
+     * For any non-undefined reference value x, x.equals(undefined) should return false.
+     *
+     * The equals method implements the most discriminating possible equivalence relation on objects;
+     * that is, for any non-null and non-undefined reference values x and y,
+     * this method returns true if and only if x and y refer to the same object (x == y has the value true).
      * @param {T} t element to compare
      * @return {boolean} true if the other element is "equal" to this one
      */

definitions/src/HashClasses.d.ts

@@ -82,7 +82,10 @@ export declare class HashMultiSet<K> implements MultiSet<K> {
     add(element: K): boolean;
     /**
     * Removes a single occurrence of the specified element from this MultiSet, if present.
-    * @param {K} element element to be removed from this MultiSet
+    *
+    * The element removed will be equal to the element as per the Hashable used in this MultiSet
+    * and will not necessarily be the element passed in.
+    * @param {K} element element equal to this element to be removed from this MultiSet
     * @return {boolean} true if the set contained the specified element
     */
     remove(element: K): boolean;

definitions/src/JSet.d.ts

@@ -1,12 +1,37 @@
 /**
  * @license
- * Copyright Larry Diamond 2017 All Rights Reserved.
+ * Copyright Larry Diamond 2018 All Rights Reserved.
  *
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://github.com/larrydiamond/typescriptcollectionsframework/LICENSE
  */
 import { Collection } from "./Collection";
 import { ImmutableSet } from "./ImmutableSet";
+/**
+ * A collection that contains no duplicate elements.
+ *
+ * More formally, sets contain no pair of elements e1 and e2 such that e1.equals(e2),
+ * and at most one null element and at most one undefined element.
+ *
+ * As implied by its name, this interface models the mathematical set abstraction.
+ *
+ * The Set interface places additional stipulations, beyond those inherited from the Collection interface,
+ * on the contracts of all constructors and on the contracts of the add, equals and hashCode methods.
+ *
+ * Declarations for other inherited methods are also included here for convenience.
+ * (The specifications accompanying these declarations have been tailored to the Set interface,
+ * but they do not contain any additional stipulations.)
+ *
+ * The additional stipulation on constructors is, not surprisingly,
+ * that all constructors must create a set that contains no duplicate elements (as defined above).
+ *
+ * Note: Great care must be exercised if mutable objects are used as set elements.
+ *
+ * The behavior of a set is not specified if the value of an object is changed in a manner
+ * that affects equals comparisons while the object is an element in the set.
+ *
+ * A special case of this prohibition is that it is not permissible for a set to contain itself as an element.
+ */
 export interface JSet<K> extends ImmutableSet<K>, Collection<K> {
     /**
     * Adds the specified element to this set if it is not already present.

dist/spec/TestMultiSet.spec.js

@@ -121,6 +121,17 @@ describe("Test generic MultiSet functionality", function () {
         expect(tmp.count(productNotAvailable)).toEqual(0);
         expect(tmp.count(product2)).toEqual(4);
     });
+    it("Test remove string", function () {
+        testRemoveString(new HashClasses_1.HashMultiSet());
+        testRemoveString(new HashClasses_1.HashMultiSet(new AllFieldHashable_1.AllFieldHashable()));
+    });
+    it("Test remove number", function () {
+        testRemoveNumber(new HashClasses_1.HashMultiSet());
+        testRemoveNumber(new HashClasses_1.HashMultiSet(new AllFieldHashable_1.AllFieldHashable()));
+    });
+    it("Test remove number", function () {
+        testRemovePetStoreProductAndValueClass(new HashClasses_1.HashMultiSet(petStoreProductHashable));
+    });
 });
 function testEmptyStringMultiSet(tmp) {
     expect(tmp.isEmpty()).toEqual(true);
@@ -357,3 +368,58 @@ function addPetStoreProducts(tmp) {
     tmp.add(priceDuplicate2);
     tmp.add(priceDuplicate3);
 }
+function testRemoveString(mset) {
+    expect(mset.contains("testkey")).toEqual(false);
+    expect(mset.size()).toEqual(0);
+    expect(mset.isEmpty()).toEqual(true);
+    expect(true).toEqual(mset.add("testkey"));
+    expect(mset.size()).toEqual(1);
+    expect(mset.isEmpty()).toEqual(false);
+    expect(mset.contains("testkey")).toEqual(true);
+    expect(mset.contains("NoSuchString")).toEqual(false);
+    expect(false).toEqual(mset.remove("NoSuchString"));
+    expect(mset.contains("NoSuchString")).toEqual(false);
+    expect(mset.contains("testkey")).toEqual(true);
+    expect(mset.size()).toEqual(1);
+    expect(mset.isEmpty()).toEqual(false);
+    expect(true).toEqual(mset.remove("testkey"));
+    expect(mset.size()).toEqual(0);
+    expect(mset.isEmpty()).toEqual(true);
+    expect(mset.contains("testkey")).toEqual(false);
+}
+function testRemoveNumber(mset) {
+    expect(mset.contains(1000)).toEqual(false);
+    expect(mset.size()).toEqual(0);
+    expect(mset.isEmpty()).toEqual(true);
+    expect(true).toEqual(mset.add(1000));
+    expect(mset.size()).toEqual(1);
+    expect(mset.isEmpty()).toEqual(false);
+    expect(mset.contains(1000)).toEqual(true);
+    expect(mset.contains(2000)).toEqual(false);
+    expect(false).toEqual(mset.remove(2000));
+    expect(mset.contains(2000)).toEqual(false);
+    expect(mset.contains(1000)).toEqual(true);
+    expect(mset.size()).toEqual(1);
+    expect(mset.isEmpty()).toEqual(false);
+    expect(true).toEqual(mset.remove(1000));
+    expect(mset.size()).toEqual(0);
+    expect(mset.isEmpty()).toEqual(true);
+    expect(mset.contains(1000)).toEqual(false);
+}
+function testRemovePetStoreProductAndValueClass(mset) {
+    expect(mset.contains(product1)).toEqual(false);
+    expect(mset.size()).toEqual(0);
+    expect(mset.isEmpty()).toEqual(true);
+    expect(true).toEqual(mset.add(product1));
+    expect(mset.size()).toEqual(1);
+    expect(mset.isEmpty()).toEqual(false);
+    expect(mset.contains(product1)).toEqual(true);
+    expect(false).toEqual(mset.remove(product2));
+    expect(mset.size()).toEqual(1);
+    expect(mset.isEmpty()).toEqual(false);
+    expect(mset.contains(product1)).toEqual(true);
+    expect(true).toEqual(mset.remove(product1));
+    expect(mset.contains(product1)).toEqual(false);
+    expect(mset.size()).toEqual(0);
+    expect(mset.isEmpty()).toEqual(true);
+}