mcs/class/Mono.CodeContracts/Mono.CodeContracts.Static.DataStructures/AbstractWorkList.cs

   1 //
   2 // AbstractWorkList.cs
   3 //
   4 // Authors:
   5 //      Alexander Chebaturkin (chebaturkin@gmail.com)
   6 //
   7 // Copyright (C) 2011 Alexander Chebaturkin
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System.Collections.Generic;
  30
  31 namespace Mono.CodeContracts.Static.DataStructures {
  32         abstract class AbstractWorkList<T> : IWorkList<T> {
  33                 protected HashSet<T> Elements = new HashSet<T> ();
  34                 protected abstract IEnumerable<T> Collection { get; }
  35
  36                 public int Count
  37                 {
  38                         get { return this.Elements.Count; }
  39                 }
  40
  41                 protected abstract void AddToCollection (T o);
  42
  43                 #region Implementation of IWorkList<T>
  44                 public virtual bool Add (T o)
  45                 {
  46                         if (!this.Elements.Add (o))
  47                                 return false;
  48                         AddToCollection (o);
  49                         return true;
  50                 }
  51
  52                 public virtual bool IsEmpty ()
  53                 {
  54                         return this.Elements.Count == 0;
  55                 }
  56
  57                 public abstract T Pull ();
  58
  59                 public virtual bool AddAll (IEnumerable<T> objs)
  60                 {
  61                         bool any = false;
  62                         foreach (T o in objs) {
  63                                 if (Add (o))
  64                                         any = true;
  65                         }
  66                         return any;
  67                 }
  68
  69                 public virtual IEnumerator<T> GetEnumerator ()
  70                 {
  71                         return Collection.GetEnumerator ();
  72                 }
  73                 #endregion
  74         }
  75 }