123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224 |
|
/*******************************************************************************
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 (scope 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 a generic iterator for contained elements
***********************************************************************/
@property 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;
}
/***********************************************************************
Configure the assigned allocator with the size of each
allocation block (number of nodes allocated at one time)
and the number of nodes to pre-populate the cache with.
Time complexity: O(n)
***********************************************************************/
final CircularList cache (size_t chunk, size_t count=0)
{
heap.config (chunk, count);
return this;
}
/***********************************************************************
***********************************************************************/
final int opApply (scope int delegate(ref V value) dg)
{
return iterator.opApply (dg);
}
/***********************************************************************
Return the number of elements contained
***********************************************************************/
@property final const size_t size ()
{
return count;
}
/***********************************************************************
Make an independent copy of the list. Elements themselves
are not cloned
***********************************************************************/
@property 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 const 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
***************************************************************/
@property 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
***************************************************************/
@property 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 (scope 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.cache (1000, 1_000_000);
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;
}
}
|