增加集合结构的封装和文档

Author: XPoet

README.md

@@ -17,6 +17,7 @@
 - [JavaScript 数据结构与算法（五）优先队列](assets/doc/05_JavaScript数据结构与算法（五）优先队列.md)
 - [JavaScript 数据结构与算法（六）单向链表](assets/doc/06_JavaScript数据结构与算法（六）单向链表.md)
 - [JavaScript 数据结构与算法（七）双向链表](assets/doc/07_JavaScript数据结构与算法（七）双向链表.md)
+- [JavaScript 数据结构与算法（八）集合](assets/doc/08_JavaScript数据结构与算法（八）集合.md)
 
 ## 测试环境
 

assets/doc/08_JavaScript数据结构与算法（八）集合.md

@@ -0,0 +1,304 @@
+# JavaScript 数据结构与算法（八）集合
+
+## 集合
+
+几乎每种编程语言中，都有集合结构。集合比较常见的实现方式是哈希表，这里使用 JavaScript 的 Object 进行封装。
+
+### 集合特点
+
+- 集合通常是由一组**无序的**、**不能重复的**元素构成。
+
+- 数学中常指的集合中的元素是可以重复的，但是计算机中集合的元素不能重复。
+
+- 集合是特殊的数组。
+  - 特殊之处在于里面的元素没有顺序，也不能重复。
+  - 没有顺序意味着不能通过下标值进行访问，不能重复意味着相同的对象在集合中只会存在一份。
+
+### 封装集合
+
+ES6 中的 `Set` 就是一个集合类，这里我们重新封装一个 `Set` 类，了解集合的底层实现。
+
+#### 集合常见的操作
+
+- `add(value)` 向集合添加一个新的项。
+- `remove(value)` 从集合移除一个值。
+- `has(value)` 如果值在集合中，返回 true，否则返回 false。
+- `clear()` 移除集合中的所有项。
+- `size()` 返回集合所包含元素的数量。与数组的 length 属性类似。
+- `values()` 返回一个包含集合中所有值的数组。
+- 还有其他的方法，用的不多，这里不做封装。
+
+#### 代码实现
+
+```js
+// 集合结构的封装
+class Set {
+  constructor() {
+    this.items = {};
+  }
+
+  // has(value) 判断集合中是否存在 value 值，存在返回 true，否则返回 false
+  has(value) {
+    return this.items.hasOwnProperty(value);
+  }
+
+  // add(value) 往集合中添加 value
+  add(value) {
+    if (this.has(value)) return false;
+    this.items[value] = value;
+    return true;
+  }
+
+  // remove(value) 删除集合中指定的 value
+  remove(value) {
+    // 如果集合不存在该 value，返回 false
+    if (!this.has(value)) return false;
+    delete this.items[value];
+  }
+
+  // clear() 清空集合中所有 value
+  clear() {
+    this.items = {};
+  }
+
+  // size() 获取集合中的 value 个数
+  size() {
+    return Object.keys(this.items).length;
+  }
+
+  // values() 获取集合中所有的 value
+  values() {
+    return Object.keys(this.items);
+  }
+}
+```
+
+#### 代码测试
+
+```js
+const set = new Set();
+
+// add() 测试
+set.add("abc");
+set.add("abc");
+set.add("123");
+set.add("zxc");
+console.log(set); //--> {items: {123: "123", abc: "abc", zxc: "zxc"}}
+
+// has() 测试
+console.log(set.has("123")); //--> true
+console.log(set.has("456")); //--> false
+
+// remove() 测试
+set.remove("abc");
+console.log(set); //--> {items: {123: "123", zxc: "zxc"}}
+
+// size() 测试
+console.log(set.size()); //--> 2
+
+// values() 测试
+console.log(set.values()); //--> ["123", "zxc"]
+
+// clear() 测试
+set.clear();
+console.log(set.values()); //--> []
+```
+
+### 集合间的操作
+
+- 并集：对于给定的两个集合，返回一个包含两个集合中所有元素的新集合。
+- 交集：对于给定的两个集合，返回一个包含两个集合中共有元素的新集合。
+- 差集：对于给定的两个集合，返回一个包含所有存在于第一个集合且不存在于第二个集合的元素的新集合。
+- 子集：验证一个给定集合是否是另一个集合的子集。
+
+![](https://user-images.githubusercontent.com/24516169/88532735-b1069a00-d037-11ea-9ece-e19b2b8a09e2.png)
+
+#### 并集的实现
+
+```js
+// union() 求两个集合的并集
+union(otherSet) {
+    // 1、创建一个新集合
+    let unionSet = new Set();
+
+    // 2、将当前集合（this）的所有 value，添加到新集合（unionSet）中
+    for (let value of this.values()) {
+        unionSet.add(value);
+    }
+
+    // 3、将 otherSet 集合的所有 value，添加到新集合（unionSet）中
+    for (let value of otherSet.values()) {
+        unionSet.add(value); // add() 已经有重复判断
+    }
+
+    return unionSet;
+}
+```
+
+#### 交集的实现
+
+```js
+// intersection() 求两个集合的交集
+intersection(otherSet) {
+
+    // 1、创建一个新集合
+    let intersectionSet = new Set();
+
+    // 2、从当前集合中取出每一个 value，判断是否在 otherSet 集合中存在
+    for (let value of this.values()) {
+        if (otherSet.has(value)) {
+            intersectionSet.add(value);
+        }
+    }
+
+    return intersectionSet;
+}
+```
+
+#### 差集的实现
+
+```js
+// difference() 差集
+difference(otherSet) {
+
+    // 1、创建一个新集合
+    let differenceSet = new Set();
+
+    // 2、从当前集合中取出每一个 value，判断是否在 otherSet 集合中存在，不存在的即为差集
+    for (let value of this.values()) {
+        if (!otherSet.has(value)) {
+            differenceSet.add(value);
+        }
+    }
+
+    return differenceSet;
+}
+```
+
+#### 子集的实现
+
+```js
+// subset() 子集
+subset(otherSet) {
+
+    // 从当前集合中取出每一个 value，判断是否在 otherSet 集合中存在，有不存在的返回 false
+    // 遍历完所有的，返回 true
+    for (let value of this.values()) {
+        if (!otherSet.has(value)) {
+            return false;
+        }
+    }
+    return true;
+}
+```
+
+### 集合的完整实现
+
+```js
+// 集合结构的封装
+export default class Set {
+
+  constructor() {
+    this.items = {};
+  }
+
+  // has(value) 判断集合中是否存在 value 值，存在返回 true，否则返回 false
+  has(value) {
+    return this.items.hasOwnProperty(value);
+  }
+
+  // add(value) 往集合中添加 value
+  add(value) {
+    if (this.has(value)) return false;
+    this.items[value] = value;
+    return true;
+  }
+
+  // remove(value) 删除集合中指定的 value
+  remove(value) {
+    // 如果集合不存在该 value，返回 false
+    if (!this.has(value)) return false;
+    delete this.items[value];
+  }
+
+  // clear() 清空集合中所有 value
+  clear() {
+    this.items = {};
+  }
+
+  // size() 获取集合中的 value 个数
+  size() {
+    return Object.keys(this.items).length;
+  }
+
+  // values() 获取集合中所有的 value
+  values() {
+    return Object.keys(this.items);
+  }
+
+  // ------- 集合间的操作 ------- //
+  // union() 求两个集合的并集
+  union(otherSet) {
+    // 1、创建一个新集合
+    let unionSet = new Set();
+
+    // 2、将当前集合（this）的所有 value，添加到新集合（unionSet）中
+    for (let value of this.values()) {
+      unionSet.add(value);
+    }
+
+    // 3、将 otherSet 集合的所有 value，添加到新集合（unionSet）中
+    for (let value of otherSet.values()) {
+      unionSet.add(value); // add() 已经有重复判断
+    }
+
+    return unionSet;
+  }
+
+  // intersection() 求两个集合的交集
+  intersection(otherSet) {
+
+    // 1、创建一个新集合
+    let intersectionSet = new Set();
+
+    // 2、从当前集合中取出每一个 value，判断是否在 otherSet 集合中存在
+    for (let value of this.values()) {
+      if (otherSet.has(value)) {
+        intersectionSet.add(value);
+      }
+    }
+
+    return intersectionSet;
+  }
+
+  // difference() 差集
+  difference(otherSet) {
+
+    // 1、创建一个新集合
+    let differenceSet = new Set();
+
+    // 2、从当前集合中取出每一个 value，判断是否在 otherSet 集合中存在，不存在的即为差集
+    for (let value of this.values()) {
+      if (!otherSet.has(value)) {
+        differenceSet.add(value);
+      }
+    }
+
+    return differenceSet;
+  }
+
+  // subset() 子集
+  subset(otherSet) {
+
+    // 从当前集合中取出每一个 value，判断是否在 otherSet 集合中存在，有不存在的返回 false
+    // 遍历完所有的，返回 true
+    for (let value of this.values()) {
+      if (!otherSet.has(value)) {
+        return false;
+      }
+    }
+    return true;
+  }
+
+}
+```

src/Set/index.js

@@ -0,0 +1,59 @@
+import Set from './set';
+
+// ---------------- 封装的栈结构测试 ---------------- //
+console.log('// ----- 集合结构测试 START -----//');
+const set = new Set();
+
+// add() 测试
+set.add('abc');
+set.add('abc');
+set.add('123');
+set.add('zxc');
+console.log(set); //--> {items: {123: "123", abc: "abc", zxc: "zxc"}}
+
+// has() 测试
+console.log(set.has('123')); //--> true
+console.log(set.has('456')); //--> false
+
+// remove() 测试
+set.remove('abc');
+console.log(set); //--> {items: {123: "123", zxc: "zxc"}}
+
+// size() 测试
+console.log(set.size()); //--> 2
+
+// values() 测试
+console.log(set.values()); //--> ["123", "zxc"]
+
+// clear() 测试
+set.clear();
+console.log(set.values()); //--> []
+
+// ------- 集合的操作测试 ------- //
+const setA = new Set();
+setA.add('111');
+setA.add('222');
+setA.add('333');
+
+const setB = new Set();
+setB.add('111');
+setB.add('222');
+setB.add('aaa');
+setB.add('ccc');
+
+// 求两个集合的并集 union() 测试
+console.log(setA.union(setB).values()); //--> ["111", "222", "333", "aaa", "ccc"]
+
+// 求两个集合的交集 intersection() 测试
+console.log(setA.intersection(setB).values()); //--> ["111", "222"]
+
+// 求集合 A 和 集合 B，集合 A 的差集，difference() 测试
+console.log(setA.difference(setB).values()); //--> ["333"]
+
+// 求集合 A 是否为 集合 B 的 子集，subset() 测试
+console.log(setA.subset(setB)); //--> false
+
+
+console.log('// ----- 集合结构测试 END -----//');
+
+