5736571077f5ec98fb0961733ae869cb9e10464119d030d7afef5eda5db23a066e5dc08528abca2b0e6ba6a7a06e2020be3bc797e5f32999388141203d8e17 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. <p align="center">
  2. <a href="https://js-sdsl.org/" target="_blank" rel="noopener noreferrer">
  3. <img src="https://js-sdsl.org/assets/image/logo/logo-removebg.png" alt="js-sdsl logo" width="120" />
  4. </a>
  5. </p>
  6. <h3><p align="center">一款参考 C++ STL 实现的 JavaScript 标准数据结构库</p></h3>
  7. <p align="center">
  8. <a href="https://www.npmjs.com/package/js-sdsl"><img src="https://img.shields.io/npm/v/js-sdsl.svg" alt="NPM Version" /></a>
  9. <a href="https://github.com/js-sdsl/js-sdsl/actions/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/js-sdsl/js-sdsl/build.yml" alt="Build Status" /></a>
  10. <a href='https://coveralls.io/github/js-sdsl/js-sdsl?branch=main'><img src='https://coveralls.io/repos/github/js-sdsl/js-sdsl/badge.svg?branch=main' alt='Coverage Status' /></a>
  11. <a href="https://github.com/js-sdsl/js-sdsl"><img src="https://img.shields.io/github/stars/js-sdsl/js-sdsl.svg" alt="GITHUB Star" /></a>
  12. <a href="https://npmcharts.com/compare/js-sdsl?minimal=true"><img src="https://img.shields.io/npm/dm/js-sdsl.svg" alt="NPM Downloads" /></a>
  13. <a href="https://unpkg.com/js-sdsl/dist/umd/js-sdsl.min.js"><img src="https://img.badgesize.io/https://unpkg.com/js-sdsl/dist/umd/js-sdsl.min.js?compression=gzip&style=flat-square/" alt="Gzip Size"></a>
  14. <a href="https://openbase.com/js/js-sdsl?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge"><img src="https://badges.openbase.com/js/rating/js-sdsl.svg?token=fh3LMNOV+JSWykSjtg1rA8kouSYkJoIDzGbvaByq5X0=" alt="Rate this package"/></a>
  15. <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/js-sdsl.svg" alt="MIT-license" /></a>
  16. <a href="https://github.com/js-sdsl/js-sdsl/"><img src="https://img.shields.io/github/languages/top/js-sdsl/js-sdsl.svg" alt="GITHUB-language" /></a>
  17. </p>
  18. <p align="center"><a href="https://github.com/js-sdsl/js-sdsl/blob/main/README.md">English</a> | 简体中文</p>
  19. ## ✨ 包含的数据结构
  20. - **Stack** - 先进后出的堆栈
  21. - **Queue** - 先进先出的队列
  22. - **PriorityQueue** - 堆实现的优先级队列
  23. - **Vector** - 受保护的数组,不能直接操作像 `length` 这样的属性
  24. - **LinkList** - 非连续内存地址的链表
  25. - **Deque** - 双端队列,向前和向后插入元素或按索引获取元素的时间复杂度为 O(1)
  26. - **OrderedSet** - 由红黑树实现的排序集合
  27. - **OrderedMap** - 由红黑树实现的排序字典
  28. - **HashSet** - 参考 [ES6 Set polyfill](https://github.com/rousan/collections-es6) 实现的哈希集合
  29. - **HashMap** - 参考 [ES6 Set polyfill](https://github.com/rousan/collections-es6) 实现的哈希字典
  30. ## ⚔️ 基准测试
  31. 我们和其他数据结构库进行了基准测试,在某些场景我们甚至超过了当前最流行的库
  32. 查看 [benchmark](https://js-sdsl.org/#/zh-cn/test/benchmark-analyze) 以获取更多信息
  33. ## 🖥 支持的平台
  34. <table>
  35. <tr align="center">
  36. <td>
  37. <img alt="IE / Edge" src="https://js-sdsl.org/assets/image/platform/edge.png" />
  38. <div>IE / Edge</div>
  39. </td>
  40. <td>
  41. <img alt="Firefox" src="https://js-sdsl.org/assets/image/platform/firefox.png" />
  42. <div>Firefox</div>
  43. </td>
  44. <td>
  45. <img alt="Chrome" src="https://js-sdsl.org/assets/image/platform/chrome.png" />
  46. <div>Chrome</div>
  47. </td>
  48. <td>
  49. <img alt="Safari" src="https://js-sdsl.org/assets/image/platform/safari.png" />
  50. <div>Safari</div>
  51. </td>
  52. <td>
  53. <img alt="Opera" src="https://js-sdsl.org/assets/image/platform/opera.png" />
  54. <div>Opera</div>
  55. </td>
  56. <td>
  57. <img alt="NodeJs" src="https://js-sdsl.org/assets/image/platform/nodejs.png" />
  58. <div>NodeJs</div>
  59. </td>
  60. </tr>
  61. <tr align="center">
  62. <td>Edge 12</td>
  63. <td>31</td>
  64. <td>49</td>
  65. <td>10</td>
  66. <td>36</td>
  67. <td>10</td>
  68. </tr>
  69. </table>
  70. ## 📦 下载
  71. 使用 cdn 直接引入
  72. - [js-sdsl.js](https://unpkg.com/js-sdsl/dist/umd/js-sdsl.js) (for development)
  73. - [js-sdsl.min.js](https://unpkg.com/js-sdsl/dist/umd/js-sdsl.min.js) (for production)
  74. 使用 npm 下载
  75. ```bash
  76. npm install js-sdsl
  77. ```
  78. 或者根据需要安装以下任意单个包
  79. | package | npm | size | docs |
  80. |---------------------------------------------------|-----------------------------------------------------------------------|------------------------------------------------------------------|-----------------------------|
  81. | [@js-sdsl/stack][stack-package] | [![NPM Package][stack-npm-version]][stack-npm-link] | [![GZIP Size][stack-umd-size]][stack-umd-link] | [link][stack-docs] |
  82. | [@js-sdsl/queue][queue-package] | [![NPM Package][queue-npm-version]][queue-npm-link] | [![GZIP Size][queue-umd-size]][queue-umd-link] | [link][queue-docs] |
  83. | [@js-sdsl/priority-queue][priority-queue-package] | [![NPM Package][priority-queue-npm-version]][priority-queue-npm-link] | [![GZIP Size][priority-queue-umd-size]][priority-queue-umd-link] | [link][priority-queue-docs] |
  84. | [@js-sdsl/vector][vector-package] | [![NPM Package][vector-npm-version]][vector-npm-link] | [![GZIP Size][vector-umd-size]][vector-umd-link] | [link][vector-docs] |
  85. | [@js-sdsl/link-list][link-list-package] | [![NPM Package][link-list-npm-version]][link-list-npm-link] | [![GZIP Size][link-list-umd-size]][link-list-umd-link] | [link][link-list-docs] |
  86. | [@js-sdsl/deque][deque-package] | [![NPM Package][deque-npm-version]][deque-npm-link] | [![GZIP Size][deque-umd-size]][deque-umd-link] | [link][deque-docs] |
  87. | [@js-sdsl/ordered-set][ordered-set-package] | [![NPM Package][ordered-set-npm-version]][ordered-set-npm-link] | [![GZIP Size][ordered-set-umd-size]][ordered-set-umd-link] | [link][ordered-set-docs] |
  88. | [@js-sdsl/ordered-map][ordered-map-package] | [![NPM Package][ordered-map-npm-version]][ordered-map-npm-link] | [![GZIP Size][ordered-map-umd-size]][ordered-map-umd-link] | [link][ordered-map-docs] |
  89. | [@js-sdsl/hash-set][hash-set-package] | [![NPM Package][hash-set-npm-version]][hash-set-npm-link] | [![GZIP Size][hash-set-umd-size]][hash-set-umd-link] | [link][hash-set-docs] |
  90. | [@js-sdsl/hash-map][hash-map-package] | [![NPM Package][hash-map-npm-version]][hash-map-npm-link] | [![GZIP Size][hash-map-umd-size]][hash-map-umd-link] | [link][hash-map-docs] |
  91. ## 🪒 使用说明
  92. 您可以[访问我们的主页](https://js-sdsl.org/)获取更多信息
  93. 并且我们提供了完整的 [API 文档](https://js-sdsl.org/js-sdsl/index.html)供您参考
  94. 想要查看从前版本的文档,请访问:
  95. `https://js-sdsl.org/js-sdsl/previous/v${version}/index.html`
  96. 例如:
  97. [https://js-sdsl.org/js-sdsl/previous/v4.1.5/index.html](https://js-sdsl.org/js-sdsl/previous/v4.1.5/index.html)
  98. ### 在浏览器中使用
  99. ```html
  100. <script src="https://unpkg.com/js-sdsl/dist/umd/js-sdsl.min.js"></script>
  101. <script>
  102. const {
  103. Vector,
  104. Stack,
  105. Queue,
  106. LinkList,
  107. Deque,
  108. PriorityQueue,
  109. OrderedSet,
  110. OrderedMap,
  111. HashSet,
  112. HashMap
  113. } = sdsl;
  114. const myOrderedMap = new OrderedMap();
  115. myOrderedMap.setElement(1, 2);
  116. console.log(myOrderedMap.getElementByKey(1)); // 2
  117. </script>
  118. ```
  119. ### npm 引入
  120. ```javascript
  121. // esModule
  122. import { OrderedMap } from 'js-sdsl';
  123. // commonJs
  124. const { OrderedMap } = require('js-sdsl');
  125. const myOrderedMap = new OrderedMap();
  126. myOrderedMap.setElement(1, 2);
  127. console.log(myOrderedMap.getElementByKey(1)); // 2
  128. ```
  129. ## 🛠 测试
  130. ### 单元测试
  131. 我们使用 [karma](https://karma-runner.github.io/) 和 [mocha](https://mochajs.org/) 框架进行单元测试,并同步到 [coveralls](https://coveralls.io/github/js-sdsl/js-sdsl) 上,你可以使用 `yarn test:unit` 命令来重建它
  132. ### 对于性能的校验
  133. 我们对于编写的所有 API 进行了性能测试,并将结果同步到了 [`gh-pages/performance.md`](https://github.com/js-sdsl/js-sdsl/blob/gh-pages/performance.md) 中,你可以通过 `yarn test:performance` 命令来重现它
  134. 您也可以访问[我们的网站](https://js-sdsl.org/#/zh-cn/test/performance-test)来获取结果
  135. ## ⌨️ 开发
  136. 可以使用 Gitpod 进行在线编辑:
  137. [![Open in Gippod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/js-sdsl/js-sdsl)
  138. 或者在本地使用以下命令获取源码进行开发:
  139. ```bash
  140. $ git clone https://github.com/js-sdsl/js-sdsl.git
  141. $ cd js-sdsl
  142. $ npm install
  143. $ npm run dev # development mode
  144. ```
  145. 之后您在 `dist/cjs` 文件夹中可以看到在 `dev` 模式下打包生成的产物
  146. ## 🤝 贡献
  147. 我们欢迎所有的开发人员提交 issue 或 pull request,阅读[贡献者指南](https://github.com/js-sdsl/js-sdsl/blob/main/.github/CONTRIBUTING.md)可能会有所帮助
  148. ### 贡献者
  149. 感谢对本项目做出贡献的开发者们:
  150. <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
  151. <!-- prettier-ignore-start -->
  152. <!-- markdownlint-disable -->
  153. <table>
  154. <tbody>
  155. <tr>
  156. <td align="center"><a href="https://www.linkedin.com/in/takatoshi-kondo-02a91410/"><img src="https://avatars.githubusercontent.com/u/275959?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Takatoshi Kondo</b></sub></a><br /><a href="https://github.com/js-sdsl/js-sdsl/commits?author=redboltz" title="Code">💻</a> <a href="https://github.com/js-sdsl/js-sdsl/commits?author=redboltz" title="Tests">⚠️</a></td>
  157. <td align="center"><a href="https://www.youtube.com/c/noname0310"><img src="https://avatars.githubusercontent.com/u/48761044?v=4?s=100" width="100px;" alt=""/><br /><sub><b>noname</b></sub></a><br /><a href="https://github.com/js-sdsl/js-sdsl/commits?author=noname0310" title="Code">💻</a></td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <!-- markdownlint-restore -->
  162. <!-- prettier-ignore-end -->
  163. <!-- ALL-CONTRIBUTORS-LIST:END -->
  164. 本项目遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范。 欢迎任何形式的贡献!
  165. ## ❤️ 赞助者
  166. 特别鸣谢下列赞助商和支持者们,他们在非常早期的时候为我们提供了支持:
  167. <a href="https://eslint.org/"><img src="https://js-sdsl.org/assets/image/sponsors/eslint-logo-color.png" alt="eslint logo" width="150"></a>
  168. 同样感谢这些赞助商和支持者们:
  169. [![sponsors](https://opencollective.com/js-sdsl/tiers/sponsors.svg?avatarHeight=36)](https://opencollective.com/js-sdsl#support)
  170. [![backers](https://opencollective.com/js-sdsl/tiers/backers.svg?avatarHeight=36)](https://opencollective.com/js-sdsl#support)
  171. ## 🪪 许可证
  172. [MIT](https://github.com/js-sdsl/js-sdsl/blob/main/LICENSE) © [ZLY201](https://github.com/zly201)
  173. [stack-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/OtherContainer/Stack.ts
  174. [stack-npm-version]: https://img.shields.io/npm/v/@js-sdsl/stack
  175. [stack-npm-link]: https://www.npmjs.com/package/@js-sdsl/stack
  176. [stack-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/stack/dist/umd/stack.min.js?compression=gzip&style=flat-square/
  177. [stack-umd-link]: https://unpkg.com/@js-sdsl/stack/dist/umd/stack.min.js
  178. [stack-docs]: https://js-sdsl.org/js-sdsl/classes/Stack.html
  179. [queue-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/OtherContainer/Queue.ts
  180. [queue-npm-version]: https://img.shields.io/npm/v/@js-sdsl/queue
  181. [queue-npm-link]: https://www.npmjs.com/package/@js-sdsl/queue
  182. [queue-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/queue/dist/umd/queue.min.js?compression=gzip&style=flat-square/
  183. [queue-umd-link]: https://unpkg.com/@js-sdsl/queue/dist/umd/queue.min.js
  184. [queue-docs]: https://js-sdsl.org/js-sdsl/classes/Queue.html
  185. [priority-queue-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/OtherContainer/PriorityQueue.ts
  186. [priority-queue-npm-version]: https://img.shields.io/npm/v/@js-sdsl/priority-queue
  187. [priority-queue-npm-link]: https://www.npmjs.com/package/@js-sdsl/priority-queue
  188. [priority-queue-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/priority-queue/dist/umd/priority-queue.min.js?compression=gzip&style=flat-square/
  189. [priority-queue-umd-link]: https://unpkg.com/@js-sdsl/priority-queue/dist/umd/priority-queue.min.js
  190. [priority-queue-docs]: https://js-sdsl.org/js-sdsl/classes/PriorityQueue.html
  191. [vector-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/SequentialContainer/Vector.ts
  192. [vector-npm-version]: https://img.shields.io/npm/v/@js-sdsl/vector
  193. [vector-npm-link]: https://www.npmjs.com/package/@js-sdsl/vector
  194. [vector-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/vector/dist/umd/vector.min.js?compression=gzip&style=flat-square/
  195. [vector-umd-link]: https://unpkg.com/@js-sdsl/vector/dist/umd/vector.min.js
  196. [vector-docs]: https://js-sdsl.org/js-sdsl/classes/Vector.html
  197. [link-list-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/SequentialContainer/LinkList.ts
  198. [link-list-npm-version]: https://img.shields.io/npm/v/@js-sdsl/link-list
  199. [link-list-npm-link]: https://www.npmjs.com/package/@js-sdsl/link-list
  200. [link-list-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/link-list/dist/umd/link-list.min.js?compression=gzip&style=flat-square/
  201. [link-list-umd-link]: https://unpkg.com/@js-sdsl/link-list/dist/umd/link-list.min.js
  202. [link-list-docs]: https://js-sdsl.org/js-sdsl/classes/LinkList.html
  203. [deque-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/SequentialContainer/Deque.ts
  204. [deque-npm-version]: https://img.shields.io/npm/v/@js-sdsl/deque
  205. [deque-npm-link]: https://www.npmjs.com/package/@js-sdsl/deque
  206. [deque-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/deque/dist/umd/deque.min.js?compression=gzip&style=flat-square/
  207. [deque-umd-link]: https://unpkg.com/@js-sdsl/deque/dist/umd/deque.min.js
  208. [deque-docs]: https://js-sdsl.org/js-sdsl/classes/Deque.html
  209. [ordered-set-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/TreeContainer/OrderedSet.ts
  210. [ordered-set-npm-version]: https://img.shields.io/npm/v/@js-sdsl/ordered-set
  211. [ordered-set-npm-link]: https://www.npmjs.com/package/@js-sdsl/ordered-set
  212. [ordered-set-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/ordered-set/dist/umd/ordered-set.min.js?compression=gzip&style=flat-square/
  213. [ordered-set-umd-link]: https://unpkg.com/@js-sdsl/ordered-set/dist/umd/ordered-set.min.js
  214. [ordered-set-docs]: https://js-sdsl.org/js-sdsl/classes/OrderedSet.html
  215. [ordered-map-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/TreeContainer/OrderedMap.ts
  216. [ordered-map-npm-version]: https://img.shields.io/npm/v/@js-sdsl/ordered-map
  217. [ordered-map-npm-link]: https://www.npmjs.com/package/@js-sdsl/ordered-map
  218. [ordered-map-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/ordered-map/dist/umd/ordered-map.min.js?compression=gzip&style=flat-square/
  219. [ordered-map-umd-link]: https://unpkg.com/@js-sdsl/ordered-map/dist/umd/ordered-map.min.js
  220. [ordered-map-docs]: https://js-sdsl.org/js-sdsl/classes/OrderedMap.html
  221. [hash-set-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/HashContainer/HashSet.ts
  222. [hash-set-npm-version]: https://img.shields.io/npm/v/@js-sdsl/hash-set
  223. [hash-set-npm-link]: https://www.npmjs.com/package/@js-sdsl/hash-set
  224. [hash-set-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/hash-set/dist/umd/hash-set.min.js?compression=gzip&style=flat-square/
  225. [hash-set-umd-link]: https://unpkg.com/@js-sdsl/hash-set/dist/umd/hash-set.min.js
  226. [hash-set-docs]: https://js-sdsl.org/js-sdsl/classes/HashSet.html
  227. [hash-map-package]: https://github.com/js-sdsl/js-sdsl/blob/main/src/container/HashContainer/HashMap.ts
  228. [hash-map-npm-version]: https://img.shields.io/npm/v/@js-sdsl/hash-map
  229. [hash-map-npm-link]: https://www.npmjs.com/package/@js-sdsl/hash-map
  230. [hash-map-umd-size]: https://img.badgesize.io/https://unpkg.com/@js-sdsl/hash-map/dist/umd/hash-map.min.js?compression=gzip&style=flat-square/
  231. [hash-map-umd-link]: https://unpkg.com/@js-sdsl/hash-map/dist/umd/hash-map.min.js
  232. [hash-map-docs]: https://js-sdsl.org/js-sdsl/classes/HashMap.html