* Elaborate on the invariant comments and make them more precise.

* Change the centering by one to make it possible to test the module
  with BLOCKLEN's as low as two.  Testing small blocks makes end-point
  errors surface more readily.
This commit is contained in:
Raymond Hettinger 2004-10-01 06:24:12 +00:00
parent cf8997f6f8
commit 61f05fb96d
1 changed files with 28 additions and 14 deletions

View File

@ -8,20 +8,33 @@
*/ */
#define BLOCKLEN 46 #define BLOCKLEN 46
#define CENTER ((BLOCKLEN - 1) / 2)
/* A `dequeobject` is composed of a doubly-linked list of `block` nodes. /* A `dequeobject` is composed of a doubly-linked list of `block` nodes.
* This list is not circular (the leftmost block has leftlink==NULL, * This list is not circular (the leftmost block has leftlink==NULL,
* and the rightmost block has rightlink==NULL). A deque d's first * and the rightmost block has rightlink==NULL). A deque d's first
* element is at d.leftblock[leftindex] and its last element is at * element is at d.leftblock[leftindex] and its last element is at
* d.rightblock[rightindex]; note that, unlike as for Python slice * d.rightblock[rightindex]; note that, unlike as for Python slice
* indices, these indices are inclusive on both ends. * indices, these indices are inclusive on both ends. By being inclusive
* The list of blocks is never empty. An empty deque d has * on both ends, algorithms for left and right operations become
* d.leftblock == d.rightblock != NULL; d.len == 0; and * symmetrical which simplifies the design.
* d.leftindex > d.rightindex; checking for d.len == 0 is the intended *
* way to see whether d is empty. * The list of blocks is never empty, so d.leftblock and d.rightblock
* Note that since d.leftindex and d.rightindex may be indices into * are never equal to NULL.
* distinct blocks (and certainly are, for any d with len(d) > BLOCKLEN), *
* it's not generally true that d.leftindex <= d.rightindex. * The indices, d.leftindex and d.rightindex are always in the range
* 0 <= index < BLOCKLEN.
*
* Empty deques have d.len == 0; d.leftblock==d.rightblock;
* d.leftindex == CENTER+1; and d.rightindex == CENTER.
* Checking for d.len == 0 is the intended way to see whether d is empty.
*
* Whenever d.leftblock == d.rightblock,
* d.leftindex + d.len == d.rightindex + 1.
*
* However, when d.leftblock != rightblock, d.leftindex and d.rightindex
* are indices into distinct blocks and have no relationship to one
* another (for example, sometimes d.leftindex > d.rightindex).
*/ */
typedef struct BLOCK { typedef struct BLOCK {
@ -71,10 +84,11 @@ deque_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
return NULL; return NULL;
} }
assert(BLOCKLEN >= 2);
deque->leftblock = b; deque->leftblock = b;
deque->rightblock = b; deque->rightblock = b;
deque->leftindex = BLOCKLEN / 2 + 1; deque->leftindex = CENTER + 1;
deque->rightindex = BLOCKLEN / 2; deque->rightindex = CENTER;
deque->len = 0; deque->len = 0;
deque->weakreflist = NULL; deque->weakreflist = NULL;
@ -142,8 +156,8 @@ deque_pop(dequeobject *deque, PyObject *unused)
assert(deque->leftblock == deque->rightblock); assert(deque->leftblock == deque->rightblock);
assert(deque->leftindex == deque->rightindex+1); assert(deque->leftindex == deque->rightindex+1);
/* re-center instead of freeing a block */ /* re-center instead of freeing a block */
deque->leftindex = BLOCKLEN / 2 + 1; deque->leftindex = CENTER + 1;
deque->rightindex = BLOCKLEN / 2; deque->rightindex = CENTER;
} else { } else {
prevblock = deque->rightblock->leftlink; prevblock = deque->rightblock->leftlink;
assert(deque->leftblock != deque->rightblock); assert(deque->leftblock != deque->rightblock);
@ -177,8 +191,8 @@ deque_popleft(dequeobject *deque, PyObject *unused)
assert(deque->leftblock == deque->rightblock); assert(deque->leftblock == deque->rightblock);
assert(deque->leftindex == deque->rightindex+1); assert(deque->leftindex == deque->rightindex+1);
/* re-center instead of freeing a block */ /* re-center instead of freeing a block */
deque->leftindex = BLOCKLEN / 2 + 1; deque->leftindex = CENTER + 1;
deque->rightindex = BLOCKLEN / 2; deque->rightindex = CENTER;
} else { } else {
assert(deque->leftblock != deque->rightblock); assert(deque->leftblock != deque->rightblock);
prevblock = deque->leftblock->rightlink; prevblock = deque->leftblock->rightlink;