array.mlw 4.64 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 68 69 70
      forall i:int. 0 <= i < length result -> result[i] = a[i] }

  parameter fill : a:array 'a -> ofs:int -> len:int -> v:'a ->
   { 0 <= ofs and ofs + len <= length a }
   unit
71 72 73 74
   writes a
   { (forall i:int.
       (0 <= i < ofs or ofs + len <= i < length a) -> a[i] = (old a)[i])
     and
75 76 77
     (forall i:int.
       ofs <= i < ofs + len -> a[i] = v) }

78
  parameter blit :
79 80 81 82
   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
83 84 85 86
   writes a2
   { (forall i:int.
       (0 <= i < ofs2 or ofs2 + len <= i < length a2) -> a2[i] = (old a2)[i])
     and
87 88
     (forall i:int.
       ofs2 <= i < ofs2 + len -> a2[i] = a1[ofs1 + i - ofs2]) }
89

90 91 92
  (* TODO?
     - concat : 'a array list -> 'a array
     - to_list
93
     - of_list
94
  *)
95 96 97

end

98 99 100
module ArraySorted

  use import module Array
101
  clone import map.MapSorted as M with type elt = int
102

103
  logic sorted_sub (a : array int) (l u : int) =
104 105
    M.sorted_sub a.elts l u

106
  logic sorted (a : array int) =
107 108 109 110 111 112 113
    M.sorted_sub a.elts 0 a.length

end

module ArrayEq

  use import module Array
114
  use import map.MapEq as M
115 116 117 118

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

119
  logic array_eq (a1 a2: array 'a) =
120 121 122 123 124 125 126 127 128 129
    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

130 131 132
  logic exchange (a1 a2: array 'a) (i j: int) =
    M.exchange a1.elts a2.elts i j

133
  logic permut_sub (a1 a2: array 'a) (l u: int) =
134 135
    M.permut_sub a1.elts a2.elts l u

136
  logic permut (a1 a2: array 'a) =
137 138
    a1.length = a2.length and M.permut_sub a1.elts a2.elts 0 a1.length

139 140 141 142 143 144 145 146 147 148
  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

149 150
end

151 152 153 154 155
module TestArray

  use import int.Int
  use import module Array

156
  let test_append () =
157 158
    let a1 = make 17 2 in
    assert { a1[3] = 2 };
159
    a1[3] <- 4;
160 161 162 163 164 165 166 167 168
    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 };
    ()

169
  let test_fill () =
170 171 172
    let a = make 17 True in
    fill a 10 4 False;
    assert { a[10] = False }
173

174 175 176 177 178 179 180 181 182 183
  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 }

184 185
end

186
(*
187
Local Variables:
188
compile-command: "unset LANG; make -C .. modules/array"
189
End:
190
*)