Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sakura90/sorted-array-operations
A JavaScript library of sorted array operations
https://github.com/sakura90/sorted-array-operations
binary-search bisection-method cdn commonjs-module difference es-module intersection javascript lower-bound merge npm sorted-array symmetric-difference typescript union upper-bound yarn
Last synced: 3 months ago
JSON representation
A JavaScript library of sorted array operations
- Host: GitHub
- URL: https://github.com/sakura90/sorted-array-operations
- Owner: sakura90
- License: apache-2.0
- Created: 2021-08-15T16:16:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-19T23:46:24.000Z (over 3 years ago)
- Last Synced: 2024-04-26T07:45:22.558Z (9 months ago)
- Topics: binary-search, bisection-method, cdn, commonjs-module, difference, es-module, intersection, javascript, lower-bound, merge, npm, sorted-array, symmetric-difference, typescript, union, upper-bound, yarn
- Language: TypeScript
- Homepage:
- Size: 67.4 KB
- Stars: 37
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Sorted Array Operations
Sorted array operation module that has a broad operation coverage.
## Overview
Existing libraries cover non-standard operations or cover the operations partially on sorted arrays.
This library is created to provide a wide range of operations on sorted arrays found in the standard libraries
of major programming languages so that developers can get almost all (if not all) standard operations on sorted arrays in a library.
This library features:
* Language: Supports both JavaScript and TypeScript
* Module: Includes both CommonJS module and ES module
## Installation
Yarn & npm
```
$ yarn add sorted-array-operations
$ npm install sorted-array-operations
```
CDN
```
```
## Usage of all library functions
```js
const ops = require('sorted-array-operations');
console.log(ops.union([2, 3, 5, 6], [2, 6, 8])); // [ 2, 3, 5, 6, 8 ]
console.log(ops.intersection([2, 3, 5, 6], [2, 6, 8])); // [ 2 ]
console.log(ops.difference([2, 3, 5, 6], [2, 6, 8])); // [ 3, 5 ]
console.log(ops.symmetric_difference([2, 3, 5, 6], [2, 6, 8])); // [ 3, 5, 8 ]
console.log(ops.merge([2, 3, 5, 6], [2, 6, 8])); // [ 2, 2, 3, 5, 6, 6, 8 ]
const arr1 = [2, 5, 3];
console.log(ops.inplace_merge(arr1, 2)); // arr1 becomes [ 2, 3, 5 ]
console.log(ops.includes([2, 3, 5, 6], [2, 6, 8])); // false
const arr2 = [2, 3, 5, 6];
console.log(ops.insert(arr2, 2)); // arr2 becomes [ 2, 2, 3, 5, 6 ]
const arr3 = [2, 3, 5, 6];
console.log(ops.remove(arr3, 2)); // Return true. arr3 becomes [ 3, 5, 6 ]
console.log(ops.binary_search([2, 3, 5, 6], 2)); // Return 0
console.log(ops.binary_search_ge([2, 3, 5, 6], 2)); // Return 0
console.log(ops.binary_search_gt([2, 3, 5, 6], 2)); // Return 1
console.log(ops.equal_range([2, 3, 5, 6], 2)); // Return [ 0, 1 ]
function weight_cmp(p1, p2) {
return p1.weight > p2.weight ? 1 : p1.weight < p2.weight ? -1 : 0;
}
console.log(ops.union([{weight: 2}, {weight: 3}], [{weight: 3}], weight_cmp)); // [ {weight: 2}, {weight: 3} ]
console.log(ops.intersection([{weight: 2}, {weight: 3}], [{weight: 3}], weight_cmp)); // [ {weight: 3} ]
console.log(ops.difference([{weight: 2}, {weight: 3}], [{weight: 3}], weight_cmp)); // [ {weight: 2} ]
console.log(ops.symmetric_difference([{weight: 2}, {weight: 3}], [{weight: 3},{weight: 4}], weight_cmp)); // [ {weight: 2}, {weight: 4} ]
console.log(ops.merge([{weight: 2}, {weight: 3}], [{weight: 3}], weight_cmp)); // [ {weight: 2}, {weight: 3}, {weight: 3} ]
const arr4 = [{weight: 3}, {weight: 1}];
console.log(ops.inplace_merge(arr4, 1, weight_cmp)); // arr4 becomes [ {weight: 1}, {weight: 3} ]
console.log(ops.includes([{weight: 2}, {weight: 3}], [{weight: 3}], weight_cmp)); // true
const arr5 = [{weight: 3}];
console.log(ops.insert(arr5, {weight: 2}, weight_cmp)); // arr5 becomes [ {weight: 2}, {weight: 3} ]
const arr6 = [{weight: 3}];
console.log(ops.remove(arr6, {weight: 3}, weight_cmp)); // Return true. arr6 becomes [ ]
console.log(ops.binary_search([{weight: 2}, {weight: 3}], {weight: 2}, weight_cmp)); // Return 0
console.log(ops.binary_search_ge([{weight: 2}, {weight: 3}], {weight: 2}, weight_cmp)); // Return 0
console.log(ops.binary_search_gt([{weight: 2}, {weight: 3}], {weight: 2}, weight_cmp)); // Return 1
console.log(ops.equal_range([{weight: 2}, {weight: 3}], {weight: 2}, weight_cmp)); // Return [ 0, 1 ]
```
## Related libraries
The library most similar to this library is [sorted-array-functions](https://www.npmjs.com/package/sorted-array-functions).
This library has the set operations on sorted arrays and follows the way of implementing `lower_bound` and `upper_bound`
in the standard libraries in C++ and Python. These 2 differences are the major differences between this library and
[sorted-array-functions](https://www.npmjs.com/package/sorted-array-functions).
Other related libraries can be found in Google search.
## Contributing
The sorted array operation library welcomes patches/pulls for features and bug fixes. Please open an issue and send a PR request!