summaryrefslogtreecommitdiff
path: root/Source/AIFramework/Functional.cs
blob: 51d8562a2ff0e111865db1776af401cb444b10a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
//-----------------------------------------------------------------------------
//
// Copyright (C) Microsoft Corporation.  All Rights Reserved.
//
//-----------------------------------------------------------------------------
using System.Diagnostics.Contracts;

namespace Microsoft.AbstractInterpretationFramework.Collections {
  using System.Collections;

  /// <summary>Represents a functional collection of key/value pairs.</summary>
  /// <filterpriority>2</filterpriority>
  [ContractClass(typeof(IFunctionalMapContracts))]
  public interface IFunctionalMap : System.Collections.ICollection, System.Collections.IEnumerable {
    /// <summary>Adds an element with the provided key and value to the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</summary>
    /// <param name="value">The <see cref="T:System.Object" /> to use as the value of the element to add. </param>
    /// <param name="key">The <see cref="T:System.Object" /> to use as the key of the element to add. </param>
    /// <filterpriority>2</filterpriority>
    IFunctionalMap/*!*/ Add(object/*!*/ key, object value);

    /// <summary>
    /// Set the value of the key (that is already in the map)
    /// </summary>
    IFunctionalMap/*!*/ Set(object/*!*/ key, object value);

    /// <summary>Determines whether the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" /> contains an element with the specified key.</summary>
    /// <returns>true if the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" /> contains an element with the key; otherwise, false.</returns>
    /// <param name="key">The key to locate in the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />. </param>
    /// <filterpriority>2</filterpriority>
    [Pure]
    bool Contains(object/*!*/ key);

    /// <summary>Returns an <see cref="T:System.Collections.IDictionaryEnumerator" /> for the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</summary>
    /// <returns>An <see cref="T:System.Collections.IDictionaryEnumerator" /> for the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</returns>
    /// <filterpriority>2</filterpriority>
    [Pure]
    [GlobalAccess(false)]
    [Escapes(true, false)]
    new System.Collections.IDictionaryEnumerator GetEnumerator();

    /// <summary>Gets an <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</summary>
    /// <returns>An <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</returns>
    /// <filterpriority>2</filterpriority>
    System.Collections.ICollection Keys {
      get;
    }

    /// <summary>Removes the element with the specified key from the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</summary>
    /// <param name="key">The key of the element to remove. </param>
    /// <filterpriority>2</filterpriority>
    IFunctionalMap/*!*/ Remove(object/*!*/ key);

    /// <summary>Gets an <see cref="T:System.Collections.ICollection" /> containing the values in the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</summary>
    /// <returns>An <see cref="T:System.Collections.ICollection" /> containing the values in the <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />.</returns>
    /// <filterpriority>2</filterpriority>
    System.Collections.ICollection Values {
      get;
    }

    object this[object/*!*/ key] {
      get; /*set;*/
    }
  }
  [ContractClassFor(typeof(IFunctionalMap))]
  public abstract class IFunctionalMapContracts : IFunctionalMap {

    #region IFunctionalMap Members

    IFunctionalMap IFunctionalMap.Add(object key, object value) {
      Contract.Requires(key != null);
      Contract.Ensures(Contract.Result<IFunctionalMap>() != null);

      throw new System.NotImplementedException();
    }

    IFunctionalMap IFunctionalMap.Set(object key, object value) {
      Contract.Requires(key != null);
      Contract.Ensures(Contract.Result<IFunctionalMap>() != null);

      throw new System.NotImplementedException();
    }

    bool IFunctionalMap.Contains(object key) {
      Contract.Requires(key != null);

      throw new System.NotImplementedException();
    }

    IDictionaryEnumerator IFunctionalMap.GetEnumerator() {
      throw new System.NotImplementedException();
    }

    ICollection IFunctionalMap.Keys {
      get {
        throw new System.NotImplementedException();
      }
    }

    IFunctionalMap IFunctionalMap.Remove(object key) {
      Contract.Requires(key != null);
      Contract.Ensures(Contract.Result<IFunctionalMap>() != null);

      throw new System.NotImplementedException();
    }

    ICollection IFunctionalMap.Values {
      get {
        throw new System.NotImplementedException();
      }
    }

    object IFunctionalMap.this[object key] {
      get {
        Contract.Requires(key != null);
        throw new System.NotImplementedException();
      }
    }

    #endregion

    #region ICollection Members

    void ICollection.CopyTo(System.Array array, int index) {
      throw new System.NotImplementedException();
    }

    int ICollection.Count {
      get {
        throw new System.NotImplementedException();
      }
    }

    bool ICollection.IsSynchronized {
      get {
        throw new System.NotImplementedException();
      }
    }

    object ICollection.SyncRoot {
      get {
        throw new System.NotImplementedException();
      }
    }

    #endregion

    #region IEnumerable Members

    IEnumerator IEnumerable.GetEnumerator() {
      throw new System.NotImplementedException();
    }

    #endregion
  }



  /// <summary>
  ///  An implementation of the
  ///  <see cref="T:Microsoft.AbstractInterpretationFramework.Collections.IFunctionalMap" />
  ///  interface with a <see cref="T:System.Collections.Hashtable" /> as the backing store.
  /// </summary>
  class FunctionalHashtable : IFunctionalMap {
    private readonly Hashtable/*!*/ h;
    [ContractInvariantMethod]
    void ObjectInvariant() {
      Contract.Invariant(h != null);
    }


    /// <summary>
    ///  Cannot directly construct an instance of a FunctionalHashtbl.
    /// </summary>
    private FunctionalHashtable() {
      this.h = new Hashtable();
      //            base();
    }

    /// <summary>
    ///  Cannot directly construct an instance of a FunctionalHashtbl.
    /// </summary>
    private FunctionalHashtable(Hashtable/*!*/ h) {
      Contract.Requires(h != null);
      this.h = h;
      //            base();
    }

    private static readonly IFunctionalMap/*!*/ empty = new FunctionalHashtable();
    public static IFunctionalMap/*!*/ Empty {
      get {
        Contract.Ensures(Contract.Result<IFunctionalMap>() != null);
        return empty;
      }
    }

    public IFunctionalMap/*!*/ Add(object/*!*/ key, object value) {
      //Contract.Requires(key != null);
      Contract.Ensures(Contract.Result<IFunctionalMap>() != null);
      Hashtable r = h.Clone() as Hashtable;
      Contract.Assume(r != null);
      r.Add(key, value);
      return new FunctionalHashtable(r);
    }

    public IFunctionalMap/*!*/ Set(object/*!*/ key, object value) {
      //Contract.Requires(key != null);
      Contract.Ensures(Contract.Result<IFunctionalMap>() != null);
      Hashtable r = h.Clone() as Hashtable;

      Contract.Assume(r != null);
      Contract.Assert(this.Contains(key));    // The entry must be defined

      r[key] = value;
      return new FunctionalHashtable(r);
    }

    [Pure]
    public bool Contains(object/*!*/ key) {
      //Contract.Requires(key != null);
      return h.Contains(key);
    }

    [Pure]
    [GlobalAccess(false)]
    [Escapes(true, false)]
    IEnumerator/*!*/ IEnumerable.GetEnumerator() {
      Contract.Ensures(Contract.Result<IEnumerator>() != null);

      return h.GetEnumerator();
    }

    [Pure]
    [GlobalAccess(false)]
    [Escapes(true, false)]
    IDictionaryEnumerator IFunctionalMap.GetEnumerator() {
      return h.GetEnumerator();
    }

    public ICollection Keys {
      get {
        return h.Keys;
      }
    }

    public IFunctionalMap/*!*/ Remove(object/*!*/ key) {
      //Contract.Requires(key != null);
      Contract.Ensures(Contract.Result<IFunctionalMap>() != null);
      Hashtable r = h.Clone() as Hashtable;
      Contract.Assume(r != null);
      r.Remove(key);
      return new FunctionalHashtable(r);
    }

    public ICollection Values {
      get {
        return h.Values;
      }
    }


    public object this[object/*!*/ key] {
      get {
        //Contract.Requires(key != null);
        return h[key];
      }
    }

    public int Count {
      [Pure]
      get {
        return h.Count;
      }
    }

    public bool IsSynchronized {
      [Pure]
      get {
        return h.IsSynchronized;
      }
    }

    public object/*!*/ SyncRoot {
      [Pure]
      get {
        Contract.Ensures(Contract.Result<object>() != null);
        return h.SyncRoot;
      }
    }

    public void CopyTo(System.Array/*!*/ a, int index) {
      //Contract.Requires(a != null);
      h.CopyTo(a, index);
    }
  }

  public struct Pair/*<T1,T2>*/
  {
    private object first;
    private object second;

    public object First {
      get {
        return first;
      }
    }
    public object Second {
      get {
        return second;
      }
    }

    public Pair(object first, object second) {
      this.first = first;
      this.second = second;
    }

    public override bool Equals(object obj) {
      if (obj == null)
        return false;
      if (!(obj is Pair))
        return false;

      Pair other = (Pair)obj;
      return object.Equals(this.first, other.first) && object.Equals(this.second, other.second);
    }

    public override int GetHashCode() {
      int h = this.first == null ? 0 : this.first.GetHashCode();
      h ^= this.second == null ? 0 : this.second.GetHashCode();
      return h;
    }
  }
}


namespace Microsoft.AbstractInterpretationFramework.Collections.Generic {
  using System.Collections.Generic;

  public struct Pair<T1, T2> {
    private T1 first;
    private T2 second;

    public T1 First {
      get {
        return first;
      }
    }
    public T2 Second {
      get {
        return second;
      }
    }

    public Pair(T1 first, T2 second) {
      this.first = first;
      this.second = second;
    }

    public override bool Equals(object obj) {
      if (obj == null)
        return false;
      if (!(obj is Pair<T1, T2>))
        return false;

      Pair<T1, T2> other = (Pair<T1, T2>)obj;
      return object.Equals(this.first, other.first) && object.Equals(this.second, other.second);
    }

    public override int GetHashCode() {
      int h = this.first == null ? 0 : this.first.GetHashCode();
      h ^= this.second == null ? 0 : this.second.GetHashCode();
      return h;
    }

    public override string/*!*/ ToString() {
      Contract.Ensures(Contract.Result<string>() != null);
      return string.Format("({0},{1})", first, second);
    }
  }

  public struct Triple<T1, T2, T3> {
    private T1 first;
    private T2 second;
    private T3 third;

    public T1 First {
      get {
        return first;
      }
    }
    public T2 Second {
      get {
        return second;
      }
    }
    public T3 Third {
      get {
        return third;
      }
    }

    public Triple(T1 first, T2 second, T3 third) {
      this.first = first;
      this.second = second;
      this.third = third;
    }

    public override bool Equals(object obj) {
      if (obj == null)
        return false;
      if (!(obj is Triple<T1, T2, T3>))
        return false;

      Triple<T1, T2, T3> other = (Triple<T1, T2, T3>)obj;
      return object.Equals(this.first, other.first) && object.Equals(this.second, other.second) && object.Equals(this.third, other.third);
    }

    public override int GetHashCode() {
      int h = this.first == null ? 0 : this.first.GetHashCode();
      h ^= this.second == null ? 0 : this.second.GetHashCode();
      h ^= this.third == null ? 0 : this.third.GetHashCode();
      return h;
    }

    public override string/*!*/ ToString() {
      Contract.Ensures(Contract.Result<string>() != null);
      return string.Format("({0},{1},{2})", first, second, third);
    }
  }
}