1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219 |
|
/*******************************************************************************
copyright: Copyright (c) 2008 Kris Bell. All rights reserved
license: BSD style: $(LICENSE)
version: Apr 2008: Initial release
authors: Kris
Since: 0.99.7
Based upon Doug Lea's Java collection package
*******************************************************************************/
module tango.util.container.CircularList;
private import tango.util.container.Clink;
public import tango.util.container.Container;
private import tango.util.container.model.IContainer;
/*******************************************************************************
Circular linked list
---
Iterator iterator ()
int opApply (int delegate(ref V value) dg)
CircularList add (V element)
CircularList addAt (size_t index, V element)
CircularList append (V element)
CircularList prepend (V element)
size_t addAt (size_t index, IContainer!(V) e)
size_t append (IContainer!(V) e)
size_t prepend (IContainer!(V) e)
bool take (ref V v)
bool contains (V element)
V get (size_t index)
size_t first (V element, size_t startingIndex = 0)
size_t last (V element, size_t startingIndex = 0)
V head ()
V tail ()
V head (V element)
V tail (V element)
V removeHead ()
V removeTail ()
bool removeAt (size_t index)
size_t remove (V element, bool all)
size_t removeRange (size_t fromIndex, size_t toIndex)
size_t replace (V oldElement, V newElement, bool all)
bool replaceAt (size_t index, V element)
size_t size ()
bool isEmpty ()
V[] toArray (V[] dst)
CircularList dup ()
CircularList subset (size_t from, size_t length)
CircularList clear ()
CircularList reset ()
CircularList check ()
---
*******************************************************************************/
class CircularList (V, alias Reap = Container.reap,
alias Heap = Container.DefaultCollect)
: IContainer!(V)
{
// use this type for Allocator configuration
public alias Clink!(V) Type;
private alias Type *Ref;
private alias Heap!(Type) Alloc;
// number of elements contained
private size_t count;
// configured heap manager
private Alloc heap;
// mutation tag updates on each change
private size_t mutation;
// head of the list. Null if empty
private Ref list;
/***********************************************************************
Make an empty list
***********************************************************************/
this ()
{
this (null, 0);
}
/***********************************************************************
Make an configured list
***********************************************************************/
protected this (Ref h, size_t c)
{
list = h;
count = c;
}
/***********************************************************************
Clean up when deleted
***********************************************************************/
~this ()
{
reset;
}
/***********************************************************************
Return the configured allocator
***********************************************************************/
final Alloc allocator ()
{
return heap;
}
/***********************************************************************
Return a generic iterator for contained elements
***********************************************************************/
final Iterator iterator ()
{
// used to be Iterator i = void, but that doesn't initialize
// fields that are not initialized here.
Iterator i;
i.owner = this;
i.mutation = mutation;
i.cell = i.head = list;
i.count = count;
i.index = 0;
return i;
}
/***********************************************************************
***********************************************************************/
final int opApply (int delegate(ref V value) dg)
{
return iterator.opApply (dg);
}
/***********************************************************************
Return the number of elements contained
***********************************************************************/
final size_t size ()
{
return count;
}
/***********************************************************************
Make an independent copy of the list. Elements themselves
are not cloned
***********************************************************************/
final CircularList dup ()
{
return new CircularList!(V, Reap, Heap) (list ? list.copyList(&heap.allocate) : null, count);
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final bool contains (V element)
{
if (list)
return list.find (element) !is null;
return false;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final V head ()
{
return firstCell.value;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final V tail ()
{
return lastCell.value;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final V get (size_t index)
{
return cellAt(index).value;
}
/***********************************************************************
Time complexity: O(n)
Returns size_t.max if no element found.
***********************************************************************/
final size_t first (V element, size_t startingIndex = 0)
{
if (startingIndex < 0)
startingIndex = 0;
auto p = list;
if (p is null)
return size_t.max;
for (size_t i = 0; true; ++i)
{
if (i >= startingIndex && element == p.value)
return i;
p = p.next;
if (p is list)
break;
}
return size_t.max;
}
/***********************************************************************
Time complexity: O(n)
Returns size_t.max if no element found.
***********************************************************************/
final size_t last (V element, size_t startingIndex = 0)
{
if (count is 0)
return size_t.max;
if (startingIndex >= count)
startingIndex = count - 1;
if (startingIndex < 0)
startingIndex = 0;
auto p = cellAt (startingIndex);
size_t i = startingIndex;
for (;;)
{
if (element == p.value)
return i;
else
if (p is list)
break;
else
{
p = p.prev;
--i;
}
}
return size_t.max;
}
/***********************************************************************
Time complexity: O(length)
***********************************************************************/
final CircularList subset (size_t from, size_t length)
{
Ref newlist = null;
if (length > 0)
{
checkIndex (from);
auto p = cellAt (from);
auto current = newlist = heap.allocate.set (p.value);
for (size_t i = 1; i < length; ++i)
{
p = p.next;
if (p is null)
length = i;
else
{
current.addNext (p.value, &heap.allocate);
current = current.next;
}
}
}
return new CircularList (newlist, length);
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final CircularList clear ()
{
return clear (false);
}
/***********************************************************************
Reset the HashMap contents and optionally configure a new
heap manager. This releases more memory than clear() does
Time complexity: O(n)
***********************************************************************/
final CircularList reset ()
{
return clear (true);
}
/***********************************************************************
Time complexity: O(n)
Takes the last element on the list
***********************************************************************/
final bool take (ref V v)
{
if (count)
{
v = tail;
removeTail ();
return true;
}
return false;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final CircularList prepend (V element)
{
if (list is null)
list = heap.allocate.set (element);
else
list = list.addPrev (element, &heap.allocate);
increment;
return this;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final V head (V element)
{
auto p = firstCell;
auto v = p.value;
p.value = element;
mutate;
return v;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final V removeHead ()
{
auto p = firstCell;
if (p.singleton)
list = null;
else
{
auto n = p.next;
p.unlink;
list = n;
}
auto v = p.value;
decrement (p);
return v;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final CircularList add (V element)
{
return append (element);
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final CircularList append (V element)
{
if (list is null)
prepend (element);
else
{
list.prev.addNext (element, &heap.allocate);
increment;
}
return this;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final V tail (V element)
{
auto p = lastCell;
auto v = p.value;
p.value = element;
mutate;
return v;
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
final V removeTail ()
{
auto p = lastCell;
if (p is list)
list = null;
else
p.unlink;
auto v = p.value;
decrement (p);
return v;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final CircularList addAt (size_t index, V element)
{
if (index is 0)
prepend (element);
else
{
cellAt(index - 1).addNext(element, &heap.allocate);
increment;
}
return this;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final CircularList replaceAt (size_t index, V element)
{
cellAt(index).value = element;
mutate;
return this;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final CircularList removeAt (size_t index)
{
if (index is 0)
removeHead;
else
{
auto p = cellAt(index);
p.unlink;
decrement (p);
}
return this;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final size_t remove (V element, bool all)
{
auto c = count;
if (list)
{
auto p = list;
for (;;)
{
auto n = p.next;
if (element == p.value)
{
p.unlink;
decrement (p);
if (p is list)
{
if (p is n)
{
list = null;
break;
}
else
list = n;
}
if (! all)
break;
else
p = n;
}
else
if (n is list)
break;
else
p = n;
}
}
return c - count;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final size_t replace (V oldElement, V newElement, bool all)
{
size_t c;
if (list)
{
auto p = list;
do {
if (oldElement == p.value)
{
++c;
mutate;
p.value = newElement;
if (! all)
break;
}
p = p.next;
} while (p !is list);
}
return c;
}
/***********************************************************************
Time complexity: O(number of elements in e)
***********************************************************************/
final size_t prepend (IContainer!(V) e)
{
Ref hd = null;
Ref current = null;
auto c = count;
foreach (element; e)
{
increment;
if (hd is null)
{
hd = heap.allocate.set(element);
current = hd;
}
else
{
current.addNext (element, &heap.allocate);
current = current.next;
}
}
if (list is null)
list = hd;
else
if (hd)
{
auto tl = list.prev;
current.next = list;
list.prev = current;
tl.next = hd;
hd.prev = tl;
list = hd;
}
return count - c;
}
/***********************************************************************
Time complexity: O(number of elements in e)
***********************************************************************/
final size_t append (IContainer!(V) e)
{
auto c = count;
if (list is null)
prepend (e);
else
{
auto current = list.prev;
foreach (element; e)
{
increment;
current.addNext (element, &heap.allocate);
current = current.next;
}
}
return count - c;
}
/***********************************************************************
Time complexity: O(size() + number of elements in e)
***********************************************************************/
final size_t addAt (size_t index, IContainer!(V) e)
{
auto c = count;
if (list is null || index is 0)
prepend (e);
else
{
auto current = cellAt (index - 1);
foreach (element; e)
{
increment;
current.addNext (element, &heap.allocate);
current = current.next;
}
}
return count - c;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
final size_t removeRange (size_t fromIndex, size_t toIndex)
{
auto p = cellAt (fromIndex);
auto last = list.prev;
auto c = count;
for (size_t i = fromIndex; i <= toIndex; ++i)
{
auto n = p.next;
p.unlink;
decrement (p);
if (p is list)
{
if (p is last)
{
list = null;
break;
}
else
list = n;
}
p = n;
}
return c - count;
}
/***********************************************************************
Copy and return the contained set of values in an array,
using the optional dst as a recipient (which is resized
as necessary).
Returns a slice of dst representing the container values.
Time complexity: O(n)
***********************************************************************/
final V[] toArray (V[] dst = null)
{
if (dst.length < count)
dst.length = count;
size_t i = 0;
foreach (v; this)
dst[i++] = v;
return dst [0 .. count];
}
/***********************************************************************
Is this container empty?
Time complexity: O(1)
***********************************************************************/
final bool isEmpty ()
{
return count is 0;
}
/***********************************************************************
***********************************************************************/
final CircularList check()
{
assert(((count is 0) is (list is null)));
assert((list is null || list.size is count));
if (list)
{
size_t c = 0;
auto p = list;
do {
assert(p.prev.next is p);
assert(p.next.prev is p);
assert(instances(p.value) > 0);
assert(contains(p.value));
p = p.next;
++c;
} while (p !is list);
assert(c is size);
}
return this;
}
/***********************************************************************
Time complexity: O(n)
***********************************************************************/
private size_t instances (V element)
{
if (list)
return list.count (element);
return 0;
}
/***********************************************************************
***********************************************************************/
private void checkIndex (size_t i)
{
if (i >= count)
throw new Exception ("out of range");
}
/***********************************************************************
return the first cell, or throw exception if empty
***********************************************************************/
private Ref firstCell ()
{
checkIndex (0);
return list;
}
/***********************************************************************
return the last cell, or throw exception if empty
***********************************************************************/
private Ref lastCell ()
{
checkIndex (0);
return list.prev;
}
/***********************************************************************
return the index'th cell, or throw exception if bad index
***********************************************************************/
private Ref cellAt (size_t index)
{
checkIndex (index);
return list.nth (index);
}
/***********************************************************************
Time complexity: O(1)
***********************************************************************/
private CircularList clear (bool all)
{
mutate;
// collect each node if we can't collect all at once
if (heap.collect(all) is false && count)
{
auto p = list;
do {
auto n = p.next;
decrement (p);
p = n;
} while (p != list);
}
list = null;
count = 0;
return this;
}
/***********************************************************************
new element was added
***********************************************************************/
private void increment ()
{
++mutation;
++count;
}
/***********************************************************************
element was removed
***********************************************************************/
private void decrement (Ref p)
{
Reap (p.value);
heap.collect (p);
++mutation;
--count;
}
/***********************************************************************
set was changed
***********************************************************************/
private void mutate ()
{
++mutation;
}
/***********************************************************************
Iterator with no filtering
***********************************************************************/
private struct Iterator
{
bool rev;
Ref cell,
head,
prior;
CircularList owner;
size_t index,
count;
size_t mutation;
/***************************************************************
Did the container change underneath us?
***************************************************************/
bool valid ()
{
return owner.mutation is mutation;
}
/***************************************************************
Accesses the next value, and returns false when
there are no further values to traverse
***************************************************************/
bool next (ref V v)
{
auto n = next;
return (n) ? v = *n, true : false;
}
/***************************************************************
Return a pointer to the next value, or null when
there are no further values to traverse
***************************************************************/
V* next ()
{
V* r;
if (index < count)
{
++index;
prior = cell;
r = &cell.value;
cell = (rev ? cell.prev : cell.next);
}
else
cell = null;
return r;
}
/***************************************************************
Foreach support
***************************************************************/
int opApply (int delegate(ref V value) dg)
{
int result;
auto c = cell;
while (index < count)
{
++index;
prior = c;
c = (rev ? c.prev : c.next);
if ((result = dg(prior.value)) != 0)
break;
}
cell = null;
return result;
}
/***************************************************************
Remove value that was just iterated.
***************************************************************/
bool remove ()
{
if (prior)
{
auto next = (rev ? prior.prev : prior.next);
if (prior is head)
{
if (prior is next)
owner.list = null;
else
head = owner.list = next;
}
prior.unlink;
owner.decrement (prior);
prior = null;
--count;
// ignore this change
++mutation;
return true;
}
return false;
}
/***************************************************************
Insert a new value before the node about to be
iterated (or after the node that was just iterated).
Returns: a copy of this iterator for chaining.
***************************************************************/
Iterator insert (V value)
{
// Note: this needs some attention, not sure how
// to handle when iterator is in reverse.
if (cell is null)
prior.addNext (value, &owner.heap.allocate);
else
cell.addPrev (value, &owner.heap.allocate);
owner.increment;
++count;
// ignore this change
++mutation;
return *this;
}
/***************************************************************
Flip the direction of next() and opApply(), and
reset the termination point such that we can do
another full traversal.
***************************************************************/
Iterator reverse ()
{
rev ^= true;
next;
index = 0;
return *this;
}
}
}
/*******************************************************************************
*******************************************************************************/
debug (UnitTest)
{
unittest
{
auto list = new CircularList!(int);
list.add(1);
list.add(2);
list.add(3);
int i = 1;
foreach(v; list)
{
assert(v == i);
i++;
}
auto iter = list.iterator;
iter.next();
iter.remove(); // delete the first item
i = 2;
foreach(v; list)
{
assert(v == i);
i++;
}
// test insert functionality
iter = list.iterator;
iter.next;
iter.insert(4);
int[] compareto = [2, 4, 3];
i = 0;
foreach(v; list)
{
assert(v == compareto[i++]);
}
}
}
/*******************************************************************************
*******************************************************************************/
debug (CircularList)
{
import tango.io.Stdout;
import tango.core.Thread;
import tango.time.StopWatch;
void main()
{
// usage examples ...
auto list = new CircularList!(char[]);
foreach (value; list)
Stdout (value).newline;
list.add ("foo");
list.add ("bar");
list.add ("wumpus");
// implicit generic iteration
foreach (value; list)
Stdout (value).newline;
// explicit generic iteration
foreach (value; list.iterator.reverse)
Stdout.formatln ("> {}", value);
// generic iteration with optional remove
auto s = list.iterator;
foreach (value; s)
{} //s.remove;
// incremental iteration, with optional remove
char[] v;
auto iterator = list.iterator;
while (iterator.next(v))
{}//iterator.remove;
// incremental iteration, with optional failfast
auto it = list.iterator;
while (it.valid && it.next(v))
{}
// remove specific element
list.remove ("wumpus", false);
// remove first element ...
while (list.take(v))
Stdout.formatln ("taking {}, {} left", v, list.size);
// setup for benchmark, with a set of integers. We
// use a chunk allocator, and presize the bucket[]
auto test = new CircularList!(uint, Container.reap, Container.Chunk);
test.allocator.config (1000, 1000);
const count = 1_000_000;
StopWatch w;
// benchmark adding
w.start;
for (uint i=count; i--;)
test.add(i);
Stdout.formatln ("{} adds: {}/s", test.size, test.size/w.stop);
// benchmark adding without allocation overhead
test.clear;
w.start;
for (uint i=count; i--;)
test.add(i);
Stdout.formatln ("{} adds (after clear): {}/s", test.size, test.size/w.stop);
// benchmark duplication
w.start;
auto dup = test.dup;
Stdout.formatln ("{} element dup: {}/s", dup.size, dup.size/w.stop);
// benchmark iteration
w.start;
foreach (value; test) {}
Stdout.formatln ("{} element iteration: {}/s", test.size, test.size/w.stop);
test.check;
}
}
|