README.md



A javascript standard data structure library which benchmark against C++ STL


English | 简体中文


Included data structures


Vector
Stack
Queue
LinkList
Deque
PriorityQueue
OrderedSet (using RBTree)
OrderedMap (using RBTree)
HashSet
HashMap


Benchmark

We are benchmarking against other popular data structure libraries. In some ways we're better than the best library. See benchmark.


Supported platforms


node.js (using es6)
react/vue (using es5)
browser (support most browsers)


Download

Download directly


js-sdsl.js (for development)

js-sdsl.min.js (for production)


Or install js-sdsl using npm

npm install js-sdsl


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


Build by source code

You can pull this repository and run yarn build to rebuild this library.


Test


Unit test

We use jest library to write unit tests, you can see test coverage on 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.


Maintainers

@ZLY201


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:


_{Takatoshi Kondo}
💻 ⚠️

      
_noname
💻

    
This project follows the all-contributors specification. Contributions of any kind welcome!


License

MIT © ZLY201