prepare v0.2.0

Author: blutorange

README.md

@@ -82,11 +82,13 @@ Tests done with [benchmark](https://www.npmjs.com/package/benchmark). Compared w
 sort with `graphlib` (via `alg.isAcyclic(graph)`) each time a vertex is added. Measured time is the time that
 was needed for creating a new graph and adding `n` vertices, checking for a cycle after each edge insertion.
 
-```
-// 200 vertices, 15000 random (same for each algorithm) edges added
-incremental-cycle-detection(insert 15000, RandomSource) x 36.51 ops/sec ±4.53% (59 runs sampled)
-graphlib(insert15000, RandomSource) x 0.18 ops/sec ±2.78% (5 runs sampled)
-```
+> **incremental-cycle-detection**(insert 15000, RandomSource) x **36.43** ops/sec ±0.79% (58 runs sampled)
+>
+> **incremental-cycle-detection-multi**(insert 15000, RandomSource) x **25.71** ops/sec ±10.12% (45 runs sampled)
+>
+> **graphlib**(insert15000, RandomSource) x **0.17** ops/sec ±1.63% (5 runs sampled)
+
+(200 vertices, 15000 random (same for each algorithm) edges added)
 
 # JavaScript environment
 
@@ -140,8 +142,10 @@ I use the following keywords:
 From newest to oldest:
 
 # 0.2.0
+- Added the method `getOrder` to the graph adapters. It allows you to access the topological order of each vertex.
 - Added a `MultiGraphAdapter` data structure that allows for multiple edges between two vertices.
-- Changed `GenericGraphAdapter, it now only allows for one kind of edge data.
+- Changed `GenericGraphAdapter`, it now only allows for one kind of edge data to be compatible with the `CommonAdapter` interface. You can use objects if you need to store more data.
+- Added more test cases for the `MultiGraphAdapter` and fixed some bugs, updated dependencies.
 
 # 0.1.1
 - 0.1.1 Fixed package.json and dependencies (was missing tslib).

docs/assets/js/search.js

@@ -972,6 +972,9 @@
 		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
 			<a href="../globals.html#assign" class="tsd-kind-icon">assign</a>
 		</li>
+		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
+			<a href="../globals.html#cancontractedge" class="tsd-kind-icon">can<wbr>Contract<wbr>Edge</a>
+		</li>
 		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
 			<a href="../globals.html#contractedge" class="tsd-kind-icon">contract<wbr>Edge</a>
 		</li>
@@ -981,9 +984,18 @@
 		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
 			<a href="../globals.html#createfilterediterator" class="tsd-kind-icon">create<wbr>Filtered<wbr>Iterator</a>
 		</li>
+		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
+			<a href="../globals.html#createflatmappediterator" class="tsd-kind-icon">create<wbr>Flat<wbr>Mapped<wbr>Iterator</a>
+		</li>
 		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
 			<a href="../globals.html#createmappedarrayiterator" class="tsd-kind-icon">create<wbr>Mapped<wbr>Array<wbr>Iterator</a>
 		</li>
+		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
+			<a href="../globals.html#createmappediterator" class="tsd-kind-icon">create<wbr>Mapped<wbr>Iterator</a>
+		</li>
+		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
+			<a href="../globals.html#takefirst" class="tsd-kind-icon">take<wbr>First</a>
+		</li>
 		<li class=" tsd-kind-function tsd-has-type-parameter tsd-is-private">
 			<a href="../globals.html#toarray" class="tsd-kind-icon">to<wbr>Array</a>
 		</li>
@@ -1075,7 +1087,7 @@ <h3>constructor</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/b264f4b/src/PearceKellyDetector.ts#L68">PearceKellyDetector.ts:68</a></li>
+								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/70213d0/src/PearceKellyDetector.ts#L68">PearceKellyDetector.ts:68</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-returns-title">Returns <a href="pearcekellydetector.html" class="tsd-signature-type">PearceKellyDetector</a></h4>
@@ -1096,7 +1108,7 @@ <h3>can<wbr>Add<wbr>Edge</h3>
 						<aside class="tsd-sources">
 							<p>Implementation of <a href="../interfaces/cycledetector.html">CycleDetector</a>.<a href="../interfaces/cycledetector.html#canaddedge">canAddEdge</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/b264f4b/src/PearceKellyDetector.ts#L113">PearceKellyDetector.ts:113</a></li>
+								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/70213d0/src/PearceKellyDetector.ts#L111">PearceKellyDetector.ts:111</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1126,7 +1138,7 @@ <h3>create<wbr>Vertex<wbr>Data</h3>
 						<aside class="tsd-sources">
 							<p>Implementation of <a href="../interfaces/cycledetector.html">CycleDetector</a>.<a href="../interfaces/cycledetector.html#createvertexdata">createVertexData</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/b264f4b/src/PearceKellyDetector.ts#L99">PearceKellyDetector.ts:99</a></li>
+								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/70213d0/src/PearceKellyDetector.ts#L97">PearceKellyDetector.ts:97</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1153,7 +1165,7 @@ <h3>get<wbr>Order</h3>
 						<aside class="tsd-sources">
 							<p>Implementation of <a href="../interfaces/cycledetector.html">CycleDetector</a>.<a href="../interfaces/cycledetector.html#getorder">getOrder</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/b264f4b/src/PearceKellyDetector.ts#L125">PearceKellyDetector.ts:125</a></li>
+								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/70213d0/src/PearceKellyDetector.ts#L123">PearceKellyDetector.ts:123</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1180,7 +1192,7 @@ <h3>is<wbr>Reachable</h3>
 						<aside class="tsd-sources">
 							<p>Implementation of <a href="../interfaces/cycledetector.html">CycleDetector</a>.<a href="../interfaces/cycledetector.html#isreachable">isReachable</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/b264f4b/src/PearceKellyDetector.ts#L78">PearceKellyDetector.ts:78</a></li>
+								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/70213d0/src/PearceKellyDetector.ts#L78">PearceKellyDetector.ts:78</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1210,7 +1222,7 @@ <h3>on<wbr>Vertex<wbr>Deletion</h3>
 						<aside class="tsd-sources">
 							<p>Implementation of <a href="../interfaces/cycledetector.html">CycleDetector</a>.<a href="../interfaces/cycledetector.html#onvertexdeletion">onVertexDeletion</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/b264f4b/src/PearceKellyDetector.ts#L107">PearceKellyDetector.ts:107</a></li>
+								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/70213d0/src/PearceKellyDetector.ts#L105">PearceKellyDetector.ts:105</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1237,7 +1249,7 @@ <h3>supports<wbr>Order</h3>
 						<aside class="tsd-sources">
 							<p>Implementation of <a href="../interfaces/cycledetector.html">CycleDetector</a>.<a href="../interfaces/cycledetector.html#supportsorder">supportsOrder</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/b264f4b/src/PearceKellyDetector.ts#L121">PearceKellyDetector.ts:121</a></li>
+								<li>Defined in <a href="https://github.com/blutorange/js-incremental-cycle-detect/blob/70213d0/src/PearceKellyDetector.ts#L119">PearceKellyDetector.ts:119</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>