Initial commit

IPRIT · IPRIT · commit 5e633e169ece · 2019-10-22T01:42:34.000+03:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Example Contributing Guidelines
+
+This is an example of GitHub's contributing guidelines file. Check out GitHub's [CONTRIBUTING.md help center article](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) for more information.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,11 @@
+* **I'm submitting a ...**
+[ ] bug report
+[ ] feature request
+[ ] question about the decisions made in the repository
+[ ] question about how to use this project
+
+* **Summary**
+
+
+
+* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
+
+
+
+* **What is the current behavior?** (You can also link to an open issue here)
+
+
+
+* **What is the new behavior (if this is a feature change)?**
+
+
+
+* **Other information**:
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,11 @@
+node_modules
+build
+test
+src/**.js
+.idea/*
+
+coverage
+.nyc_output
+*.log
+
+package-lock.json
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,15 @@
+src
+test
+tsconfig.json
+tsconfig.module.json
+tslint.json
+.travis.yml
+.github
+.prettierignore
+.vscode
+build/docs
+**/*.spec.*
+coverage
+.nyc_output
+.idea
+*.log
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+# package.json is formatted by package managers, so we ignore it here
+package.json
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Alexander Belov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# @algo-js/priority-queue
+
+Fast heap-based priority queue for production
diff --git a/package.json b/package.json
@@ -0,0 +1,96 @@
+{
+  "name": "@algo-js/priority-queue",
+  "version": "1.0.0",
+  "description": "Fast heap-based priority queue for production",
+  "main": "build/main/index.js",
+  "typings": "build/main/index.d.ts",
+  "module": "build/module/index.js",
+  "repository": "https://github.com/IPRIT/algo-js/priority-queue",
+  "license": "MIT",
+  "keywords": [],
+  "scripts": {
+    "describe": "npm-scripts-info",
+    "build": "run-s clean && run-p build:*",
+    "build:main": "tsc -p tsconfig.json",
+    "build:module": "tsc -p tsconfig.module.json",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "fix:tslint": "tslint --fix --project .",
+    "test": "run-s build test:*",
+    "test:lint": "tslint --project . && prettier \"src/**/*.ts\" --list-different",
+    "test:unit": "nyc --silent ava",
+    "watch": "run-s clean build:main && run-p \"build:main -- -w\" \"test:unit -- --watch\"",
+    "cov": "run-s build test:unit cov:html && open-cli coverage/index.html",
+    "cov:html": "nyc report --reporter=html",
+    "cov:send": "nyc report --reporter=lcov && codecov",
+    "cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
+    "doc": "run-s doc:html && open-cli build/docs/index.html",
+    "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
+    "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
+    "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
+    "version": "standard-version",
+    "clean": "trash build test",
+    "prepare-release": "run-s test cov:check doc:html version doc:publish",
+    "preinstall": "node -e \"if(process.env.npm_execpath.indexOf('yarn') === -1) console.warn('@algo-js/core must be installed with Yarn: https://yarnpkg.com/')\""
+  },
+  "scripts-info": {
+    "info": "Display information about the package scripts",
+    "build": "Clean and rebuild the project",
+    "fix": "Try to automatically fix any linting problems",
+    "test": "Lint and unit test the project",
+    "watch": "Watch and rebuild the project on save, then rerun relevant tests",
+    "cov": "Rebuild, run tests, then create and open the coverage report",
+    "doc": "Generate HTML API documentation and open it in a browser",
+    "doc:json": "Generate API documentation in typedoc JSON format",
+    "version": "Bump package.json version, update CHANGELOG.md, tag release",
+    "prepare-release": "One-step: clean, build, test, publish docs, and prep a release"
+  },
+  "engines": {
+    "node": ">=8.9"
+  },
+  "dependencies": {
+    "@algo-js/heap-tree": "^1.1.4"
+  },
+  "devDependencies": {
+    "@bitjson/npm-scripts-info": "^1.0.0",
+    "@bitjson/typedoc": "^0.15.0-0",
+    "@istanbuljs/nyc-config-typescript": "^0.1.3",
+    "ava": "2.2.0",
+    "codecov": "^3.5.0",
+    "cz-conventional-changelog": "^2.1.0",
+    "gh-pages": "^2.0.1",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^14.1.1",
+    "open-cli": "^5.0.0",
+    "prettier": "^1.18.2",
+    "standard-version": "^6.0.1",
+    "trash-cli": "^3.0.0",
+    "tslint": "^5.18.0",
+    "tslint-config-prettier": "^1.18.0",
+    "tslint-immutable": "^6.0.1",
+    "typescript": "^3.5.3"
+  },
+  "ava": {
+    "failFast": true,
+    "files": [
+      "build/main/**/*.spec.js"
+    ],
+    "sources": [
+      "build/main/**/*.js"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "nyc": {
+    "extends": "@istanbuljs/nyc-config-typescript",
+    "exclude": [
+      "**/*.spec.js"
+    ]
+  }
+}
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1 @@
+export * from './lib';
diff --git a/src/lib/index.ts b/src/lib/index.ts
@@ -0,0 +1 @@
+export * from './priority-queue/priority-queue';
diff --git a/src/lib/priority-queue/priority-queue.spec.ts b/src/lib/priority-queue/priority-queue.spec.ts
@@ -0,0 +1,50 @@
+import test from 'ava';
+import { PriorityQueue } from './priority-queue';
+
+interface Item {
+  id: number;
+}
+
+test('queue/dequeue', t => {
+  const queue = new PriorityQueue<Item>();
+
+  queue.queue({ id: 1 }, 2);
+  queue.queue({ id: 2 }, 20);
+  queue.queue({ id: 3 }, 3);
+  queue.queue({ id: 4 }, 5);
+
+  t.deepEqual(queue.peek(), { id: 2 });
+  t.deepEqual(queue.dequeue(), { id: 2 });
+  t.deepEqual(queue.dequeue(), { id: 4 });
+  t.deepEqual(queue.dequeue(), { id: 3 });
+  t.deepEqual(queue.dequeue(), { id: 1 });
+
+  t.deepEqual(queue.peek(), null);
+  t.deepEqual(queue.dequeue(), null);
+});
+
+test('size', t => {
+  const queue = new PriorityQueue<Item>();
+
+  queue.queue({ id: 1 }, 2);
+  queue.queue({ id: 2 }, 20);
+  queue.queue({ id: 3 }, 3);
+  queue.queue({ id: 4 }, 5);
+
+  t.is(queue.size, 4);
+
+  queue.peek();
+  t.is(queue.size, 4);
+
+  queue.dequeue();
+  t.is(queue.size, 3);
+  queue.dequeue();
+  t.is(queue.size, 2);
+  queue.dequeue();
+  t.is(queue.size, 1);
+
+  queue.dequeue();
+  t.is(queue.size, 0);
+  queue.dequeue();
+  t.is(queue.size, 0);
+});
diff --git a/src/lib/priority-queue/priority-queue.ts b/src/lib/priority-queue/priority-queue.ts
@@ -0,0 +1,85 @@
+import { MaxHeapTree } from '@algo-js/heap-tree';
+
+export interface Queue<T> {
+  queue: (item: T, priority: number) => this;
+  dequeue: () => T;
+
+  readonly size: number;
+}
+
+export class PriorityQueue<T> extends MaxHeapTree<T> implements Queue<T> {
+  /**
+   * @returns {number}
+   */
+  get size(): number {
+    return this.heap.length;
+  }
+  public static defaultPriority = 1;
+
+  /**
+   * @param {Map} priorities
+   * @param {*} a
+   * @param {*} b
+   * @returns {number}
+   */
+  public static priorityCompareFn<T>(
+    priorities: Map<T, number>,
+    a: T,
+    b: T
+  ): number {
+    const pa = priorities.get(a);
+    const pb = priorities.get(b);
+    return pa === pb ? 0 : pa < pb ? -1 : 1;
+  }
+
+  private priorities: Map<T, number>;
+
+  constructor() {
+    const priorities = new Map<T, number>();
+    const compareFn = PriorityQueue.priorityCompareFn.bind(null, priorities);
+
+    super(compareFn);
+
+    this.priorities = priorities;
+  }
+
+  /**
+   * @param {*} element
+   * @param {number} priority
+   * @returns {PriorityQueue}
+   */
+  public queue(
+    element: T,
+    priority: number = PriorityQueue.defaultPriority
+  ): this {
+    if (this.priorities.has(element)) {
+      throw new Error('Cannot add element that already exist');
+    }
+
+    this.priorities.set(element, priority);
+    super.add(element);
+
+    return this;
+  }
+
+  /**
+   * @returns {*}
+   */
+  public dequeue(): T {
+    const element = super.poll();
+
+    if (element) {
+      this.priorities.delete(element);
+    }
+
+    return element;
+  }
+
+  public add(element: T): this {
+    throw new Error('Use `queue` method instead');
+  }
+
+  public poll(): T {
+    throw new Error('Use `dequeue` method instead');
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,45 @@
+{
+  "compilerOptions": {
+    "target": "es2017",
+    "outDir": "build/main",
+    "rootDir": "src",
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "declaration": true,
+    "inlineSourceMap": true,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+
+    // "strict": true /* Enable all strict type-checking options. */,
+
+    /* Strict Type-Checking Options */
+    // "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    // "strictNullChecks": true /* Enable strict null checks. */,
+    // "strictFunctionTypes": true /* Enable strict checking of function types. */,
+    // "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
+    // "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
+    // "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
+
+    /* Additional Checks */
+    "noUnusedLocals": false /* Report errors on unused locals. */,
+    "noUnusedParameters": false /* Report errors on unused parameters. */,
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
+    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
+
+    /* Debugging Options */
+    "traceResolution": false /* Report module resolution log messages. */,
+    "listEmittedFiles": false /* Print names of generated files part of the compilation. */,
+    "listFiles": false /* Print names of files part of the compilation. */,
+    "pretty": true /* Stylize errors and messages using color and context. */,
+
+    /* Experimental Options */
+    // "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
+    // "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */,
+
+    "lib": ["es2017"],
+    "types": ["node"],
+    "typeRoots": ["node_modules/@types", "src/types"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules/**"],
+  "compileOnSave": false
+}
diff --git a/tsconfig.module.json b/tsconfig.module.json
diff --git a/tslint.json b/tslint.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Example Contributing Guidelines`
	`2`	`+`
	`3`	`+This is an example of GitHub's contributing guidelines file. Check out GitHub's [CONTRIBUTING.md help center article](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) for more information.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# package.json is formatted by package managers, so we ignore it here`
	`2`	`+package.json`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# @algo-js/priority-queue`
	`2`	`+`
	`3`	`+Fast heap-based priority queue for production`