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 - heap-implemented priority queue.
• Vector - protected array, cannot to operate properties like length directly.
• LinkList - linked list of non-contiguous memory addresses.
• Deque - double-ended-queue, O(1) time complexity to unshift or getting elements by index.
• OrderedSet - sorted set which implemented by red black tree.
• OrderedMap - sorted map which implemented by 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-sdsl

Or you can download the isolation packages containing only the containers you want:

package	npm	size	docs
@js-sdsl/stack			link
@js-sdsl/queue			link
@js-sdsl/priority-queue			link
@js-sdsl/vector			link
@js-sdsl/link-list			link
@js-sdsl/deque			link
@js-sdsl/ordered-set			link
@js-sdsl/ordered-map			link
@js-sdsl/hash-set			link
@js-sdsl/hash-map			link

🪒 Usage

You can visit our official website to get more information.

To help you have a better use, 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 frame to do unit tests and synchronize to coveralls. You can run yarn test:unit command to reproduce it.

For performance

We tested most of the functions for efficiency. 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 mode

Then 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:

🎫 License

MIT © ZLY201