Skip to content

Commit b27e0c4

Browse files
jdanjdan
committed
add docs
1 parent 27e16c9 commit b27e0c4

File tree

125 files changed

+7091
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+7091
-1
lines changed

‎Makefile

+3-1
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,11 @@ all:: .depend.input .depend $(EXEC)
156156

157157
opt : $(EXEC).opt
158158

159-
.PHONY: test
159+
.PHONY: test docs
160160
test: $(EXEC)
161161
@./$(EXEC) && echo "All tests pass"
162+
docs: $(EXEC)
163+
ocamldoc -I src -html -rectypes -d docs $(SOURCES)
162164

163165
#ocamlc -custom other options graphics.cma other files -cclib -lgraphics -cclib -lX11
164166
#ocamlc -thread -custom other options threads.cma other files -cclib -lthreads

‎docs/Algebra.html

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<link rel="Start" href="index.html">
8+
<link rel="previous" href="Functor_test.html">
9+
<link rel="next" href="Algebra_test.html">
10+
<link rel="Up" href="index.html">
11+
<link title="Index of types" rel=Appendix href="index_types.html">
12+
<link title="Index of values" rel=Appendix href="index_values.html">
13+
<link title="Index of modules" rel=Appendix href="index_modules.html">
14+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
15+
<link title="Ord" rel="Chapter" href="Ord.html">
16+
<link title="Mystack" rel="Chapter" href="Mystack.html">
17+
<link title="Mystack_test" rel="Chapter" href="Mystack_test.html">
18+
<link title="Trie" rel="Chapter" href="Trie.html">
19+
<link title="Trie_test" rel="Chapter" href="Trie_test.html">
20+
<link title="Setoid" rel="Chapter" href="Setoid.html">
21+
<link title="Setoid_test" rel="Chapter" href="Setoid_test.html">
22+
<link title="Functor" rel="Chapter" href="Functor.html">
23+
<link title="Functor_test" rel="Chapter" href="Functor_test.html">
24+
<link title="Algebra" rel="Chapter" href="Algebra.html">
25+
<link title="Algebra_test" rel="Chapter" href="Algebra_test.html">
26+
<link title="Myqueue" rel="Chapter" href="Myqueue.html">
27+
<link title="Myqueue_test" rel="Chapter" href="Myqueue_test.html">
28+
<link title="Finite_state_machine" rel="Chapter" href="Finite_state_machine.html">
29+
<link title="Finite_state_machine_test" rel="Chapter" href="Finite_state_machine_test.html">
30+
<link title="Wire" rel="Chapter" href="Wire.html">
31+
<link title="Wire_test" rel="Chapter" href="Wire_test.html">
32+
<link title="Binary_search_tree" rel="Chapter" href="Binary_search_tree.html">
33+
<link title="Binary_search_tree_test" rel="Chapter" href="Binary_search_tree_test.html">
34+
<link title="Red_black_tree" rel="Chapter" href="Red_black_tree.html">
35+
<link title="Red_black_tree_test" rel="Chapter" href="Red_black_tree_test.html">
36+
<link title="Levenshtein" rel="Chapter" href="Levenshtein.html">
37+
<link title="Levenshtein_test" rel="Chapter" href="Levenshtein_test.html">
38+
<link title="Binary_heap" rel="Chapter" href="Binary_heap.html">
39+
<link title="Binary_heap_test" rel="Chapter" href="Binary_heap_test.html">
40+
<link title="Huffman_coding" rel="Chapter" href="Huffman_coding.html">
41+
<link title="Huffman_coding_test" rel="Chapter" href="Huffman_coding_test.html"><title>Algebra</title>
42+
</head>
43+
<body>
44+
<div class="navbar"><a class="pre" href="Functor_test.html" title="Functor_test">Previous</a>
45+
&nbsp;<a class="up" href="index.html" title="Index">Up</a>
46+
&nbsp;<a class="post" href="Algebra_test.html" title="Algebra_test">Next</a>
47+
</div>
48+
<h1>Module <a href="type_Algebra.html">Algebra</a></h1>
49+
50+
<pre><span id="MODULEAlgebra"><span class="keyword">module</span> Algebra</span>: <code class="code">sig</code> <a href="Algebra.html">..</a> <code class="code">end</code></pre><hr width="100%">
51+
52+
<pre><span id="TYPEvalue"><span class="keyword">type</span> <code class="type"></code>value</span> = <code class="type">int</code> </pre>
53+
54+
55+
<pre><span id="TYPEvariable"><span class="keyword">type</span> <code class="type"></code>variable</span> = <code class="type">string</code> </pre>
56+
57+
58+
<pre><code><span id="TYPEexpression"><span class="keyword">type</span> <code class="type"></code>expression</span> = </code></pre><table class="typetable">
59+
<tr>
60+
<td align="left" valign="top" >
61+
<code><span class="keyword">|</span></code></td>
62+
<td align="left" valign="top" >
63+
<code><span id="TYPEELTexpression.Value"><span class="constructor">Value</span></span> <span class="keyword">of</span> <code class="type"><a href="Algebra.html#TYPEvalue">value</a></code></code></td>
64+
65+
</tr>
66+
<tr>
67+
<td align="left" valign="top" >
68+
<code><span class="keyword">|</span></code></td>
69+
<td align="left" valign="top" >
70+
<code><span id="TYPEELTexpression.Variable"><span class="constructor">Variable</span></span> <span class="keyword">of</span> <code class="type"><a href="Algebra.html#TYPEvariable">variable</a></code></code></td>
71+
72+
</tr>
73+
<tr>
74+
<td align="left" valign="top" >
75+
<code><span class="keyword">|</span></code></td>
76+
<td align="left" valign="top" >
77+
<code><span id="TYPEELTexpression.Addition"><span class="constructor">Addition</span></span> <span class="keyword">of</span> <code class="type"><a href="Algebra.html#TYPEexpression">expression</a> * <a href="Algebra.html#TYPEexpression">expression</a></code></code></td>
78+
79+
</tr>
80+
<tr>
81+
<td align="left" valign="top" >
82+
<code><span class="keyword">|</span></code></td>
83+
<td align="left" valign="top" >
84+
<code><span id="TYPEELTexpression.Multiplication"><span class="constructor">Multiplication</span></span> <span class="keyword">of</span> <code class="type"><a href="Algebra.html#TYPEexpression">expression</a> * <a href="Algebra.html#TYPEexpression">expression</a></code></code></td>
85+
86+
</tr>
87+
<tr>
88+
<td align="left" valign="top" >
89+
<code><span class="keyword">|</span></code></td>
90+
<td align="left" valign="top" >
91+
<code><span id="TYPEELTexpression.Exponentiation"><span class="constructor">Exponentiation</span></span> <span class="keyword">of</span> <code class="type"><a href="Algebra.html#TYPEexpression">expression</a> * <a href="Algebra.html#TYPEvalue">value</a></code></code></td>
92+
93+
</tr></table>
94+
95+
96+
97+
<pre><span id="VALstring_of_expression"><span class="keyword">val</span> string_of_expression</span> : <code class="type"><a href="Algebra.html#TYPEexpression">expression</a> -> <a href="Algebra.html#TYPEvariable">variable</a></code></pre>
98+
<pre><span id="VALsimplify"><span class="keyword">val</span> simplify</span> : <code class="type"><a href="Algebra.html#TYPEexpression">expression</a> -> <a href="Algebra.html#TYPEexpression">expression</a></code></pre>
99+
<pre><span id="VALderiv"><span class="keyword">val</span> deriv</span> : <code class="type"><a href="Algebra.html#TYPEvariable">variable</a> -> <a href="Algebra.html#TYPEexpression">expression</a> -> <a href="Algebra.html#TYPEexpression">expression</a></code></pre></body></html>

‎docs/Algebra_test.html

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<link rel="Start" href="index.html">
8+
<link rel="previous" href="Algebra.html">
9+
<link rel="next" href="Myqueue.html">
10+
<link rel="Up" href="index.html">
11+
<link title="Index of types" rel=Appendix href="index_types.html">
12+
<link title="Index of values" rel=Appendix href="index_values.html">
13+
<link title="Index of modules" rel=Appendix href="index_modules.html">
14+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
15+
<link title="Ord" rel="Chapter" href="Ord.html">
16+
<link title="Mystack" rel="Chapter" href="Mystack.html">
17+
<link title="Mystack_test" rel="Chapter" href="Mystack_test.html">
18+
<link title="Trie" rel="Chapter" href="Trie.html">
19+
<link title="Trie_test" rel="Chapter" href="Trie_test.html">
20+
<link title="Setoid" rel="Chapter" href="Setoid.html">
21+
<link title="Setoid_test" rel="Chapter" href="Setoid_test.html">
22+
<link title="Functor" rel="Chapter" href="Functor.html">
23+
<link title="Functor_test" rel="Chapter" href="Functor_test.html">
24+
<link title="Algebra" rel="Chapter" href="Algebra.html">
25+
<link title="Algebra_test" rel="Chapter" href="Algebra_test.html">
26+
<link title="Myqueue" rel="Chapter" href="Myqueue.html">
27+
<link title="Myqueue_test" rel="Chapter" href="Myqueue_test.html">
28+
<link title="Finite_state_machine" rel="Chapter" href="Finite_state_machine.html">
29+
<link title="Finite_state_machine_test" rel="Chapter" href="Finite_state_machine_test.html">
30+
<link title="Wire" rel="Chapter" href="Wire.html">
31+
<link title="Wire_test" rel="Chapter" href="Wire_test.html">
32+
<link title="Binary_search_tree" rel="Chapter" href="Binary_search_tree.html">
33+
<link title="Binary_search_tree_test" rel="Chapter" href="Binary_search_tree_test.html">
34+
<link title="Red_black_tree" rel="Chapter" href="Red_black_tree.html">
35+
<link title="Red_black_tree_test" rel="Chapter" href="Red_black_tree_test.html">
36+
<link title="Levenshtein" rel="Chapter" href="Levenshtein.html">
37+
<link title="Levenshtein_test" rel="Chapter" href="Levenshtein_test.html">
38+
<link title="Binary_heap" rel="Chapter" href="Binary_heap.html">
39+
<link title="Binary_heap_test" rel="Chapter" href="Binary_heap_test.html">
40+
<link title="Huffman_coding" rel="Chapter" href="Huffman_coding.html">
41+
<link title="Huffman_coding_test" rel="Chapter" href="Huffman_coding_test.html"><title>Algebra_test</title>
42+
</head>
43+
<body>
44+
<div class="navbar"><a class="pre" href="Algebra.html" title="Algebra">Previous</a>
45+
&nbsp;<a class="up" href="index.html" title="Index">Up</a>
46+
&nbsp;<a class="post" href="Myqueue.html" title="Myqueue">Next</a>
47+
</div>
48+
<h1>Module <a href="type_Algebra_test.html">Algebra_test</a></h1>
49+
50+
<pre><span id="MODULEAlgebra_test"><span class="keyword">module</span> Algebra_test</span>: <code class="code">sig</code> <a href="Algebra_test.html">..</a> <code class="code">end</code></pre><hr width="100%">
51+
</body></html>

‎docs/Binary_heap.BinaryHeap.html

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<link rel="Start" href="index.html">
8+
<link rel="Up" href="Binary_heap.html">
9+
<link title="Index of types" rel=Appendix href="index_types.html">
10+
<link title="Index of values" rel=Appendix href="index_values.html">
11+
<link title="Index of modules" rel=Appendix href="index_modules.html">
12+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
13+
<link title="Ord" rel="Chapter" href="Ord.html">
14+
<link title="Mystack" rel="Chapter" href="Mystack.html">
15+
<link title="Mystack_test" rel="Chapter" href="Mystack_test.html">
16+
<link title="Trie" rel="Chapter" href="Trie.html">
17+
<link title="Trie_test" rel="Chapter" href="Trie_test.html">
18+
<link title="Setoid" rel="Chapter" href="Setoid.html">
19+
<link title="Setoid_test" rel="Chapter" href="Setoid_test.html">
20+
<link title="Functor" rel="Chapter" href="Functor.html">
21+
<link title="Functor_test" rel="Chapter" href="Functor_test.html">
22+
<link title="Algebra" rel="Chapter" href="Algebra.html">
23+
<link title="Algebra_test" rel="Chapter" href="Algebra_test.html">
24+
<link title="Myqueue" rel="Chapter" href="Myqueue.html">
25+
<link title="Myqueue_test" rel="Chapter" href="Myqueue_test.html">
26+
<link title="Finite_state_machine" rel="Chapter" href="Finite_state_machine.html">
27+
<link title="Finite_state_machine_test" rel="Chapter" href="Finite_state_machine_test.html">
28+
<link title="Wire" rel="Chapter" href="Wire.html">
29+
<link title="Wire_test" rel="Chapter" href="Wire_test.html">
30+
<link title="Binary_search_tree" rel="Chapter" href="Binary_search_tree.html">
31+
<link title="Binary_search_tree_test" rel="Chapter" href="Binary_search_tree_test.html">
32+
<link title="Red_black_tree" rel="Chapter" href="Red_black_tree.html">
33+
<link title="Red_black_tree_test" rel="Chapter" href="Red_black_tree_test.html">
34+
<link title="Levenshtein" rel="Chapter" href="Levenshtein.html">
35+
<link title="Levenshtein_test" rel="Chapter" href="Levenshtein_test.html">
36+
<link title="Binary_heap" rel="Chapter" href="Binary_heap.html">
37+
<link title="Binary_heap_test" rel="Chapter" href="Binary_heap_test.html">
38+
<link title="Huffman_coding" rel="Chapter" href="Huffman_coding.html">
39+
<link title="Huffman_coding_test" rel="Chapter" href="Huffman_coding_test.html"><title>Binary_heap.BinaryHeap</title>
40+
</head>
41+
<body>
42+
<div class="navbar">&nbsp;<a class="up" href="Binary_heap.html" title="Binary_heap">Up</a>
43+
&nbsp;</div>
44+
<h1>Functor <a href="type_Binary_heap.BinaryHeap.html">Binary_heap.BinaryHeap</a></h1>
45+
46+
<pre><span id="MODULEBinaryHeap"><span class="keyword">module</span> BinaryHeap</span>: <div class="sig_block"><code class="code">functor (</code><code class="code">Ord</code><code class="code"> : </code><code class="type"><a href="Ord.S.html">Ord.S</a></code><code class="code">) -&gt; </code><code class="code">sig</code> <a href="Binary_heap.BinaryHeap.html">..</a> <code class="code">end</code></div></pre><table border="0" cellpadding="3" width="100%">
47+
<tr>
48+
<td align="left" valign="top" width="1%%"><b>Parameters: </b></td>
49+
<td>
50+
<table class="paramstable">
51+
<tr>
52+
<td align="center" valign="top" width="15%">
53+
<code>Ord</code></td>
54+
<td align="center" valign="top">:</td>
55+
<td><code class="type"><a href="Ord.S.html">Ord.S</a></code>
56+
</table>
57+
</td>
58+
</tr>
59+
</table>
60+
<hr width="100%">
61+
62+
<pre><code><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = {</code></pre><table class="typetable">
63+
<tr>
64+
<td align="left" valign="top" >
65+
<code>&nbsp;&nbsp;</code></td>
66+
<td align="left" valign="top" >
67+
<code><span id="TYPEELTt.heap">heap</span>&nbsp;: <code class="type">heap</code>;</code></td>
68+
69+
</tr>
70+
<tr>
71+
<td align="left" valign="top" >
72+
<code>&nbsp;&nbsp;</code></td>
73+
<td align="left" valign="top" >
74+
<code><span id="TYPEELTt.index">index</span>&nbsp;: <code class="type">int</code>;</code></td>
75+
76+
</tr></table>
77+
<code>}</code>
78+
79+
80+
81+
<pre><span class="keyword">include</span> struct ... end</pre>
82+
83+
<pre><span id="VALpeek"><span class="keyword">val</span> peek</span> : <code class="type"><a href="Binary_heap.BinaryHeap.html#TYPEt">t</a> -> Ord.t option</code></pre>
84+
<pre><span id="VALextract"><span class="keyword">val</span> extract</span> : <code class="type"><a href="Binary_heap.BinaryHeap.html#TYPEt">t</a> -> Ord.t option * <a href="Binary_heap.BinaryHeap.html#TYPEt">t</a></code></pre></body></html>

‎docs/Binary_heap.S.html

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<link rel="Start" href="index.html">
8+
<link rel="Up" href="Binary_heap.html">
9+
<link title="Index of types" rel=Appendix href="index_types.html">
10+
<link title="Index of values" rel=Appendix href="index_values.html">
11+
<link title="Index of modules" rel=Appendix href="index_modules.html">
12+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
13+
<link title="Ord" rel="Chapter" href="Ord.html">
14+
<link title="Mystack" rel="Chapter" href="Mystack.html">
15+
<link title="Mystack_test" rel="Chapter" href="Mystack_test.html">
16+
<link title="Trie" rel="Chapter" href="Trie.html">
17+
<link title="Trie_test" rel="Chapter" href="Trie_test.html">
18+
<link title="Setoid" rel="Chapter" href="Setoid.html">
19+
<link title="Setoid_test" rel="Chapter" href="Setoid_test.html">
20+
<link title="Functor" rel="Chapter" href="Functor.html">
21+
<link title="Functor_test" rel="Chapter" href="Functor_test.html">
22+
<link title="Algebra" rel="Chapter" href="Algebra.html">
23+
<link title="Algebra_test" rel="Chapter" href="Algebra_test.html">
24+
<link title="Myqueue" rel="Chapter" href="Myqueue.html">
25+
<link title="Myqueue_test" rel="Chapter" href="Myqueue_test.html">
26+
<link title="Finite_state_machine" rel="Chapter" href="Finite_state_machine.html">
27+
<link title="Finite_state_machine_test" rel="Chapter" href="Finite_state_machine_test.html">
28+
<link title="Wire" rel="Chapter" href="Wire.html">
29+
<link title="Wire_test" rel="Chapter" href="Wire_test.html">
30+
<link title="Binary_search_tree" rel="Chapter" href="Binary_search_tree.html">
31+
<link title="Binary_search_tree_test" rel="Chapter" href="Binary_search_tree_test.html">
32+
<link title="Red_black_tree" rel="Chapter" href="Red_black_tree.html">
33+
<link title="Red_black_tree_test" rel="Chapter" href="Red_black_tree_test.html">
34+
<link title="Levenshtein" rel="Chapter" href="Levenshtein.html">
35+
<link title="Levenshtein_test" rel="Chapter" href="Levenshtein_test.html">
36+
<link title="Binary_heap" rel="Chapter" href="Binary_heap.html">
37+
<link title="Binary_heap_test" rel="Chapter" href="Binary_heap_test.html">
38+
<link title="Huffman_coding" rel="Chapter" href="Huffman_coding.html">
39+
<link title="Huffman_coding_test" rel="Chapter" href="Huffman_coding_test.html"><title>Binary_heap.S</title>
40+
</head>
41+
<body>
42+
<div class="navbar">&nbsp;<a class="up" href="Binary_heap.html" title="Binary_heap">Up</a>
43+
&nbsp;</div>
44+
<h1>Module type <a href="type_Binary_heap.S.html">Binary_heap.S</a></h1>
45+
46+
<pre><span id="MODULETYPES"><span class="keyword">module type</span> S</span> = <code class="code">sig</code> <a href="Binary_heap.S.html">..</a> <code class="code">end</code></pre><hr width="100%">
47+
48+
<pre><span class="keyword">include</span> <a href="Binary_search_tree.BST.html">Binary_search_tree.BST</a></pre>
49+
50+
<pre><span id="VALpeek"><span class="keyword">val</span> peek</span> : <code class="type">t -> comparable option</code></pre>
51+
<pre><span id="VALextract"><span class="keyword">val</span> extract</span> : <code class="type">t -> comparable option * t</code></pre></body></html>

0 commit comments

Comments
 (0)