mcs/class/Mono.CodeContracts/Mono.CodeContracts.Static.Lattices/IAbstractDomain.cs

   1 //
   2 // IAbstractDomain.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.IO;
  30
  31 namespace Mono.CodeContracts.Static.Lattices {
  32         /// <summary>
  33         /// Represents abstraction of concrete value
  34         /// </summary>
  35         /// <typeparam name="T"></typeparam>
  36         interface IAbstractDomain<T> {
  37                 /// <summary>
  38                 /// Represents universe set (which holds every value)
  39                 /// </summary>
  40                 T Top { get; }
  41
  42                 /// <summary>
  43                 /// Represents empty set (which holds nothing)
  44                 /// </summary>
  45                 T Bottom { get; }
  46
  47                 /// <summary>
  48                 /// Is this value a universe set
  49                 /// </summary>
  50                 bool IsTop { get; }
  51
  52                 /// <summary>
  53                 /// Is this value an empty set
  54                 /// </summary>
  55                 bool IsBottom { get; }
  56
  57                 /// <summary>
  58                 /// Returns a union of this and that
  59                 /// </summary>
  60                 /// <param name="that"></param>
  61                 /// <returns></returns>
  62                 T Join (T that);
  63
  64                 T Join (T that, bool widen, out bool weaker);
  65
  66                 T Widen (T that);
  67
  68                 /// <summary>
  69                 /// Returns an intersection of this and that
  70                 /// </summary>
  71                 /// <param name="that"></param>
  72                 /// <returns></returns>
  73                 T Meet (T that);
  74
  75                 bool LessEqual (T that);
  76
  77                 T ImmutableVersion ();
  78                 T Clone ();
  79
  80                 void Dump (TextWriter tw);
  81         }
  82 }