forked from SiZapPaaiGwat/javascript-algorithms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
155 lines (118 loc) · 13.4 KB
/
Copy pathindex.html
File metadata and controls
155 lines (118 loc) · 13.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><h2>About</h2><p><img src="https://travis-ci.org/mgechev/javascript-algorithms.svg?branch=master" alt=""></p>
<p>This repository contains JavaScript implementations of different famous Computer Science algorithms.</p>
<p>API reference with usage examples available <a href="https://mgechev.github.io/javascript-algorithms/" target="_blank">here</a>.</p>
<p><em>Note: not all algorithms are well tested so bugs are quite possible.</em></p>
<h2>Development</h2><p><strong>To install all dev dependencies</strong></p>
<p>Call:</p>
<pre class="prettyprint source lang-bash"><code>npm install</code></pre><p><strong>To setup repository with documentation</strong></p>
<ul>
<li>Go to the parent directory of the <code>javascript-algorithms</code> folder and call:</li>
</ul>
<pre class="prettyprint source lang-bash"><code>git clone https://github.com/mgechev/javascript-algorithms.git javascript-algorithms-docs</code></pre><ul>
<li>Go to the <code>javascript-algorithms-docs</code> folder and change current branch to <code>gh-pages</code>:</li>
</ul>
<pre class="prettyprint source lang-bash"><code>git checkout gh-pages</code></pre><p>Now you can see <code>index.html</code> file in this folder and open it in your browser.</p>
<p><strong>To update .html files with documentation</strong></p>
<p>Go to the <code>javascript-algorithms</code> folder and call:</p>
<pre class="prettyprint source lang-bash"><code>gulp jsdoc</code></pre><p>and all files in <code>javascript-algorithms-docs</code> folder will be updated.</p>
<p><strong>To run tests</strong></p>
<p>Call:</p>
<pre class="prettyprint source lang-bash"><code>gulp test</code></pre><p>and all <code>*.spec.js</code> files will be executed.</p>
<h2>Contributions</h2><p>Fork the repo and make requred changes. After that push your changes in branch, which is named according to the changes you did.
Initiate the PR.</p>
<p>Make sure you're editor makes validations according to the <code>.jshintrc</code> in the root directory of the repository.</p>
<p>Before pushing to the repository run:</p>
<pre class="prettyprint source lang-bash"><code>gulp build</code></pre><p>If the build is not successful fix your code in order the tests and jshint validation to run successfully and after that create a pull request.</p>
<h2>Contributors</h2><table>
<thead>
<tr>
<th style="text-align:center"><a href="https://github.com/mgechev"><img alt="mgechev" src="https://avatars.githubusercontent.com/u/455023?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/AndriiHeonia"><img alt="AndriiHeonia" src="https://avatars.githubusercontent.com/u/773648?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/Jakehp"><img alt="Jakehp" src="https://avatars.githubusercontent.com/u/1854569?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/lygstate"><img alt="lygstate" src="https://avatars.githubusercontent.com/u/121040?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/pvoznenko"><img alt="pvoznenko" src="https://avatars.githubusercontent.com/u/1098414?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/filipefalcaos"><img alt="filipefalcaos" src="https://avatars.githubusercontent.com/u/9125631?v=3&s=117" width="117"></a></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center"><a href="https://github.com/mgechev">mgechev</a></td>
<td style="text-align:center"><a href="https://github.com/AndriiHeonia">AndriiHeonia</a></td>
<td style="text-align:center"><a href="https://github.com/Jakehp">Jakehp</a></td>
<td style="text-align:center"><a href="https://github.com/lygstate">lygstate</a></td>
<td style="text-align:center"><a href="https://github.com/pvoznenko">pvoznenko</a></td>
<td style="text-align:center"><a href="https://github.com/filipefalcaos">filipefalcaos</a></td>
<td></td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th style="text-align:center"><a href="https://github.com/lekkas"><img alt="lekkas" src="https://avatars.githubusercontent.com/u/5211478?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/deniskyashif"><img alt="deniskyashif" src="https://avatars.githubusercontent.com/u/5999271?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/infusion"><img alt="infusion" src="https://avatars.githubusercontent.com/u/197742?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/designeng"><img alt="designeng" src="https://avatars.githubusercontent.com/u/2807469?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/Microfed"><img alt="Microfed" src="https://avatars.githubusercontent.com/u/613179?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/ysharplanguage"><img alt="ysharplanguage" src="https://avatars.githubusercontent.com/u/1055314?v=3&s=117" width="117"></a></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center"><a href="https://github.com/lekkas">lekkas</a></td>
<td style="text-align:center"><a href="https://github.com/deniskyashif">deniskyashif</a></td>
<td style="text-align:center"><a href="https://github.com/infusion">infusion</a></td>
<td style="text-align:center"><a href="https://github.com/designeng">designeng</a></td>
<td style="text-align:center"><a href="https://github.com/Microfed">Microfed</a></td>
<td style="text-align:center"><a href="https://github.com/ysharplanguage">ysharplanguage</a></td>
<td></td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th style="text-align:center"><a href="https://github.com/contra"><img alt="contra" src="https://avatars.githubusercontent.com/u/425716?v=3&s=117" width="117"></a></th>
<th style="text-align:center"><a href="https://github.com/fanixk"><img alt="fanixk" src="https://avatars.githubusercontent.com/u/921156?v=3&s=117" width="117"></a></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center"><a href="https://github.com/contra">contra</a></td>
<td style="text-align:center"><a href="https://github.com/fanixk">fanixk</a></td>
<td></td>
</tr>
</tbody>
</table>
<h2>License</h2><p>The code in this repository is distributed under the terms of the MIT license.</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-combinatorics_cartesianproduct.html">combinatorics/cartesianproduct</a></li><li><a href="module-combinatorics_combinations.html">combinatorics/combinations</a></li><li><a href="module-combinatorics_permutations.html">combinatorics/permutations</a></li><li><a href="module-combinatorics_variations-repetition.html">combinatorics/variations-repetition</a></li><li><a href="module-data-structures_avl-tree.html">data-structures/avl-tree</a></li><li><a href="module-data-structures_binary-search-tree.html">data-structures/binary-search-tree</a></li><li><a href="module-data-structures_edge.html">data-structures/edge</a></li><li><a href="module-data-structures_hash-table.html">data-structures/hash-table</a></li><li><a href="module-data-structures_heap.html">data-structures/heap</a></li><li><a href="module-data-structures_interval-tree.html">data-structures/interval-tree</a></li><li><a href="module-data-structures_linked-list.html">data-structures/linked-list</a></li><li><a href="module-data-structures_red-black-tree.html">data-structures/red-black-tree</a></li><li><a href="module-data-structures_size-balanced-tree.html">data-structures/size-balanced-tree</a></li><li><a href="module-data-structures_splay-tree.html">data-structures/splay-tree</a></li><li><a href="module-data-structures_vertex.html">data-structures/vertex</a></li><li><a href="module-graphs_others_topological-sort.html">graphs/others/topological-sort</a></li><li><a href="module-graphs_searching_bfs.html">graphs/searching/bfs</a></li><li><a href="module-graphs_searching_dfs.html">graphs/searching/dfs</a></li><li><a href="module-graphs_shortest-path_bellman-ford.html">graphs/shortest-path/bellman-ford</a></li><li><a href="module-graphs_shortest-path_dijkstra.html">graphs/shortest-path/dijkstra</a></li><li><a href="module-graphs_shortest-path_floyd-warshall.html">graphs/shortest-path/floyd-warshall</a></li><li><a href="module-graphs_spanning-trees_prim.html">graphs/spanning-trees/prim</a></li><li><a href="module-others_fibonacci.html">others/fibonacci</a></li><li><a href="module-others_hanoi.html">others/hanoi</a></li><li><a href="module-others_levenshtein-distance.html">others/levenshtein-distance</a></li><li><a href="module-others_minCoinsChange.html">others/minCoinsChange</a></li><li><a href="module-primes_is-prime.html">primes/is-prime</a></li><li><a href="module-primes_prime-factor-tree.html">primes/prime-factor-tree</a></li><li><a href="module-primes_sieve-of-eratosthenes.html">primes/sieve-of-eratosthenes</a></li><li><a href="module-searching_binarysearch.html">searching/binarysearch</a></li><li><a href="module-searching_knuth-morris-pratt.html">searching/knuth-morris-pratt</a></li><li><a href="module-searching_longest-increasing-subsequence.html">searching/longest-increasing-subsequence</a></li><li><a href="module-searching_maximum-subarray.html">searching/maximum-subarray</a></li><li><a href="module-searching_maximum-subarray-divide-and-conquer.html">searching/maximum-subarray-divide-and-conquer</a></li><li><a href="module-searching_quickselect.html">searching/quickselect</a></li><li><a href="module-searching_recursive-binarysearch.html">searching/recursive-binarysearch</a></li><li><a href="module-sets_quickfind.html">sets/quickfind</a></li><li><a href="module-sets_quickunion.html">sets/quickunion</a></li><li><a href="module-sets_weightquickunion.html">sets/weightquickunion</a></li><li><a href="module-shuffle_fisheryates.html">shuffle/fisheryates</a></li><li><a href="module-shuffle_richarddurstenfeld.html">shuffle/richarddurstenfeld</a></li><li><a href="module-sorting_3-way-string-quicksort.html">sorting/3-way-string-quicksort</a></li><li><a href="module-sorting_bubblesort.html">sorting/bubblesort</a></li><li><a href="module-sorting_bucketsort.html">sorting/bucketsort</a></li><li><a href="module-sorting_countingsort.html">sorting/countingsort</a></li><li><a href="module-sorting_heapsort.html">sorting/heapsort</a></li><li><a href="module-sorting_insertion-binary-sort.html">sorting/insertion-binary-sort</a></li><li><a href="module-sorting_insertionsort.html">sorting/insertionsort</a></li><li><a href="module-sorting_lsd.html">sorting/lsd</a></li><li><a href="module-sorting_mergesort.html">sorting/mergesort</a></li><li><a href="module-sorting_mergesort_merge.html">sorting/mergesort/merge</a></li><li><a href="module-sorting_msd.html">sorting/msd</a></li><li><a href="module-sorting_oddeven-sort.html">sorting/oddeven-sort</a></li><li><a href="module-sorting_quicksort-middle.html">sorting/quicksort-middle</a></li><li><a href="module-sorting_radixsort.html">sorting/radixsort</a></li><li><a href="module-sorting_recursive-insertionsort.html">sorting/recursive-insertionsort</a></li><li><a href="module-sorting_selectionsort.html">sorting/selectionsort</a></li><li><a href="module-sorting_shellsort.html">sorting/shellsort</a></li></ul><h3>Classes</h3><ul><li><a href="module-data-structures_avl-tree.AVLTree.html">AVLTree</a></li><li><a href="module-data-structures_avl-tree.Node.html">Node</a></li><li><a href="module-data-structures_binary-search-tree.BinaryTree.html">BinaryTree</a></li><li><a href="module-data-structures_binary-search-tree.Node.html">Node</a></li><li><a href="module-data-structures_hash-table.Hashtable.html">Hashtable</a></li><li><a href="module-data-structures_hash-table.Node.html">Node</a></li><li><a href="module-data-structures_heap.Heap.html">Heap</a></li><li><a href="module-data-structures_interval-tree.IntervalTree.html">IntervalTree</a></li><li><a href="module-data-structures_interval-tree.Node.html">Node</a></li><li><a href="module-data-structures_linked-list.LinkedList.html">LinkedList</a></li><li><a href="module-data-structures_linked-list.Node.html">Node</a></li><li><a href="module-data-structures_red-black-tree.RBTree.html">RBTree</a></li><li><a href="module-data-structures_size-balanced-tree-CreateSBTreeClass-SBTree.html">SBTree</a></li><li><a href="module-data-structures_splay-tree.Node.html">Node</a></li><li><a href="module-data-structures_splay-tree.SplayTree.html">SplayTree</a></li><li><a href="module-graphs_spanning-trees_prim.Graph.html">Graph</a></li><li><a href="module-sets_quickfind.QuickFind.html">QuickFind</a></li><li><a href="module-sets_quickunion.QuickUnion.html">QuickUnion</a></li><li><a href="module-sets_weightquickunion.QuickUnion.html">QuickUnion</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha13</a> on Wed May 18 2016 11:36:06 GMT+0300 (EEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>