js-sdsl
A javascript standard data structure library which benchmark against C++ STL
English | 简体中文
✨ Included data structures
- Stack - First-in, last-out stack.
- Queue - First-in, first-out queue.
- PriorityQueue - Priority queue implemented using heap.
- Vector - Protected array, cannot directly operate on properties like
length. - LinkedList - Linked list using non-contiguous memory addresses.
- Deque - Double-ended queue, O(1) time complexity to
unshiftor getting elements by index. - OrderedSet - Sorted set implemented using red black tree.
- OrderedMap - Sorted map implemented using red black tree.
- HashSet - Refer to the polyfill of ES6 Set.
- HashMap - Refer to the polyfill of ES6 Map.
⚔️ Benchmark
We are benchmarking against other popular data structure libraries. In some ways we're better than the best library. See Benchmark.
🖥 Supported platforms
 IE / Edge |
 Firefox |
 Chrome |
 Safari |
 Opera |
 NodeJs |
|---|---|---|---|---|---|
| Edge 12 | 36 | 49 | 10 | 36 | 10 |
📦 Download
Download directly by cdn:
- js-sdsl.js (for development)
- js-sdsl.min.js (for production)
Or install js-sdsl using npm:
npm install js-sdslOr you can download the isolation packages containing only the containers you want:
🪒 Usage
You can visit our official website to get more information.
To help you use the library more effectively, we also provide this API document.
For previous versions of the documentation, please visit:
https://js-sdsl.org/js-sdsl/previous/v${version}/index.html
E.g.
https://js-sdsl.org/js-sdsl/previous/v4.1.5/index.html
For browser
<script src="https://unpkg.com/js-sdsl/dist/umd/js-sdsl.min.js"></script>
<script>
const {
Vector,
Stack,
Queue,
LinkList,
Deque,
PriorityQueue,
OrderedSet,
OrderedMap,
HashSet,
HashMap
} = sdsl;
const myOrderedMap = new OrderedMap();
myOrderedMap.setElement(1, 2);
console.log(myOrderedMap.getElementByKey(1)); // 2
</script>For npm
// esModule
import { OrderedMap } from 'js-sdsl';
// commonJs
const { OrderedMap } = require('js-sdsl');
const myOrderedMap = new OrderedMap();
myOrderedMap.setElement(1, 2);
console.log(myOrderedMap.getElementByKey(1)); // 2🛠 Test
Unit test
We use Karma and Mocha to run unit tests and synchronize coverage to Coveralls. You can run yarn test:unit command to reproduce it.
For performance
We benchmark most functions for performance. You can go to gh-pages/performance.md to see our running results or reproduce it with yarn test:performance command.
You can also visit here to get the result.
⌨️ Development
Use Gitpod, a free online dev environment for GitHub.
Or clone locally:
$ git clone https://github.com/js-sdsl/js-sdsl.git
$ cd js-sdsl
$ npm install
$ npm run dev # development modeThen you can see the output in dist/cjs folder.
🤝 Contributing
Feel free to dive in! Open an issue or submit PRs. It may be helpful to read the Contributor Guide.
Contributors
Thanks goes to these wonderful people:
This project follows the all-contributors specification. Contributions of any kind welcome!
❤️ Sponsors and Backers
The special thanks to these sponsors or backers because they provided support at a very early stage:
Thanks also give to these sponsors or backers:
