array.mlw 4.93 KB
Newer Older
1

2 3
(* Arrays *)

4 5 6
module Array

  use import int.Int
7
  use import map.Map as M
8

9
  type array 'a model {| length : int; mutable elts : map int 'a |}
10

11 12 13 14 15 16 17 18
  logic get (a: array 'a) (i: int) : 'a = M.get a.elts i

  logic set (a: array 'a) (i: int) (v: 'a) : array 'a =
    {| a with elts = M.set a.elts i v |}

  (* syntactic sugar *)
  logic ([]) (a: array 'a) (i: int) : 'a = get a i
  logic ([<-]) (a: array 'a) (i: int) (v: 'a) : array 'a = set a i v
19

20
  parameter ([]) : a:array 'a -> i:int ->
21
    { 0 <= i < length a } 'a reads a { result = a[i] }
22

23
  parameter ([]<-) : a:array 'a -> i:int -> v:'a ->
24
    { 0 <= i < length a } unit writes a { a.elts = M.set (old a.elts) i v }
25

26
  (* unsafe get/set operations with no precondition *)
27 28 29 30 31 32 33 34 35 36 37 38 39
  exception OutOfBounds

  parameter defensive_get: a:array 'a -> i:int ->
    { }
    'a reads a raises OutOfBounds
    { 0 <= i < length a and result = a[i] }
    | OutOfBounds -> { i < 0 or i >= length a }

  parameter defensive_set : a:array 'a -> i:int -> v:'a ->
    { }
    unit writes a raises OutOfBounds
    { 0 <= i < length a and a = (old a)[i <- v] }
    | OutOfBounds -> { i < 0 or i >= length a }
40

41 42
  parameter length : a:array 'a -> {} int { result = a.length }

43 44 45
  parameter make : n:int -> v:'a ->
    {}
    array 'a
46 47
    { result = {| length = n; elts = M.const v |} }
    (* { length result = n and forall i:int. 0 <= i < n -> result[i] = v} *)
48 49 50 51 52 53 54 55 56 57 58 59 60 61

  parameter append : a1:array 'a -> a2:array 'a ->
    {}
    array 'a
    { length result = length a1 + length a2 and
      (forall i:int. 0 <= i < length a1 -> result[i] = a1[i]) and
      (forall i:int. 0 <= i < length a2 -> result[length a1 + i] = a2[i]) }

  parameter sub : a:array 'a -> ofs:int -> len:int ->
    { 0 <= ofs and ofs + len <= length a }
    array 'a
    { length result = len and
      forall i:int. 0 <= i < len -> result[i] = a[ofs + i] }

62 63 64 65
  parameter copy : a:array 'a ->
    {}
    array 'a
    { length result = length a and
66 67
      forall i:int. 0 <= i < length result -> result[i] = a[i] }

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
  let fill (a:array 'a) (ofs:int) (len:int) (v:'a) =
    { 0 <= ofs and ofs + len <= length a }
    label Init:
    for k = 0 to len - 1 do
      invariant {
        (forall i:int.
        (0 <= i < ofs or ofs + len <= i < length a) -> a[i] = (at a Init)[i])
        and
        (forall i:int. ofs <= i < ofs + k -> a[i] = v)
      }
      a[ofs + k] <- v
    done
    { (forall i:int.
        (0 <= i < ofs or ofs + len <= i < length a) -> a[i] = (old a)[i])
      and
      (forall i:int.
        ofs <= i < ofs + len -> a[i] = v) }
85

86
  parameter blit :
87 88 89 90
   a1:array 'a -> ofs1:int -> a2:array 'a -> ofs2:int -> len:int ->
   { 0 <= ofs1 and ofs1 + len <= length a1 and
     0 <= ofs2 and ofs2 + len <= length a2 }
   unit
91 92 93 94
   writes a2
   { (forall i:int.
       (0 <= i < ofs2 or ofs2 + len <= i < length a2) -> a2[i] = (old a2)[i])
     and
95 96
     (forall i:int.
       ofs2 <= i < ofs2 + len -> a2[i] = a1[ofs1 + i - ofs2]) }
97

98 99 100
  (* TODO?
     - concat : 'a array list -> 'a array
     - to_list
101
     - of_list
102
  *)
103 104 105

end

106 107 108
module ArraySorted

  use import module Array
109
  clone import map.MapSorted as M with type elt = int
110

111
  logic sorted_sub (a : array int) (l u : int) =
112 113
    M.sorted_sub a.elts l u

114
  logic sorted (a : array int) =
115 116 117 118 119 120 121
    M.sorted_sub a.elts 0 a.length

end

module ArrayEq

  use import module Array
122
  use import map.MapEq as M
123 124 125 126

  logic array_eq_sub (a1 a2: array 'a) (l u: int) =
    map_eq_sub a1.elts a2.elts l u

127
  logic array_eq (a1 a2: array 'a) =
128 129 130 131 132 133 134 135 136 137
    a1.length = a2.length and
    array_eq_sub a1 a2 0 a1.length

end

module ArrayPermut

  use import module Array
  clone import map.MapPermut as M

138 139 140
  logic exchange (a1 a2: array 'a) (i j: int) =
    M.exchange a1.elts a2.elts i j

141
  logic permut_sub (a1 a2: array 'a) (l u: int) =
142 143
    M.permut_sub a1.elts a2.elts l u

144
  logic permut (a1 a2: array 'a) =
145 146
    a1.length = a2.length and M.permut_sub a1.elts a2.elts 0 a1.length

147 148 149 150 151 152 153 154 155 156
  use import module ArrayEq

  lemma array_eq_sub_permut:
    forall a1 a2: array 'a, l u: int.
    array_eq_sub a1 a2 l u -> permut_sub a1 a2 l u

  lemma array_eq_permut:
    forall a1 a2: array 'a.
    array_eq a1 a2 -> permut a1 a2

157 158
end

159 160 161 162 163
module TestArray

  use import int.Int
  use import module Array

164
  let test_append () =
165 166
    let a1 = make 17 2 in
    assert { a1[3] = 2 };
167
    a1[3] <- 4;
168 169 170 171 172 173 174 175 176
    assert { a1[3] = 4 };
    let a2 = make 25 3 in
    assert { a2[0] = 3 }; (* needed to prove a[17]=3 below *)
    let a  = append a1 a2 in
    assert { length a = 42 };
    assert { a[3] = 4 };
    assert { a[17] = 3 };
    ()

177
  let test_fill () =
178 179
    let a = make 17 True in
    fill a 10 4 False;
180 181 182
    assert { a[9] = True };
    assert { a[10] = False };
    assert { a[14] = True }
183

184 185 186 187 188 189 190 191 192 193
  let test_blit () =
    let a1 = make 17 True in
    let a2 = make 25 False in
    blit a1 10 a2 17 7;
    assert { a1[10] = True  };
    assert { a2[16] = False };
    assert { a2[17] = True  };
    assert { a2[23] = True  };
    assert { a2[24] = False }

194 195
end

196
(*
197
Local Variables:
198
compile-command: "unset LANG; make -C .. modules/array"
199
End:
200
*)