OoasTools

/*

 Copyright (c) 2003-2006 Niels Kokholm and Peter Sestoft

 Permission is hereby granted, free of charge, to any person obtaining a copy

 of this software and associated documentation files (the "Software"), to deal

 in the Software without restriction, including without limitation the rights

 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 copies of the Software, and to permit persons to whom the Software is

 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in

 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 SOFTWARE.

*/

#define HASHINDEXnot

using System;

using System.Diagnostics;

using SCG = System.Collections.Generic;

namespace C5

{

  /// <summary>

  /// A list collection based on a plain dynamic array data structure.

  /// Expansion of the internal array is performed by doubling on demand. 

  /// The internal array is only shrinked by the Clear method. 

  ///

  /// <i>When the FIFO property is set to false this class works fine as a stack of T.

  /// When the FIFO property is set to true the class will function as a (FIFO) queue

  /// but very inefficiently, use a LinkedList (<see cref="T:C5.LinkedList`1"/>) instead.</i>

  /// </summary>

  [Serializable]

  public class ArrayList<T> : ArrayBase<T>, IList<T>, SCG.IList<T>

#if HASHINDEX

#else

, IStack<T>, IQueue<T>

#endif

  {

    #region Fields

    /// <summary>

    /// Has this list or view not been invalidated by some operation (by someone calling Dispose())

    /// </summary>

    bool isValid = true;

    //TODO: wonder if we should save some memory on none-view situations by 

    //      putting these three fields into a single ref field?

    /// <summary>

    /// The underlying list if we are a view, null else.

    /// </summary>

    ArrayList<T> underlying;

    WeakViewList<ArrayList<T>> views;

    WeakViewList<ArrayList<T>>.Node myWeakReference;

    /// <summary>

    /// The size of the underlying list.

    /// </summary>

    int underlyingsize { get { return (underlying ?? this).size; } }

    /// <summary>

    /// The underlying field of the FIFO property

    /// </summary>

    bool fIFO = false;

#if HASHINDEX

    HashSet<KeyValuePair<T, int>> itemIndex;

#endif

    #endregion

    #region Events

    /// <summary>

    /// 

    /// </summary>

    /// <value></value>

    public override EventTypeEnum ListenableEvents { get { return underlying == null ? EventTypeEnum.All : EventTypeEnum.None; } }

    /*

        /// <summary>

        /// 

        /// </summary>

        /// <value></value>

        public override event CollectionChangedHandler<T> CollectionChanged

        {

          add

          {

            if (underlying == null)

              base.CollectionChanged += value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

          remove

          {

            if (underlying == null)

              base.CollectionChanged -= value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

        }

        /// <summary>

        /// 

        /// </summary>

        /// <value></value>

        public override event CollectionClearedHandler<T> CollectionCleared

        {

          add

          {

            if (underlying == null)

              base.CollectionCleared += value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

          remove

          {

            if (underlying == null)

              base.CollectionCleared -= value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

        }

        /// <summary>

        /// 

        /// </summary>

        /// <value></value>

        public override event ItemsAddedHandler<T> ItemsAdded

        {

          add

          {

            if (underlying == null)

              base.ItemsAdded += value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

          remove

          {

            if (underlying == null)

              base.ItemsAdded -= value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

        }

        /// <summary>

        /// 

        /// </summary>

        /// <value></value>

        public override event ItemInsertedHandler<T> ItemInserted

        {

          add

          {

            if (underlying == null)

              base.ItemInserted += value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

          remove

          {

            if (underlying == null)

              base.ItemInserted -= value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

        }

        /// <summary>

        /// 

        /// </summary>

        /// <value></value>

        public override event ItemsRemovedHandler<T> ItemsRemoved

        {

          add

          {

            if (underlying == null)

              base.ItemsRemoved += value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

          remove

          {

            if (underlying == null)

              base.ItemsRemoved -= value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

        }

        /// <summary>

        /// 

        /// </summary>

        /// <value></value>

        public override event ItemRemovedAtHandler<T> ItemRemovedAt

        {

          add

          {

            if (underlying == null)

              base.ItemRemovedAt += value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

          remove

          {

            if (underlying == null)

              base.ItemRemovedAt -= value;

            else

              throw new UnlistenableEventException("Can't listen to a view");

          }

        }

          */

    #endregion

    #region Util

    bool equals(T i1, T i2) { return itemequalityComparer.Equals(i1, i2); }

    /// <summary>

    /// Increment or decrement the private size fields

    /// </summary>

    /// <param name="delta">Increment (with sign)</param>

    void addtosize(int delta)

    {

      size += delta;

      if (underlying != null)

        underlying.size += delta;

    }

    #region Array handling

    /// <summary>

    /// Double the size of the internal array.

    /// </summary>

    protected override void expand()

    { expand(2 * array.Length, underlyingsize); }

    /// <summary>

    /// Expand the internal array, resetting the index of the first unused element.

    /// </summary>

    /// <param name="newcapacity">The new capacity (will be rouded upwards to a power of 2).</param>

    /// <param name="newsize">The new count of </param>

    protected override void expand(int newcapacity, int newsize)

    {

      if (underlying != null)

        underlying.expand(newcapacity, newsize);

      else

      {

        base.expand(newcapacity, newsize);

        if (views != null)

          foreach (ArrayList<T> v in views)

            v.array = array;

      }

    }

    #endregion

    #region Checks

    /// <summary>

    /// Check if it is valid to perform updates and increment stamp if so.

    /// </summary>

    /// <exception cref="ViewDisposedException"> If check fails by this list being a disposed view.</exception>

    /// <exception cref="ReadOnlyCollectionException"> If check fails by this being a read only list.</exception>

    protected override void updatecheck()

    {

      validitycheck();

      base.updatecheck();

      if (underlying != null)

        underlying.stamp++;

    }

    /// <summary>

    /// Check if we are a view that the underlying list has only been updated through us.

    /// <para>This method should be called from enumerators etc to guard against 

    /// modification of the base collection.</para>

    /// </summary>

    /// <exception cref="ViewDisposedException"> if check fails.</exception>

    void validitycheck()

    {

      if (!isValid)

        throw new ViewDisposedException();

    }

    /// <summary>

    /// Check that the list has not been updated since a particular time.

    /// <para>To be used by enumerators and range </para>

    /// </summary>

    /// <exception cref="ViewDisposedException"> If check fails by this list being a disposed view.</exception>

    /// <exception cref="CollectionModifiedException">If the list *has* beeen updated since that  time..</exception>

    /// <param name="stamp">The stamp indicating the time.</param>

    protected override void modifycheck(int stamp)

    {

      validitycheck();

      if (this.stamp != stamp)

        throw new CollectionModifiedException();

    }

    #endregion

    #region Searching

    /// <summary>

    /// Internal version of IndexOf without modification checks.

    /// </summary>

    /// <param name="item">Item to look for</param>

    /// <returns>The index of first occurrence</returns>

    int indexOf(T item)

    {

#if HASHINDEX

      KeyValuePair<T, int> p = new KeyValuePair<T, int>(item);

      if (itemIndex.Find(ref p) && p.Value >= offset && p.Value < offset + size)

        return p.Value - offset;

#else

      for (int i = 0; i < size; i++)

        if (equals(item, array[offset + i]))

          return i;

#endif

      return ~size;

    }

    /// <summary>

    /// Internal version of LastIndexOf without modification checks.

    /// </summary>

    /// <param name="item">Item to look for</param>

    /// <returns>The index of last occurrence</returns>

    int lastIndexOf(T item)

    {

#if HASHINDEX

      return indexOf(item);

#else

      for (int i = size - 1; i >= 0; i--)

        if (equals(item, array[offset + i]))

          return i;

      return ~size;

#endif

    }

    #endregion

    #region Inserting

#if HASHINDEX

    /// <summary>

    /// Internal version of Insert with no modification checks.

    /// </summary>

    /// <exception cref="DuplicateNotAllowedException"> if item already in list.</exception>

    /// <param name="i">Index to insert at</param>

    /// <param name="item">Item to insert</param>

#else

    /// <summary>

    /// Internal version of Insert with no modification checks.

    /// </summary>

    /// <param name="i">Index to insert at</param>

    /// <param name="item">Item to insert</param>

#endif

    protected override void insert(int i, T item)

    {

#if HASHINDEX

      KeyValuePair<T, int> p = new KeyValuePair<T, int>(item, offset + i);

      if (itemIndex.FindOrAdd(ref p))

        throw new DuplicateNotAllowedException("Item already in indexed list: " + item);

#endif

      baseinsert(i, item);

#if HASHINDEX

      reindex(i + offset + 1);

#endif

    }

    private void baseinsert(int i, T item)

    {

      if (underlyingsize == array.Length)

        expand();

      i += offset;

      if (i < underlyingsize)

        Array.Copy(array, i, array, i + 1, underlyingsize - i);

      array[i] = item;

      addtosize(1);

      fixViewsAfterInsert(1, i);

    }

    #endregion

    #region Removing

    /// <summary>

    /// Internal version of RemoveAt with no modification checks.

    /// </summary>

    /// <param name="i">Index to remove at</param>

    /// <returns>The removed item</returns>

    T removeAt(int i)

    {

      i += offset;

      fixViewsBeforeSingleRemove(i);

      T retval = array[i];

      addtosize(-1);

      if (underlyingsize > i)

        Array.Copy(array, i + 1, array, i, underlyingsize - i);

      array[underlyingsize] = default(T);

#if HASHINDEX

      itemIndex.Remove(new KeyValuePair<T, int>(retval));

      reindex(i);

#endif

      return retval;

    }

    #endregion

    #region Indexing

#if HASHINDEX

    private void reindex(int start) { reindex(start, underlyingsize); }

    private void reindex(int start, int end)

    {

      for (int j = start; j < end; j++)

        itemIndex.UpdateOrAdd(new KeyValuePair<T, int>(array[j], j));

    }

#endif

    #endregion

    #region fixView utilities

    /// <summary>

    /// 

    /// </summary>

    /// <param name="added">The actual number of inserted nodes</param>

    /// <param name="realInsertionIndex"></param>

    void fixViewsAfterInsert(int added, int realInsertionIndex)

    {

      if (views != null)

        foreach (ArrayList<T> view in views)

        {

          if (view != this)

          {

            if (view.offset < realInsertionIndex && view.offset + view.size > realInsertionIndex)

              view.size += added;

            if (view.offset > realInsertionIndex || (view.offset == realInsertionIndex && view.size > 0))

              view.offset += added;

          }

        }

    }

    void fixViewsBeforeSingleRemove(int realRemovalIndex)

    {

      if (views != null)

        foreach (ArrayList<T> view in views)

        {

          if (view != this)

          {

            if (view.offset <= realRemovalIndex && view.offset + view.size > realRemovalIndex)

              view.size--;

            if (view.offset > realRemovalIndex)

              view.offset--;

          }

        }

    }

    /// <summary>

    /// Fix offsets and sizes of other views before removing an interval from this 

    /// </summary>

    /// <param name="start">the start of the interval relative to the array/underlying</param>

    /// <param name="count"></param>

    void fixViewsBeforeRemove(int start, int count)

    {

      int clearend = start + count - 1;

      if (views != null)

        foreach (ArrayList<T> view in views)

        {

          if (view == this)

            continue;

          int viewoffset = view.offset, viewend = viewoffset + view.size - 1;

          if (start < viewoffset)

          {

            if (clearend < viewoffset)

              view.offset = viewoffset - count;

            else

            {

              view.offset = start;

              view.size = clearend < viewend ? viewend - clearend : 0;

            }

          }

          else if (start <= viewend)

            view.size = clearend <= viewend ? view.size - count : start - viewoffset;

        }

    }

    /// <summary>

    /// 

    /// </summary>

    /// <param name="otherOffset"></param>

    /// <param name="otherSize"></param>

    /// <returns>The position of View(otherOffset, otherSize) wrt. this view</returns>

    MutualViewPosition viewPosition(int otherOffset, int otherSize)

    {

      int end = offset + size, otherEnd = otherOffset + otherSize;

      if (otherOffset >= end || otherEnd <= offset)

        return MutualViewPosition.NonOverlapping;

      if (size == 0 || (otherOffset <= offset && end <= otherEnd))

        return MutualViewPosition.Contains;

      if (otherSize == 0 || (offset <= otherOffset && otherEnd <= end))

        return MutualViewPosition.ContainedIn;

      return MutualViewPosition.Overlapping;

    }

    //TODO: make version that fits the new, more forgiving rules for disposing

    void disposeOverlappingViews(bool reverse)

    {

      if (views != null)

        foreach (ArrayList<T> view in views)

        {

          if (view != this)

          {

            switch (viewPosition(view.offset, view.size))

            {

              case MutualViewPosition.ContainedIn:

                if (reverse)

                  view.offset = 2 * offset + size - view.size - view.offset;

                else

                  view.Dispose();

                break;

              case MutualViewPosition.Overlapping:

                view.Dispose();

                break;

              case MutualViewPosition.Contains:

              case MutualViewPosition.NonOverlapping:

                break;

            }

          }

        }

    }

    #endregion

    #endregion

    #region Position, PositionComparer and ViewHandler nested types

    class PositionComparer : SCG.IComparer<Position>

    {

      public int Compare(Position a, Position b)

      {

        return a.index.CompareTo(b.index);

      }

    }

    /// <summary>

    /// During RemoveAll, we need to cache the original endpoint indices of views (??? also for ArrayList?)

    /// </summary>

    struct Position

    {

      public readonly ArrayList<T> view;

      public readonly int index;

      public Position(ArrayList<T> view, bool left)

      {

        this.view = view;

        index = left ? view.offset : view.offset + view.size - 1;

      }

      public Position(int index) { this.index = index; view = null; }

    }

    /// <summary>

    /// Handle the update of (other) views during a multi-remove operation.

    /// </summary>

    struct ViewHandler

    {

      ArrayList<Position> leftEnds;

      ArrayList<Position> rightEnds;

      int leftEndIndex, rightEndIndex;

      internal readonly int viewCount;

      internal ViewHandler(ArrayList<T> list)

      {

        leftEndIndex = rightEndIndex = viewCount = 0;

        leftEnds = rightEnds = null;

        if (list.views != null)

          foreach (ArrayList<T> v in list.views)

            if (v != list)

            {

              if (leftEnds == null)

              {

                leftEnds = new ArrayList<Position>();

                rightEnds = new ArrayList<Position>();

              }

              leftEnds.Add(new Position(v, true));

              rightEnds.Add(new Position(v, false));

            }

        if (leftEnds == null)

          return;

        viewCount = leftEnds.Count;

        leftEnds.Sort(new PositionComparer());

        rightEnds.Sort(new PositionComparer());

      }

      /// <summary>

      /// This is to be called with realindex pointing to the first node to be removed after a (stretch of) node that was not removed

      /// </summary>

      /// <param name="removed"></param>

      /// <param name="realindex"></param>

      internal void skipEndpoints(int removed, int realindex)

      {

        if (viewCount > 0)

        {

          Position endpoint;

          while (leftEndIndex < viewCount && (endpoint = leftEnds[leftEndIndex]).index <= realindex)

          {

            ArrayList<T> view = endpoint.view;

            view.offset = view.offset - removed;

            view.size += removed;

            leftEndIndex++;

          }

          while (rightEndIndex < viewCount && (endpoint = rightEnds[rightEndIndex]).index < realindex)

          {

            endpoint.view.size -= removed;

            rightEndIndex++;

          }

        }

      }

      internal void updateViewSizesAndCounts(int removed, int realindex)

      {

        if (viewCount > 0)

        {

          Position endpoint;

          while (leftEndIndex < viewCount && (endpoint = leftEnds[leftEndIndex]).index <= realindex)

          {

            ArrayList<T> view = endpoint.view;

            view.offset = view.Offset - removed;

            view.size += removed;

            leftEndIndex++;

          }

          while (rightEndIndex < viewCount && (endpoint = rightEnds[rightEndIndex]).index < realindex)

          {

            endpoint.view.size -= removed;

            rightEndIndex++;

          }

        }

      }

    }

    #endregion

    #region Constructors

    /// <summary>

    /// Create an array list with default item equalityComparer and initial capacity 8 items.

    /// </summary>

    public ArrayList() : this(8) { }

    /// <summary>

    /// Create an array list with external item equalityComparer and initial capacity 8 items.

    /// </summary>

    /// <param name="itemequalityComparer">The external item equalityComparer</param>

    public ArrayList(SCG.IEqualityComparer<T> itemequalityComparer) : this(8, itemequalityComparer) { }

    /// <summary>

    /// Create an array list with default item equalityComparer and prescribed initial capacity.

    /// </summary>

    /// <param name="capacity">The prescribed capacity</param>

    public ArrayList(int capacity) : this(capacity, EqualityComparer<T>.Default) { }

    /// <summary>

    /// Create an array list with external item equalityComparer and prescribed initial capacity.

    /// </summary>

    /// <param name="capacity">The prescribed capacity</param>

    /// <param name="itemequalityComparer">The external item equalityComparer</param>

    public ArrayList(int capacity, SCG.IEqualityComparer<T> itemequalityComparer)

      : base(capacity, itemequalityComparer)

    {

#if HASHINDEX

      itemIndex = new HashSet<KeyValuePair<T, int>>(new KeyValuePairEqualityComparer<T, int>(itemequalityComparer));

#endif

    }

    #endregion

    #region IList<T> Members

    /// <summary>

    /// </summary>

    /// <exception cref="NoSuchItemException"> if this list is empty.</exception>

    /// <value>The first item in this list.</value>

    [Tested]

    public virtual T First

    {

      [Tested]

      get

      {

        validitycheck();

        if (size == 0)

          throw new NoSuchItemException();

        return array[offset];

      }

    }

    /// <summary>

    /// </summary>

    /// <exception cref="NoSuchItemException"> if this list is empty.</exception>

    /// <value>The last item in this list.</value>

    [Tested]

    public virtual T Last

    {

      [Tested]

      get

      {

        validitycheck();

        if (size == 0)

          throw new NoSuchItemException();

        return array[offset + size - 1];

      }

    }

    /// <summary>

    /// Since <code>Add(T item)</code> always add at the end of the list,

    /// this describes if list has FIFO or LIFO semantics.

    /// </summary>

    /// <value>True if the <code>Remove()</code> operation removes from the

    /// start of the list, false if it removes from the end. The default for a new array list is false.</value>

    [Tested]

    public virtual bool FIFO

    {

      [Tested]

      get { validitycheck(); return fIFO; }

      [Tested]

      set { updatecheck(); fIFO = value; }

    }

    /// <summary>

    /// 

    /// </summary>

    public virtual bool IsFixedSize

    {

      get { validitycheck(); return false; }

    }

#if HASHINDEX

    /// <summary>

    /// On this list, this indexer is read/write.

    /// </summary>

    /// <exception cref="IndexOutOfRangeException"> if index is negative or

    /// &gt;= the size of the collection.</exception>

    /// <exception cref="DuplicateNotAllowedException"> By the get operation

    /// if the item already is present somewhere else in the list.</exception>

    /// <value>The index'th item of this list.</value>

    /// <param name="index">The index of the item to fetch or store.</param>

#else

    /// <summary>

    /// On this list, this indexer is read/write.

    /// </summary>

    /// <exception cref="IndexOutOfRangeException"> if index is negative or

    /// &gt;= the size of the collection.</exception>

    /// <value>The index'th item of this list.</value>

    /// <param name="index">The index of the item to fetch or store.</param>

#endif

    [Tested]

    public virtual T this[int index]

    {

      [Tested]

      get

      {

        validitycheck();

        if (index < 0 || index >= size)

          throw new IndexOutOfRangeException();

        return array[offset + index];

      }

      [Tested]

      set

      {

        updatecheck();

        if (index < 0 || index >= size)

          throw new IndexOutOfRangeException();

        index += offset;

        T item = array[index];

#if HASHINDEX

        KeyValuePair<T, int> p = new KeyValuePair<T, int>(value, index);

        if (itemequalityComparer.Equals(value, item))

        {

          array[index] = value;

          itemIndex.Update(p);

        }

        else if (!itemIndex.FindOrAdd(ref p))

        {

          itemIndex.Remove(new KeyValuePair<T, int>(item));

          array[index] = value;

        }

        else

          throw new DuplicateNotAllowedException("Item already in indexed list");

#else

        array[index] = value;

#endif

        (underlying ?? this).raiseForSetThis(index, value, item);

      }

    }

    /// <summary>

    /// 

    /// </summary>

    /// <value></value>

    public virtual Speed IndexingSpeed { get { return Speed.Constant; } }

#if HASHINDEX

    /// <summary>

    /// Insert an item at a specific index location in this list. 

    ///</summary>

    /// <exception cref="IndexOutOfRangeException"> if index is negative or

    /// &gt; the size of the collection. </exception>

    /// <exception cref="DuplicateNotAllowedException"> 

    /// If the item is already present in the list.</exception>

    /// <param name="index">The index at which to insert.</param>

    /// <param name="item">The item to insert.</param>

#else

    /// <summary>

    /// Insert an item at a specific index location in this list. 

    ///</summary>

    /// <exception cref="IndexOutOfRangeException"> if i is negative or

    /// &gt; the size of the collection. </exception>

    /// <param name="index">The index at which to insert.</param>

    /// <param name="item">The item to insert.</param>

#endif

    [Tested]

    public virtual void Insert(int index, T item)

    {

      updatecheck();

      if (index < 0 || index > size)

        throw new IndexOutOfRangeException();

      insert(index, item);

      (underlying ?? this).raiseForInsert(index + offset, item);

    }

    /// <summary>

    /// Insert an item at the end of a compatible view, used as a pointer.

    /// <para>The <code>pointer</code> must be a view on the same list as

    /// <code>this</code> and the endpoitn of <code>pointer</code> must be

    /// a valid insertion point of <code>this</code></para>

    /// </summary>

    /// <exception cref="IncompatibleViewException">If <code>pointer</code> 

    /// is not a view on or the same list as <code>this</code></exception>

    /// <exception cref="IndexOutOfRangeException"><b>??????</b> if the endpoint of 

    ///  <code>pointer</code> is not inside <code>this</code></exception>

    /// <exception cref="DuplicateNotAllowedException"> if the list has

    /// <code>AllowsDuplicates==false</code> and the item is 

    /// already in the list.</exception>

    /// <param name="pointer"></param>

    /// <param name="item"></param>

    public void Insert(IList<T> pointer, T item)

    {

      if ((pointer == null) || ((pointer.Underlying ?? pointer) != (underlying ?? this)))

        throw new IncompatibleViewException();

      Insert(pointer.Offset + pointer.Count - Offset, item);

    }

#if HASHINDEX

    /// <summary>

    /// Insert into this list all items from an enumerable collection starting 

    /// at a particular index.

    /// </summary>

    /// <exception cref="IndexOutOfRangeException"> if index is negative or

    /// &gt; the size of the collection.</exception>

    /// <exception cref="DuplicateNotAllowedException"> If <code>items</code> 

    /// contains duplicates or some item already  present in the list.</exception>

    /// <param name="index">Index to start inserting at</param>

    /// <param name="items">Items to insert</param>

#else

    /// <summary>

    /// Insert into this list all items from an enumerable collection starting 

    /// at a particular index.

    /// </summary>

    /// <exception cref="IndexOutOfRangeException"> if index is negative or

    /// &gt; the size of the collection.</exception>

    /// <param name="index">Index to start inserting at</param>

    /// <param name="items">Items to insert</param>

    /// <typeparam name="U"></typeparam>

#endif

    [Tested]

    public virtual void InsertAll<U>(int index, SCG.IEnumerable<U> items) where U : T

    {

      updatecheck();

      if (index < 0 || index > size)

        throw new IndexOutOfRangeException();

      index += offset;

      int toadd = EnumerableBase<U>.countItems(items);

      if (toadd == 0)

        return;

      if (toadd + underlyingsize > array.Length)

        expand(toadd + underlyingsize, underlyingsize);

      if (underlyingsize > index)

        Array.Copy(array, index, array, index + toadd, underlyingsize - index);

      int i = index;

      try

      {

        foreach (T item in items)

        {

#if HASHINDEX

          KeyValuePair<T, int> p = new KeyValuePair<T, int>(item, i);

          if (itemIndex.FindOrAdd(ref p))

            throw new DuplicateNotAllowedException("Item already in indexed list");

#endif

          array[i++] = item;

        }

      }

      finally

      {

        int added = i - index;

        if (added < toadd)

        {

          Array.Copy(array, index + toadd, array, i, underlyingsize - index);

          Array.Clear(array, underlyingsize + added, toadd - added);

        }

        if (added > 0)

        {

          addtosize(added);

#if HASHINDEX

          reindex(i);

#endif

          fixViewsAfterInsert(added, index);

          (underlying ?? this).raiseForInsertAll(index, added);

        }

      }

    }

    private void raiseForInsertAll(int index, int added)

    {

      if (ActiveEvents != 0)

      {

        if ((ActiveEvents & (EventTypeEnum.Added | EventTypeEnum.Inserted)) != 0)

          for (int j = index; j < index + added; j++)

          {

            raiseItemInserted(array[j], j);

            raiseItemsAdded(array[j], 1);

          }

        raiseCollectionChanged();

      }

    }

#if HASHINDEX

    /// <summary>

    /// Insert an item at the front of this list;

    /// </summary>

    /// <exception cref="DuplicateNotAllowedException">If the item is already in the list</exception>

    /// <param name="item">The item to insert.</param>

#else

    /// <summary>

    /// Insert an item at the front of this list;

    /// </summary>

    /// <param name="item">The item to insert.</param>

#endif

    [Tested]

    public virtual void InsertFirst(T item)

    {

      updatecheck();

      insert(0, item);

      (underlying ?? this).raiseForInsert(offset, item);

    }

#if HASHINDEX

    /// <summary>

    /// Insert an item at the back of this list.

    /// </summary>

    /// <exception cref="DuplicateNotAllowedException">If the item is already in the list</exception>

    /// <param name="item">The item to insert.</param>

#else

    /// <summary>

    /// Insert an item at the back of this list.

    /// </summary>

    /// <param name="item">The item to insert.</param>

#endif

    [Tested]

    public virtual void InsertLast(T item)

    {

      updatecheck();

      insert(size, item);

      (underlying ?? this).raiseForInsert(size - 1 + offset, item);

    }

    //NOTE: if the filter throws an exception, no result will be returned.

    /// <summary>

    /// Create a new list consisting of the items of this list satisfying a 

    /// certain predicate.

    /// <para>The new list will be of type ArrayList</para>

    /// </summary>

    /// <param name="filter">The filter delegate defining the predicate.</param>

    /// <returns>The new list.</returns>

    [Tested]

    public virtual IList<T> FindAll(Fun<T, bool> filter)

    {

      validitycheck();

      int stamp = this.stamp;

      ArrayList<T> res = new ArrayList<T>(itemequalityComparer);

      int j = 0, rescap = res.array.Length;

      for (int i = 0; i < size; i++)

      {

        T a = array[offset + i];

        bool found = filter(a);

        modifycheck(stamp);

        if (found)

        {

          if (j == rescap) res.expand(rescap = 2 * rescap, j);

          res.array[j++] = a;

        }

      }

      res.size = j;

#if HASHINDEX

      res.reindex(0);

#endif

      return res;

    }

#if HASHINDEX

    /// <summary>

    /// Create a new list consisting of the results of mapping all items of this

    /// list. The new list will use the default item equalityComparer for the item type V.

    /// <para>The new list will be of type ArrayList</para>

    /// </summary>

    /// <exception cref="DuplicateNotAllowedException">If <code>mapper</code>

    /// creates duplicates</exception>

    /// <typeparam name="V">The type of items of the new list</typeparam>

    /// <param name="mapper">The delegate defining the map.</param>

    /// <returns>The new list.</returns>

#else

    /// <summary>

    /// Create a new list consisting of the results of mapping all items of this

    /// list. The new list will use the default item equalityComparer for the item type V.

    /// <para>The new list will be of type ArrayList</para>

    /// </summary>

    /// <typeparam name="V">The type of items of the new list</typeparam>

    /// <param name="mapper">The delegate defining the map.</param>

    /// <returns>The new list.</returns>

#endif

    [Tested]

    public virtual IList<V> Map<V>(Fun<T, V> mapper)

    {

      validitycheck();

      ArrayList<V> res = new ArrayList<V>(size);

      return map<V>(mapper, res);

    }

#if HASHINDEX

    /// <summary>

    /// Create a new list consisting of the results of mapping all items of this

    /// list. The new list will use a specified item equalityComparer for the item type.

    /// <para>The new list will be of type ArrayList</para>

    /// </summary>

    /// <exception cref="DuplicateNotAllowedException">If <code>mapper</code>

    /// creates duplicates</exception>

    /// <typeparam name="V">The type of items of the new list</typeparam>

    /// <param name="mapper">The delegate defining the map.</param>

    /// <param name="itemequalityComparer">The item equalityComparer to use for the new list</param>

    /// <returns>The new list.</returns>

#else

    /// <summary>

    /// Create a new list consisting of the results of mapping all items of this

    /// list. The new list will use a specified item equalityComparer for the item type.

    /// <para>The new list will be of type ArrayList</para>

    /// </summary>

    /// <typeparam name="V">The type of items of the new list</typeparam>

    /// <param name="mapper">The delegate defining the map.</param>

    /// <param name="itemequalityComparer">The item equalityComparer to use for the new list</param>

    /// <returns>The new list.</returns>

#endif

    public virtual IList<V> Map<V>(Fun<T, V> mapper, SCG.IEqualityComparer<V> itemequalityComparer)

    {

      validitycheck();

      ArrayList<V> res = new ArrayList<V>(size, itemequalityComparer);

      return map<V>(mapper, res);

    }

    private IList<V> map<V>(Fun<T, V> mapper, ArrayList<V> res)

    {

      int stamp = this.stamp;

      if (size > 0)

        for (int i = 0; i < size; i++)

        {

          V mappeditem = mapper(array[offset + i]);

          modifycheck(stamp);

#if HASHINDEX

          KeyValuePair<V, int> p = new KeyValuePair<V, int>(mappeditem, i);

          if (res.itemIndex.FindOrAdd(ref p))

            throw new ArgumentException("Mapped item already in indexed list");

#endif

          res.array[i] = mappeditem;

        }

      res.size = size;

      return res;

    }

    /// <summary>

    /// Remove one item from the list: from the front if <code>FIFO</code>

    /// is true, else from the back.

    /// </summary>

    /// <exception cref="NoSuchItemException"> if this list is empty.</exception>

    /// <returns>The removed item.</returns>

    [Tested]

    public virtual T Remove()

    {

      updatecheck();

      if (size == 0)

        throw new NoSuchItemException("List is empty");

      T item = removeAt(fIFO ? 0 : size - 1);

      (underlying ?? this).raiseForRemove(item);

      return item;

    }

    /// <summary>

    /// Remove one item from the fromnt of the list.

    /// </summary>

    /// <exception cref="NoSuchItemException"> if this list is empty.</exception>

    /// <returns>The removed item.</returns>

    [Tested]

    public virtual T RemoveFirst()

    {

      updatecheck();

      if (size == 0)

        throw new NoSuchItemException("List is empty");

      T item = removeAt(0);

      (underlying ?? this).raiseForRemoveAt(offset, item);

      return item;

    }

    /// <summary>

    /// Remove one item from the back of the list.

    /// </summary>

    /// <exception cref="NoSuchItemException"> if this list is empty.</exception>

    /// <returns>The removed item.</returns>

    [Tested]

    public virtual T RemoveLast()

    {

      updatecheck();

      if (size == 0)

        throw new NoSuchItemException("List is empty");

      T item = removeAt(size - 1);

      (underlying ?? this).raiseForRemoveAt(size + offset, item);

      return item;

    }

    /// <summary>

    /// Create a list view on this list. 

    /// </summary>

    /// <exception cref="ArgumentOutOfRangeException"> if the start or count is negative

    /// or the range does not fit within list.</exception>

    /// <param name="start">The index in this list of the start of the view.</param>

    /// <param name="count">The size of the view.</param>

    /// <returns>The new list view.</returns>

    [Tested]

    public virtual IList<T> View(int start, int count)

    {

      validitycheck();

      checkRange(start, count);

      if (views == null)

        views = new WeakViewList<ArrayList<T>>();

      ArrayList<T> retval = (ArrayList<T>)MemberwiseClone();

      retval.underlying = underlying != null ? underlying : this;

      retval.offset = start + offset;

      retval.size = count;

      retval.myWeakReference = views.Add(retval);

      return retval;

    }

    /// <summary>

    /// Create a list view on this list containing the (first) occurrence of a particular item.

    /// <para>Returns <code>null</code> if the item is not in this list.</para>

    /// </summary>

    /// <param name="item">The item to find.</param>

    /// <returns>The new list view.</returns>

    [Tested]

    public virtual IList<T> ViewOf(T item)

    {

      int index = indexOf(item);

      if (index < 0)

        return null;

      return View(index, 1);

    }

    /// <summary>

    /// Create a list view on this list containing the last occurrence of a particular item. 

    /// <para>Returns <code>null</code> if the item is not in this list.</para>

    /// </summary>

    /// <param name="item">The item to find.</param>

    /// <returns>The new list view.</returns>

    [Tested]

    public virtual IList<T> LastViewOf(T item)

    {

      int index = lastIndexOf(item);

      if (index < 0)

        return null;

      return View(index, 1);

    }

    /// <summary>

    /// Null if this list is not a view.

    /// </summary>

    /// <value>Underlying list for view.</value>

    [Tested]

    public virtual IList<T> Underlying { [Tested]get { return underlying; } }

    /// <summary>

    /// </summary>

    /// <value>Offset for this list view or 0 for an underlying list.</value>

    [Tested]

    public virtual int Offset { [Tested]get { return offset; } }

    /// <summary>

    /// 

    /// </summary>

    /// <value></value>

    public virtual bool IsValid { get { return isValid; } }

    /// <summary>

    /// Slide this list view along the underlying list.

    /// </summary>

    /// <exception cref="NotAViewException"> if this list is not a view.</exception>

    /// <exception cref="ArgumentOutOfRangeException"> if the operation

    /// would bring either end of the view outside the underlying list.</exception>

    /// <param name="offset">The signed amount to slide: positive to slide

    /// towards the end.</param>

    [Tested]

    public virtual IList<T> Slide(int offset)

    {

      if (!TrySlide(offset, size))

        throw new ArgumentOutOfRangeException();

      return this;

    }

    /// <summary>

    /// Slide this list view along the underlying list, changing its size.

    /// </summary>

    /// <exception cref="NotAViewException"> if this list is not a view.</exception>

    /// <exception cref="ArgumentOutOfRangeException"> if the operation

    /// would bring either end of the view outside the underlying list.</exception>

    /// <param name="offset">The signed amount to slide: positive to slide

    /// towards the end.</param>

    /// <param name="size">The new size of the view.</param>

    [Tested]

    public virtual IList<T> Slide(int offset, int size)

    {

      if (!TrySlide(offset, size))

        throw new ArgumentOutOfRangeException();

      return this;

    }

    /// <summary>

    /// 

    /// </summary>

    /// <exception cref="NotAViewException"> if this list is not a view.</exception>

    /// <param name="offset"></param>

    /// <returns></returns>

    [Tested]

    public virtual bool TrySlide(int offset)

    {

      return TrySlide(offset, size);

    }

    /// <summary>

    /// 

    /// </summary>

    /// <exception cref="NotAViewException"> if this list is not a view.</exception>

    /// <param name="offset"></param>

    /// <param name="size"></param>

    /// <returns></returns>

    [Tested]

    public virtual bool TrySlide(int offset, int size)

    {

      updatecheck();

      if (underlying == null)

        throw new NotAViewException("Not a view");

      int newoffset = this.offset + offset;

      int newsize = size;

      if (newoffset < 0 || newsize < 0 || newoffset + newsize > underlyingsize)

        return false;

      this.offset = newoffset;

      this.size = newsize;

      return true;

    }

    /// <summary>

    /// 

    /// <para>Returns null if <code>otherView</code> is strictly to the left of this view</para>

    /// </summary>

    /// <param name="otherView"></param>

    /// <exception cref="IncompatibleViewException">If otherView does not have the same underlying list as this</exception>

    /// <returns></returns>

    public virtual IList<T> Span(IList<T> otherView)

    {

      if ((otherView == null) || ((otherView.Underlying ?? otherView) != (underlying ?? this)))

        throw new IncompatibleViewException();

      if (otherView.Offset + otherView.Count - Offset < 0)

        return null;

      return (underlying ?? this).View(Offset, otherView.Offset + otherView.Count - Offset);

    }

    /// <summary>

    /// Reverst the list so the items are in the opposite sequence order.

    /// </summary>

    [Tested]

    public virtual void Reverse()

    {

      updatecheck();

      if (size == 0)

        return;

      for (int i = 0, length = size / 2, end = offset + size - 1; i < length; i++)

      {

        T swap = array[offset + i];

        array[offset + i] = array[end - i];

        array[end - i] = swap;

      }

#if HASHINDEX

      reindex(offset, offset + size);

#endif

      //TODO: be more forgiving wrt. disposing

      disposeOverlappingViews(true);

      (underlying ?? this).raiseCollectionChanged();

    }

    /// <summary>

    /// Check if this list is sorted according to the default sorting order

    /// for the item type T, as defined by the <see cref="T:C5.Comparer`1"/> class 

    /// </summary>

    /// <exception cref="NotComparableException">if T is not comparable</exception>

    /// <returns>True if the list is sorted, else false.</returns>

    [Tested]

    public bool IsSorted() { return IsSorted(Comparer<T>.Default); }

    /// <summary>

    /// Check if this list is sorted according to a specific sorting order.

    /// </summary>

    /// <param name="c">The comparer defining the sorting order.</param>

    /// <returns>True if the list is sorted, else false.</returns>

    [Tested]

    public virtual bool IsSorted(SCG.IComparer<T> c)

    {

      validitycheck();

      for (int i = offset + 1, end = offset + size; i < end; i++)

        if (c.Compare(array[i - 1], array[i]) > 0)

          return false;

      return true;

    }

    /// <summary>

    /// Sort the items of the list according to the default sorting order

    /// for the item type T, as defined by the Comparer[T] class 

    /// (<see cref="T:C5.Comparer`1"/>).

    /// </summary>

    /// <exception cref="InvalidOperationException">if T is not comparable</exception>

    public virtual void Sort()

    {

      Sort(Comparer<T>.Default);

    }

    /// <summary>

    /// Sort the items of the list according to a specific sorting order.

    /// </summary>

    /// <param name="comparer">The comparer defining the sorting order.</param>

    [Tested]

    public virtual void Sort(SCG.IComparer<T> comparer)

    {

      updatecheck();

      if (size == 0)

        return;

      Sorting.IntroSort<T>(array, offset, size, comparer);

      disposeOverlappingViews(false);

#if HASHINDEX

      reindex(offset, offset + size);

#endif

      (underlying ?? this).raiseCollectionChanged();

    }

    /// <summary>

    /// Randomly shuffle the items of this list. 

    /// </summary>

    public virtual void Shuffle() { Shuffle(new C5Random()); }

    /// <summary>

    /// Shuffle the items of this list according to a specific random source.

    /// </summary>

    /// <param name="rnd">The random source.</param>

    public virtual void Shuffle(Random rnd)

    {

      updatecheck();

      if (size == 0)

        return;

      for (int i = offset, top = offset + size, end = top - 1; i < end; i++)

      {

        int j = rnd.Next(i, top);

        if (j != i)

        {

          T tmp = array[i];

          array[i] = array[j];

          array[j] = tmp;

        }

      }

      disposeOverlappingViews(false);

#if HASHINDEX

      reindex(offset, offset + size);

#endif

      (underlying ?? this).raiseCollectionChanged();

    }

    #endregion

    #region IIndexed<T> Members

    /// <summary>

    /// Search for an item in the list going forwrds from the start.

    /// </summary>

    /// <param name="item">Item to search for.</param>

    /// <returns>Index of item from start.</returns>

    [Tested]

    public virtual int IndexOf(T item) { validitycheck(); return indexOf(item); }

    /// <summary>

    /// Search for an item in the list going backwords from the end.

    /// </summary>

    /// <param name="item">Item to search for.</param>

    /// <returns>Index of item from the end.</returns>

    [Tested]

    public virtual int LastIndexOf(T item) { validitycheck(); return lastIndexOf(item); }

    /// <summary>

    /// Remove the item at a specific position of the list.

    /// </summary>

    /// <exception cref="IndexOutOfRangeException"> if index is negative or

    /// &gt;= the size of the collection.</exception>

    /// <param name="index">The index of the item to remove.</param>

    /// <returns>The removed item.</returns>

    [Tested]

    public virtual T RemoveAt(int index)

    {

      updatecheck();

      if (index < 0 || index >= size)

        throw new IndexOutOfRangeException("Index out of range for sequenced collection");

      T item = removeAt(index);

      (underlying ?? this).raiseForRemoveAt(offset + index, item);

      return item;

    }

    /// <summary>

    /// Remove all items in an index interval.

    /// </summary>

    /// <exception cref="ArgumentOutOfRangeException">If <code>start</code>

    /// and <code>count</code> does not describe a valid interval in the list</exception> 

    /// <param name="start">The index of the first item to remove.</param>

    /// <param name="count">The number of items to remove.</param>

    [Tested]

    public virtual void RemoveInterval(int start, int count)

    {

      updatecheck();

      if (count == 0)

        return;

      checkRange(start, count);

      start += offset;

      fixViewsBeforeRemove(start, count);

#if HASHINDEX

      KeyValuePair<T, int> p = new KeyValuePair<T, int>();

      for (int i = start, end = start + count; i < end; i++)

      {

        p.Key = array[i];

        itemIndex.Remove(p);

      }

#endif

      Array.Copy(array, start + count, array, start, underlyingsize - start - count);

      addtosize(-count);

      Array.Clear(array, underlyingsize, count);

#if HASHINDEX

      reindex(start);

#endif

      (underlying ?? this).raiseForRemoveInterval(start, count);

    }

    void raiseForRemoveInterval(int start, int count)

    {

      if (ActiveEvents != 0)

      {

        raiseCollectionCleared(size == 0, count, start);

        raiseCollectionChanged();

      }

    }

    #endregion

    #region ICollection<T> Members

    /// <summary>

    /// The value is symbolic indicating the type of asymptotic complexity

    /// in terms of the size of this collection (worst-case or amortized as

    /// relevant).

    /// </summary>

    /// <value>Speed.Linear</value>

    [Tested]

    public virtual Speed ContainsSpeed

    {

      [Tested]

      get

      {

#if HASHINDEX

        return Speed.Constant;

#else

        return Speed.Linear;

#endif

      }

    }

    /// <summary>

    /// 

    /// </summary>

    /// <returns></returns>

    [Tested]

    public override int GetUnsequencedHashCode()

    { validitycheck(); return base.GetUnsequencedHashCode(); }

    /// <summary>

    /// 

    /// </summary>

    /// <param name="that"></param>

    /// <returns></returns>

    [Tested]

    public override bool UnsequencedEquals(ICollection<T> that)

    { validitycheck(); return base.UnsequencedEquals(that); }

    /// <summary>

    /// Check if this collection contains (an item equivalent to according to the

    /// itemequalityComparer) a particular value.

    /// </summary>

    /// <param name="item">The value to check for.</param>

    /// <returns>True if the items is in this collection.</returns>

    [Tested]

    public virtual bool Contains(T item)

    { validitycheck(); return indexOf(item) >= 0; }

    /// <summary>

    /// Check if this collection contains an item equivalent according to the

    /// itemequalityComparer to a particular value. If so, return in the ref argument (a

    /// binary copy of) the actual value found.

    /// </summary>

    /// <param name="item">The value to look for.</param>

    /// <returns>True if the items is in this collection.</returns>

    [Tested]

    public virtual bool Find(ref T item)

    {

      validitycheck();

      int i;

      if ((i = indexOf(item)) >= 0)

      {

        item = array[offset + i];

        return true;

      }

      return false;