@raikuxq/alg-ds 1.1.3 → 1.1.6

package/README.md

@@ -2,7 +2,32 @@ Common algorithms and data structures.
 
 Written in TypeScript, tested with Jest.
 
-# Getting started
+
+# Usage as package
+Install by using any of these commands:
++ `yarn add @raikuxq/alg-ds`
++ `npm install @raikuxq/alg-ds --save`
+
+## Import from root
+`import { <anything> } from '@raikuxq/alg-ds'`
+
+## Import from sub-paths
+### Data structures
+`import {Stack, Queue, SingleLinkedList, DoubleLinkedList, RandBinarySearchTree, BinarySearchTree, DirectedGraph, UndirectedGraph, LoopedArray, HashTable, } from '@raikuxq/alg-ds/lib/exports/data-structures'`
+### Sorting algorithms
+`import {bubbleSort, insertionSort, mergeSort, selectSort, quickSort} from '@raikuxq/alg-ds/lib/exports/data-structures `
+### Other algorithms
+`import {binarySearch, factorial, memoizedFactorial, memoizedFibonacci, fibonacci, transposeMatrix, GraphIteratorDFS, presenterAdjacencyLists, presenterAdjacencyMatrix, hasPath, shortestPath, DijkstraIterationStrategy, DFSIterationStrategy, BFSIterationStrategy, GraphIteratorBFS, GraphIteratorDijkstra, transposeDirectedGraph} from '@raikuxq/alg-ds/lib/exports/algorithms'`
+### Helpers
+`import {createGraph, createGraphFromMatrix, createBinaryTree, createLinkedList, generateRandomGraph} from '@raikuxq/alg-ds/lib/exports/helpers`
+### Utils
+`import {perf, getMinIndex, getMinIndexFromIndex, memoize, perfAsync, roundNumber, randomizeNumberInRange, swapArrayItems} from '@raikuxq/alg-ds/lib/exports/utils'`
+### Constants
+`import {EDGE_NOT_EXISTS_STATE, EDGE_EXISTS_STATE} from '@raikuxq/alg-ds/lib/exports/constants'`
+
+
+
+# Usage as repository
 
 Clone this repository and install dependencies by using `yarn` command.
 
@@ -19,11 +44,9 @@ Clone this repository and install dependencies by using `yarn` command.
 + `yarn lint:fix` - fix source files via eslint
 
 
-
 # Navigation
 + [Algorithms](#algorithms)
   + [Sorting algorithms](#sorting-algorithms)
-+ [Iterators](#iterators)
 + [Linear data structures](#linear-data-structures)
   + [Linked list](#linked-list)
   + [Looped array](#looped-array)
@@ -63,19 +86,6 @@ Clone this repository and install dependencies by using `yarn` command.
 
 
 
-# Iterators
-
-### Interfaces
-[IIterable](src/types/IIterable.ts) — Allows to create an iterator instance.
-
-[IBiDirectIterable](src/types/IBiDirectIterable.ts) — Allows to create a bi-direct iterator instance. 
-Extends [IIterable](src/types/IIterable.ts) interface.
-
-[IIterator](src/types/IIterator.ts) — Allows only next navigation.
-
-[IBiDirectIterator](src/types/IBiDirectIterator.ts) — Allows both next and prev navigation. 
-Extends [IIterator](src/types/IIterator.ts) interface.
-
 
 # Linear data structures
 

package/package.json

@@ -12,8 +12,8 @@
     "type": "git",
     "url": "https://github.com/raikuxq/lab-ts-algorithms"
   },
-  "main": "./src/exports.js",
-  "types": "./src/exports.d.ts",
+  "main": "./lib/exports.js",
+  "types": "./lib/exports.d.ts",
   "files": [
     "lib",
     "README.md",
@@ -38,5 +38,5 @@
     "typescript": "^4.0.3"
   },
   "dependencies": {},
-  "version": "1.1.3"
+  "version": "1.1.6"
 }