-
Notifications
You must be signed in to change notification settings - Fork 1
/
dlist.html
159 lines (152 loc) · 5.34 KB
/
dlist.html
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
156
157
158
159
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> dlist - doubly linked lists </title>
<script src="jquery.js"></script>
<script src="jquery-cookie.js"></script>
<script src="jquery-tablesorter.js"></script>
<script src="strftime.js"></script>
<script src="mustache.js"></script>
<script src="config.js"></script>
<script src="main.js"></script>
<link rel="stylesheet" type="text/css" href="templates/reset.css" />
<link rel="stylesheet" type="text/css" href="templates/hack.css" />
<link rel="stylesheet" type="text/css" id="lights_css" />
<script>
var DOCNAME = 'dlist'
var PROJECT = 'dlist'
//set the lights before rendering starts
set_lights()
</script>
</head>
<body>
<header>
<div class="container">
<div class="btn-container btn-lights-container">
<a href="#" class="btn btn-lights" id="lights">lights</a>
</div>
<div class="btn-container btn-home-container">
<a href="/" class="btn btn-home">luapower</a>
</div>
<table id="header_table">
<tr>
<td style="vertical-align: middle;" width="100%">
<h1> dlist </h1>
<h2> doubly linked lists </h2>
</td>
<td style="vertical-align: middle;" align="right" style="height: 150px">
<table><tr><td>
<div class="doc" id="package_info_container">
<div id="package_info"> </div>
<div id="commit_log"> </div>
</div>
<a href="https://github.com/luapower/dlist" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/dlist/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/dlist/zipball/master" class="btn btn-rightside">Download as .zip</a>
</td></tr></table>
</td>
</tr>
</table>
<div class="btn-container btn-discuss-container">
<a href="https://github.com/luapower/dlist/issues/new" target="_blank"
class="btn btn-rightside btn-discuss"><span class="icon"></span>Discuss</a>
</div>
</div>
</header>
<div class="bg-container">
<div class="bg-center-container">
<div class="bg bg-dlist" style="background-image: url('bg/dlist.png');"></div>
</div>
</div>
<div class="under-header">
<div class="container">
<div id="toc_container" class="toc_container doc"></div>
<button id=tab1_button class="tab_button hidden">Documentation</button>
<button id=tab2_button class="tab_button hidden">Package Info</button>
<div id="tabs_cointainer">
<div id="tab1_container">
<section class="doc">
<span id="module_info"></span>
<h2 id="local-dlist-requiredlist"><code>local dlist = require'dlist'</code></h2>
<p>Doubly linked lists in Lua. Doubly linked lists make insert, remove and move operations fast, and access by index slow. In this particular implementation items must be Lua tables for which fields <code>_prev</code> and <code>_next</code> must be reserved for linking.</p>
<table>
<tbody>
<tr class="odd">
<td align="left"><code>dlist() -> list</code><br> <code>dlist:new() -> list</code></td>
<td align="left">create a new list</td>
</tr>
<tr class="even">
<td align="left"><code>list:clear()</code></td>
<td align="left">clear the list</td>
</tr>
<tr class="odd">
<td align="left"><code>list:push(t)</code></td>
<td align="left">add an item at end of the list</td>
</tr>
<tr class="even">
<td align="left"><code>list:unshift(t)</code></td>
<td align="left">add an item at the beginning of the list</td>
</tr>
<tr class="odd">
<td align="left"><code>list:insert(t[, after_t])</code></td>
<td align="left">add an item after another item (or at the end)</td>
</tr>
<tr class="even">
<td align="left"><code>list:pop() -> t</code></td>
<td align="left">remove and return the last item, if any</td>
</tr>
<tr class="odd">
<td align="left"><code>list:shift() -> t</code></td>
<td align="left">remove and return the first item, if any</td>
</tr>
<tr class="even">
<td align="left"><code>list:remove(t) -> t</code></td>
<td align="left">remove and return a specific item</td>
</tr>
<tr class="odd">
<td align="left"><code>list:next([current]) -> t</code></td>
<td align="left">next item after some item (or first item)</td>
</tr>
<tr class="even">
<td align="left"><code>list:prev([current]) -> t</code></td>
<td align="left">previous item after some item (or last item)</td>
</tr>
<tr class="odd">
<td align="left"><code>list:items() -> iterator<item></code></td>
<td align="left">iterate items</td>
</tr>
<tr class="even">
<td align="left"><code>list:reverse_items() -> iterator<item></code></td>
<td align="left">iterate items in reverse</td>
</tr>
<tr class="odd">
<td align="left"><code>list:copy() -> new_list</code></td>
<td align="left">copy the list</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="tab2_container" class="doc"></div>
</div>
</div>
<div class="container">
<footer>
<div id="disqus_thread"></div>
<div class="faint">[email protected] | <a href="http://unlicense.org/">public domain</a></div>
</footer>
</div>
</div>
<script type="text/x-mustache" id=info_tab_template>
<h3>Modules</h3>
<ul>
{{#module_array}}
<li>{{name}}</li>
{{/module_array}}
</ul>
</script>
</body>
</html>