Add pop(idx) support to both single and double linked list implementations

.gitignore

@@ -5,3 +5,4 @@ dist
 *.pyc
 *.so
 *.swp
+*~

CHANGES

@@ -1,3 +1,33 @@
+* cllist-1.0
+
+  Forked from python-llist to python-cllist
+
+  Work by Tim Savannah:
+
+    - Implement pop(idx) to pop any given index
+    - Implement "contains" sequence method, so the "in" operator doesn't run the whole list multiple times
+    - Implement "index" and "rindex" methods to return an index/rindex
+    - Remove "last_accessed_idx" and "last_accessed" node from dllist, replace with "middle" which is used when
+        the list size exceeds a certain value (defined as 10). This greatly improves random-access and random-pop performance
+        on dllist to be comprable or better to that of a base python list
+    - Remove the "hash" function, which did NOT generate unique hashes (very easy to construct two linked lists with same hash,
+        such as [1, 5, 7] and [5, 1, 7]   or [2, 1] and [3]
+    - Remove all compiler warnings
+    - Add some basic benchmarks
+    - Add some more tests
+    - Some minor cleanups
+
+    - Move types into headers, make generic LList node and list structures, which are common to both double and single linked lists.
+    - Allow a double-linked list to extend with a single-linked list, and a single-linked list to extend with a double (for much higher performance)
+
+    - Implement mappings on sllist and dllist
+    - Implement slicing (including with step) on both sllist and dllist
+
+    - Add __version__ and __version_tuple__
+
+    - Some general optimizations
+
+
 * llist-0.4 (2013-01-01)
 
   - Python 3.x support

MANIFEST.in

@@ -1,6 +1,12 @@
-include Makefile CHANGES LICENSE MANIFEST MANIFEST.in
+include Makefile
+include CHANGES
+include LICENSE
+include MANIFEST.in
+include README.rst
+include README.md
 recursive-include src *.c *.h
 recursive-include docs *.py *.rst
+recursive-include pydocs *.html
 include docs/Makefile docs/make.bat
 graft docs/_static
 graft docs/_templates

README.md

@@ -0,0 +1,55 @@
+cllist - C-implemented Linked Lists for Python
+==============================================
+
+cllist is an extension module for CPython providing basic linked list
+data structures.
+
+Collections implemented in the llist module perform well in problems
+which rely on fast insertions, pops, and removal of elements in
+the middle of a sequence.
+
+For this kind of workload, they can be significantly faster than
+collections.deque or standard Python lists.
+
+
+This project was forked from https://github.com/ajakubek/python-llist
+
+and adds many features and enhancements to the original, under a new name "cllist".
+
+The cllist version now lives at https://github.com/kata198/python-cllist
+
+If you were using the previous module, you can change to this new module, it is completely backwards (but not forwards) compatible.
+
+
+
+Single Linked List
+------------------
+
+Singly linked lists are provided by the "sllist" module. This is your basic single-linked list, and might be useful for some scenarios.
+
+A single linked list is far less efficient at everything than the double-linked list implementation.
+
+
+Double Linked List
+------------------
+
+A double-linked list is provided by the "dllist" module.
+
+This provides great performance when doing pops and insertions at random (in the middle), or at either end.
+
+This implementation has been enhanced by implementing a "middle" marker.
+
+This "middle" marker is used when the list size exceeds 10 elements, and is used in all operations which involve walking the list,
+
+which ensures that AT MOST N/4 elements will need to be walked (so the shortest distance from either start, middle, or end is calculated, and walked from there).
+
+This additional feature makes this linked list much more efficient on larger data sets than a standard double-linked list implementation.
+
+
+Why use a linked list?
+----------------------
+
+A linked list should be used when you are going to be adding or removing elements in the middle of the dataset. A standard python list forces the entire list
+to be reallocated and copied when such happens, whereas this can do so without reallocating.
+
+

README.rst

@@ -0,0 +1,55 @@
+cllist - C-implemented Linked Lists for Python
+==============================================
+
+cllist is an extension module for CPython providing basic linked list
+data structures.
+
+Collections implemented in the llist module perform well in problems
+which rely on fast insertions, pops, and removal of elements in
+the middle of a sequence.
+
+For this kind of workload, they can be significantly faster than
+collections.deque or standard Python lists.
+
+
+This project was forked from https://github.com/ajakubek/python-llist
+
+and adds many features and enhancements to the original, under a new name "cllist".
+
+The cllist version now lives at https://github.com/kata198/python-cllist
+
+If you were using the previous module, you can change to this new module, it is completely backwards (but not forwards) compatible.
+
+
+
+Single Linked List
+------------------
+
+Singly linked lists are provided by the "sllist" module. This is your basic single-linked list, and might be useful for some scenarios.
+
+A single linked list is far less efficient at everything than the double-linked list implementation.
+
+
+Double Linked List
+------------------
+
+A double-linked list is provided by the "dllist" module.
+
+This provides great performance when doing pops and insertions at random (in the middle), or at either end.
+
+This implementation has been enhanced by implementing a "middle" marker.
+
+This "middle" marker is used when the list size exceeds 10 elements, and is used in all operations which involve walking the list,
+
+which ensures that AT MOST N/4 elements will need to be walked (so the shortest distance from either start, middle, or end is calculated, and walked from there).
+
+This additional feature makes this linked list much more efficient on larger data sets than a standard double-linked list implementation.
+
+
+Why use a linked list?
+----------------------
+
+A linked list should be used when you are going to be adding or removing elements in the middle of the dataset. A standard python list forces the entire list
+to be reallocated and copied when such happens, whereas this can do so without reallocating.
+
+

docs/index.rst

@@ -9,6 +9,7 @@
 .. module:: llist
    :synopsis: Linked list datatypes for Python
 
+.. moduleauthor:: Timothy Savannah <kata198@gmail.com>
 .. moduleauthor:: Adam Jakubek <ajakubek@gmail.com>
 .. moduleauthor:: Rafał Gałczyński <rafal.galczynski@gmail.com>
 

pydocs/cllist.dllist.html

@@ -0,0 +1,109 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head><title>Python: class dllist</title>
+<meta charset="utf-8">
+</head><body bgcolor="#f0f0f8">
+<p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#000000" face="helvetica, arial"><strong>cllist.dllist</strong> = <a name="cllist.dllist">class dllist</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
+<td colspan=2><tt>Doubly&nbsp;linked&nbsp;list<br>&nbsp;</tt></td></tr>
+<tr><td>&nbsp;</td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="dllist-__add__"><strong>__add__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__add__">__add__</a>(y)&nbsp;&lt;==&gt;&nbsp;x+y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__contains__">__contains__</a>(y)&nbsp;&lt;==&gt;&nbsp;y&nbsp;in&nbsp;x</tt></dd></dl>
+
+<dl><dt><a name="dllist-__delitem__"><strong>__delitem__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__delitem__">__delitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;del&nbsp;x[y]</tt></dd></dl>
+
+<dl><dt><a name="dllist-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__eq__">__eq__</a>(y)&nbsp;&lt;==&gt;&nbsp;x==y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__ge__">__ge__</a>(y)&nbsp;&lt;==&gt;&nbsp;x&gt;=y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
+
+<dl><dt><a name="dllist-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
+&nbsp;<br>
+Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
+
+<dl><dt><a name="dllist-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__gt__">__gt__</a>(y)&nbsp;&lt;==&gt;&nbsp;x&gt;y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__iadd__"><strong>__iadd__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__iadd__">__iadd__</a>(y)&nbsp;&lt;==&gt;&nbsp;x+=y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
+
+<dl><dt><a name="dllist-__iter__"><strong>__iter__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__iter__">__iter__</a>()&nbsp;&lt;==&gt;&nbsp;iter(x)</tt></dd></dl>
+
+<dl><dt><a name="dllist-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__le__">__le__</a>(y)&nbsp;&lt;==&gt;&nbsp;x&lt;=y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__len__">__len__</a>()&nbsp;&lt;==&gt;&nbsp;len(x)</tt></dd></dl>
+
+<dl><dt><a name="dllist-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__lt__">__lt__</a>(y)&nbsp;&lt;==&gt;&nbsp;x&lt;y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__mul__"><strong>__mul__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__mul__">__mul__</a>(n)&nbsp;&lt;==&gt;&nbsp;x*n</tt></dd></dl>
+
+<dl><dt><a name="dllist-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__ne__">__ne__</a>(y)&nbsp;&lt;==&gt;&nbsp;x!=y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
+
+<dl><dt><a name="dllist-__rmul__"><strong>__rmul__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__rmul__">__rmul__</a>(n)&nbsp;&lt;==&gt;&nbsp;n*x</tt></dd></dl>
+
+<dl><dt><a name="dllist-__setitem__"><strong>__setitem__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__setitem__">__setitem__</a>(i,&nbsp;y)&nbsp;&lt;==&gt;&nbsp;x[i]=y</tt></dd></dl>
+
+<dl><dt><a name="dllist-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#cllist.dllist-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
+
+<dl><dt><a name="dllist-append"><strong>append</strong></a>(...)</dt><dd><tt>Append&nbsp;element&nbsp;at&nbsp;the&nbsp;end&nbsp;of&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-appendleft"><strong>appendleft</strong></a>(...)</dt><dd><tt>Append&nbsp;element&nbsp;at&nbsp;the&nbsp;beginning&nbsp;of&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-appendright"><strong>appendright</strong></a>(...)</dt><dd><tt>Append&nbsp;element&nbsp;at&nbsp;the&nbsp;end&nbsp;of&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-clear"><strong>clear</strong></a>(...)</dt><dd><tt>Remove&nbsp;all&nbsp;elements&nbsp;from&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-extend"><strong>extend</strong></a>(...)</dt><dd><tt>Append&nbsp;elements&nbsp;from&nbsp;iterable&nbsp;at&nbsp;the&nbsp;right&nbsp;side&nbsp;of&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-extendleft"><strong>extendleft</strong></a>(...)</dt><dd><tt>Append&nbsp;elements&nbsp;from&nbsp;iterable&nbsp;at&nbsp;the&nbsp;left&nbsp;side&nbsp;of&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-extendright"><strong>extendright</strong></a>(...)</dt><dd><tt>Append&nbsp;elements&nbsp;from&nbsp;iterable&nbsp;at&nbsp;the&nbsp;right&nbsp;side&nbsp;of&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-index"><strong>index</strong></a>(...)</dt><dd><tt>Returns&nbsp;the&nbsp;first&nbsp;index&nbsp;of&nbsp;a&nbsp;value</tt></dd></dl>
+
+<dl><dt><a name="dllist-insert"><strong>insert</strong></a>(...)</dt><dd><tt>Inserts&nbsp;element&nbsp;before&nbsp;node</tt></dd></dl>
+
+<dl><dt><a name="dllist-nodeat"><strong>nodeat</strong></a>(...)</dt><dd><tt>Return&nbsp;node&nbsp;at&nbsp;index</tt></dd></dl>
+
+<dl><dt><a name="dllist-pop"><strong>pop</strong></a>(...)</dt><dd><tt>Remove&nbsp;an&nbsp;element&nbsp;by&nbsp;index&nbsp;from&nbsp;the&nbsp;list&nbsp;and&nbsp;return&nbsp;it,&nbsp;or&nbsp;last&nbsp;item&nbsp;if&nbsp;no&nbsp;index&nbsp;provided</tt></dd></dl>
+
+<dl><dt><a name="dllist-popleft"><strong>popleft</strong></a>(...)</dt><dd><tt>Remove&nbsp;first&nbsp;element&nbsp;from&nbsp;the&nbsp;list&nbsp;and&nbsp;return&nbsp;it</tt></dd></dl>
+
+<dl><dt><a name="dllist-popright"><strong>popright</strong></a>(...)</dt><dd><tt>Remove&nbsp;last&nbsp;element&nbsp;from&nbsp;the&nbsp;list&nbsp;and&nbsp;return&nbsp;it</tt></dd></dl>
+
+<dl><dt><a name="dllist-remove"><strong>remove</strong></a>(...)</dt><dd><tt>Remove&nbsp;element&nbsp;from&nbsp;the&nbsp;list</tt></dd></dl>
+
+<dl><dt><a name="dllist-rindex"><strong>rindex</strong></a>(...)</dt><dd><tt>Returns&nbsp;the&nbsp;last&nbsp;index&nbsp;of&nbsp;a&nbsp;value</tt></dd></dl>
+
+<dl><dt><a name="dllist-rotate"><strong>rotate</strong></a>(...)</dt><dd><tt>Rotate&nbsp;the&nbsp;list&nbsp;n&nbsp;steps&nbsp;to&nbsp;the&nbsp;right</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>first</strong></dt>
+<dd><tt>First&nbsp;node</tt></dd>
+</dl>
+<dl><dt><strong>last</strong></dt>
+<dd><tt>Next&nbsp;node</tt></dd>
+</dl>
+<dl><dt><strong>middle</strong></dt>
+<dd><tt>Middle&nbsp;node</tt></dd>
+</dl>
+<dl><dt><strong>size</strong></dt>
+<dd><tt>Number&nbsp;of&nbsp;elements&nbsp;in&nbsp;the&nbsp;list</tt></dd>
+</dl>
+<hr>
+Data and other attributes defined here:<br>
+<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#cllist.dllist-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
+
+</td></tr></table>
+</body></html>