Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update documentation. Move modules so that the application scope is m…
…ore limited to reduce the chance of conflicts with other applications.
  • Loading branch information
okeuday committed May 7, 2013
1 parent 0887ac2 commit bdcca57
Show file tree
Hide file tree
Showing 14 changed files with 33 additions and 316 deletions.
4 changes: 2 additions & 2 deletions doc/edoc-info
@@ -1,4 +1,4 @@
%% encoding: UTF-8
{application,pqueue}.
{packages,[]}.
{modules,[pqueue,pqueue2,pqueue3,pqueue4,pqueue_proper,priority_queue,
queue_srv]}.
{modules,[pqueue,pqueue2,pqueue3,pqueue4]}.
5 changes: 1 addition & 4 deletions doc/modules-frame.html
Expand Up @@ -10,9 +10,6 @@ <h2 class="indextitle">Modules</h2>
<tr><td><a href="pqueue.html" target="overviewFrame" class="module">pqueue</a></td></tr>
<tr><td><a href="pqueue2.html" target="overviewFrame" class="module">pqueue2</a></td></tr>
<tr><td><a href="pqueue3.html" target="overviewFrame" class="module">pqueue3</a></td></tr>
<tr><td><a href="pqueue4.html" target="overviewFrame" class="module">pqueue4</a></td></tr>
<tr><td><a href="pqueue_proper.html" target="overviewFrame" class="module">pqueue_proper</a></td></tr>
<tr><td><a href="priority_queue.html" target="overviewFrame" class="module">priority_queue</a></td></tr>
<tr><td><a href="queue_srv.html" target="overviewFrame" class="module">queue_srv</a></td></tr></table>
<tr><td><a href="pqueue4.html" target="overviewFrame" class="module">pqueue4</a></td></tr></table>
</body>
</html>
2 changes: 1 addition & 1 deletion doc/overview-summary.html
Expand Up @@ -11,6 +11,6 @@ <h1>The pqueue application</h1>

<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jul 27 2012, 21:15:38.</i></p>
<p><i>Generated by EDoc, May 7 2013, 15:51:12.</i></p>
</body>
</html>
8 changes: 4 additions & 4 deletions doc/pqueue.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module pqueue</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
Expand All @@ -15,9 +15,9 @@ <h3><a name="Static_Priority_Queue.">Static Priority Queue.</a></h3>
This priority queue implementation depends on a static number of priorities
(-20 (high) to 20 (low)) so that tuple access times can be exploited for
quick in/out priority queue operations.
<p>Copyright © 2011 Michael Truog</p>
<p>Copyright © 2011 Michael Truog</p>

<p><b>Version:</b> 0.1.9 Jul 27 2012 21:15:37
<p><b>Version:</b> 0.1.9 May 7 2013 15:51:12
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>

Expand Down Expand Up @@ -161,6 +161,6 @@ <h4><a name="Convert_the_priority_queue_to_a_list.">Convert the priority queue t
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jul 27 2012, 21:15:37.</i></p>
<p><i>Generated by EDoc, May 7 2013, 15:51:12.</i></p>
</body>
</html>
8 changes: 4 additions & 4 deletions doc/pqueue2.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module pqueue2</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
Expand All @@ -14,9 +14,9 @@ <h1>Module pqueue2</h1>
<h3><a name="Skew_Heap_Priority_Queue.">Skew Heap Priority Queue.</a></h3>
Ulf Wiger suggested pursuing a skew heap as an optimal Erlang priority
queue implementation.
<p>Copyright © 2011 Michael Truog</p>
<p>Copyright © 2011 Michael Truog</p>

<p><b>Version:</b> 0.1.9 Jul 27 2012 21:15:38
<p><b>Version:</b> 0.1.9 May 7 2013 15:51:11
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>

Expand Down Expand Up @@ -138,6 +138,6 @@ <h4><a name="Convert_the_priority_queue_to_a_list.">Convert the priority queue t
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jul 27 2012, 21:15:38.</i></p>
<p><i>Generated by EDoc, May 7 2013, 15:51:11.</i></p>
</body>
</html>
8 changes: 4 additions & 4 deletions doc/pqueue3.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module pqueue3</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
Expand All @@ -15,9 +15,9 @@ <h3><a name="A_Large_Priority_Queue.">A Large Priority Queue.</a></h3>
This priority queue implementation depends on layered tuples, so that tuple
access times can be exploited for quick in/out priority queue operations
when using 64 or more total priorities.
<p>Copyright © 2011 Michael Truog</p>
<p>Copyright © 2011 Michael Truog</p>

<p><b>Version:</b> 0.1.9 Jul 27 2012 21:15:38
<p><b>Version:</b> 0.1.9 May 7 2013 15:51:11
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>

Expand Down Expand Up @@ -153,6 +153,6 @@ <h4><a name="Convert_the_priority_queue_to_a_list.">Convert the priority queue t
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jul 27 2012, 21:15:38.</i></p>
<p><i>Generated by EDoc, May 7 2013, 15:51:11.</i></p>
</body>
</html>
20 changes: 15 additions & 5 deletions doc/pqueue4.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module pqueue4</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
Expand All @@ -15,9 +15,9 @@ <h3><a name="Static_Priority_Queue.">Static Priority Queue.</a></h3>
This priority queue implementation depends on a static number of priorities
(-128 (high) to 128 (low)) so that tuple access times can be exploited for
quick in/out priority queue operations.
<p>Copyright © 2011-2012 Michael Truog</p>
<p>Copyright © 2011-2013 Michael Truog</p>

<p><b>Version:</b> 0.2.0 Jul 27 2012 21:15:38
<p><b>Version:</b> 1.2.0 May 7 2013 15:51:12
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>

Expand All @@ -35,7 +35,10 @@ <h3 class="typedecl"><a name="type-pqueue4">pqueue4()</a></h3>


<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#filter-3">filter/3</a></td><td>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#filter-2">filter/2</a></td><td>
<h4><a name="Filter_the_priority_queue.">Filter the priority queue.</a></h4>
O(N).</td></tr>
<tr><td valign="top"><a href="#filter-3">filter/3</a></td><td>
<h4><a name="Filter_a_specific_priority_within_the_priority_queue.">Filter a specific priority within the priority queue.</a></h4>
O(N).</td></tr>
<tr><td valign="top"><a href="#in-2">in/2</a></td><td>
Expand Down Expand Up @@ -72,6 +75,13 @@ <h4><a name="Convert_the_priority_queue_to_a_list.">Convert the priority queue t

<h2><a name="functions">Function Details</a></h2>

<h3 class="function"><a name="filter-2">filter/2</a></h3>
<div class="spec">
<p><tt>filter(F::fun((any()) -&gt; boolean()), Q::<a href="#type-pqueue4">pqueue4()</a>) -&gt; <a href="#type-pqueue4">pqueue4()</a></tt><br></p>
</div><p>
<h4><a name="Filter_the_priority_queue.">Filter the priority queue.</a></h4>
O(N)</p>

<h3 class="function"><a name="filter-3">filter/3</a></h3>
<div class="spec">
<p><tt>filter(F::fun((any()) -&gt; boolean()), P::integer(), Q::<a href="#type-pqueue4">pqueue4()</a>) -&gt; <a href="#type-pqueue4">pqueue4()</a></tt><br></p>
Expand Down Expand Up @@ -152,6 +162,6 @@ <h4><a name="Convert_the_priority_queue_to_a_list.">Convert the priority queue t
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Jul 27 2012, 21:15:38.</i></p>
<p><i>Generated by EDoc, May 7 2013, 15:51:12.</i></p>
</body>
</html>
86 changes: 0 additions & 86 deletions doc/pqueue_proper.html

This file was deleted.

105 changes: 0 additions & 105 deletions doc/priority_queue.html

This file was deleted.

0 comments on commit bdcca57

Please sign in to comment.