mcs/class/Mono.CodeContracts/Mono.CodeContracts.Static.Analysis.Numerical/IntervalBase.cs

   1 //
   2 // IntervalBase.cs
   3 //
   4 // Authors:
   5 //      Alexander Chebaturkin (chebaturkin@gmail.com)
   6 //
   7 // Copyright (C) 2012 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 using Mono.CodeContracts.Static.Lattices;
  32
  33 namespace Mono.CodeContracts.Static.Analysis.Numerical {
  34         /// <summary>
  35         /// Represents a generic class for intervals on numeric values.
  36         /// </summary>
  37         public abstract class IntervalBase<TInterval, TNumeric> : IAbstractDomain<TInterval>
  38                 where TInterval : IntervalBase<TInterval, TNumeric> {
  39                 protected IntervalBase (TNumeric lowerBound, TNumeric upperBound)
  40                 {
  41                         LowerBound = lowerBound;
  42                         UpperBound = upperBound;
  43                 }
  44
  45                 public TNumeric UpperBound { get; protected set; }
  46                 public TNumeric LowerBound { get; protected set; }
  47
  48                 public abstract TInterval Top { get; }
  49                 public abstract TInterval Bottom { get; }
  50
  51                 public abstract bool IsTop { get; }
  52                 public abstract bool IsBottom { get; }
  53
  54                 public bool IsSinglePoint { get { return this.IsNormal () && LowerBound.Equals (UpperBound); } }
  55                 public bool IsFinite { get { return this.IsNormal () && IsFiniteBound (LowerBound) && IsFiniteBound (UpperBound); } }
  56
  57                 public abstract bool LessEqual (TInterval that);
  58
  59                 public abstract TInterval Join (TInterval that, bool widening, out bool weaker);
  60                 public abstract TInterval Join (TInterval that);
  61
  62                 public abstract TInterval Widen (TInterval that);
  63                 public abstract TInterval Meet (TInterval that);
  64
  65                 public abstract TInterval ImmutableVersion ();
  66                 public abstract TInterval Clone ();
  67
  68                 public abstract void Dump (TextWriter tw);
  69
  70                 public override string ToString ()
  71                 {
  72                         return string.Format ("[{0}, {1}]{2}", LowerBound, UpperBound, this.BottomSymbolIfAny ());
  73                 }
  74
  75                 protected abstract bool IsFiniteBound (TNumeric n);
  76        }
  77 }