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
|
#ifndef _ZoO_CORE_SEQUENCE_H_
#define _ZoO_CORE_SEQUENCE_H_
/* Defines SIZE_MAX */
#include <stdint.h>
#include "../core/char_types.h"
#include "../core/index_types.h"
#include "../pipe/pipe.h"
#include "../knowledge/knowledge_types.h"
#include "sequence_types.h"
/*@
requires \valid(sequence);
requires \valid(*sequence);
requires \valid(sequence_capacity);
requires \valid(io);
requires (((*sequence_capacity) * sizeof(ZoO_index)) <= SIZE_MAX);
requires ((sequence_required_capacity * sizeof(ZoO_index)) <= SIZE_MAX);
requires \separated(sequence, *sequence, sequence_capacity, io);
ensures \separated(sequence, *sequence, sequence_capacity, io);
ensures (((*sequence_capacity) * sizeof(ZoO_index)) <= SIZE_MAX);
ensures ((sequence_required_capacity * sizeof(ZoO_index)) <= SIZE_MAX);
ensures \valid(sequence);
ensures \valid(*sequence);
ensures \valid(sequence_capacity);
ensures \valid(io);
assigns (*sequence);
assigns (*sequence_capacity);
ensures ((\result == 1) || (\result == 0) || (\result == -1));
ensures
(
(\result == 1) ==>
((*sequence_capacity) == sequence_required_capacity)
);
ensures
(
(\result == 1) ==>
((*sequence_capacity) > \old(*sequence_capacity))
);
ensures ((\result == -1) ==> ((*sequence) == \old(*sequence)));
ensures
(
(\result == -1) ==>
((*sequence_capacity) == \old(*sequence_capacity))
);
ensures ((\result == 0) ==> ((*sequence) == \old(*sequence)));
ensures
(
(\result == 0) ==>
((*sequence_capacity) == \old(*sequence_capacity))
);
@*/
int ZoO_sequence_ensure_capacity
(
ZoO_index * sequence [const restrict static 1],
size_t sequence_capacity [const restrict static 1],
const size_t sequence_required_capacity,
const struct ZoO_pipe io [const restrict static 1]
);
int ZoO_sequence_from_undercase_string
(
const ZoO_char string [const restrict],
const size_t string_length,
struct ZoO_knowledge k [const restrict static 1],
ZoO_index * sequence [const restrict static 1],
size_t sequence_capacity [const restrict static 1],
size_t sequence_length [const restrict static 1],
const struct ZoO_pipe io [const restrict static 1]
);
/*
* Creates a sequence containing {initial_word}. The remaining elements of
* sequence are added according to what is known to {k} as being possible.
* The resulting sequence starts by ZoO_START_OF_SEQUENCE_ID, and ends by
* ZoO_END_OF_SEQUENCE_ID. The sequence is allocated by the function. If an
* error occur, it is unallocated and set to NULL ({sequence_size} is set
* accordingly).
* Return:
* 0 on success.
* -1 iff the allocating failed.
* -2 iff the sequence initialization failed.
* -3 iff an error occured when trying to add elements to the right of the
* sequence.
* -4 iff an error occured when trying to add elements to the left of the
* sequence.
* -5 iff the resulting sequence would have been empty.
* Pre:
* (> {markov_order} 0)
* (knows {k} {initial_word})
* (initialized {k})
*/
int ZoO_sequence_create_from
(
const ZoO_index initial_word,
size_t credits [const restrict],
struct ZoO_knowledge k [const restrict static 1],
const ZoO_index markov_order,
ZoO_index * sequence [const restrict static 1],
size_t sequence_capacity [const restrict static 1],
size_t sequence_length [const restrict static 1],
const struct ZoO_pipe io [const restrict static 1]
);
/*@
requires \valid(sequence);
requires \valid(*sequence);
requires \valid(sequence_capacity);
requires \valid(sequence_length);
requires \valid(io);
requires (((*sequence_length) * sizeof(ZoO_index)) <= SIZE_MAX);
requires (((*sequence_capacity) * sizeof(ZoO_index)) <= SIZE_MAX);
requires \separated(sequence, *sequence, sequence_capacity, sequence_length, io);
assigns (*sequence_length);
assigns (*sequence[0]);
assigns (*sequence_capacity);
ensures \valid(sequence);
ensures \valid(*sequence);
ensures \valid(sequence_capacity);
ensures \valid(sequence_length);
ensures \valid(io);
ensures (((*sequence_length) * sizeof(ZoO_index)) <= SIZE_MAX);
ensures (((*sequence_capacity) * sizeof(ZoO_index)) <= SIZE_MAX);
ensures \separated(sequence, *sequence, sequence_capacity, sequence_length, io);
ensures ((\result == 0) || (\result == -1));
ensures
(
(\result == 0) ==>
(*sequence_length == (\old(*sequence_length) + 1))
);
ensures
(
(\result == 0) ==>
((*sequence_capacity) >= \old(*sequence_capacity))
);
ensures ((\result == 0) ==> (*sequence_length > \old(*sequence_length)));
ensures ((\result == -1) ==> ((*sequence_length) == \old(*sequence_length)));
ensures ((\result == -1) ==> ((*sequence[0]) == \old(*sequence[0])));
ensures
(
(\result == -1) ==>
((*sequence_capacity) == \old(*sequence_capacity))
);
ensures ((\result == -1) ==> ((*sequence_length) == \old(*sequence_length)));
ensures
(
(\result == -1) ==>
((*sequence_capacity) == \old(*sequence_capacity))
);
@*/
int ZoO_sequence_append_left
(
const ZoO_index word_id,
ZoO_index * sequence [const restrict static 1],
size_t sequence_capacity [const restrict static 1],
size_t sequence_length [const restrict static 1],
const struct ZoO_pipe io [const restrict static 1]
);
/*@
requires \valid(sequence);
requires \valid(*sequence);
requires \valid(sequence_capacity);
requires \valid(sequence_length);
requires \valid(io);
requires (((*sequence_length) * sizeof(ZoO_index)) <= SIZE_MAX);
requires (((*sequence_capacity) * sizeof(ZoO_index)) <= SIZE_MAX);
requires \separated(sequence, *sequence, sequence_capacity, sequence_length, io);
assigns (*sequence_length);
assigns (*sequence[0]);
assigns (*sequence_capacity);
ensures \valid(sequence);
ensures \valid(*sequence);
ensures \valid(sequence_capacity);
ensures \valid(sequence_length);
ensures \valid(io);
ensures (((*sequence_length) * sizeof(ZoO_index)) <= SIZE_MAX);
ensures (((*sequence_capacity) * sizeof(ZoO_index)) <= SIZE_MAX);
ensures \separated(sequence, *sequence, sequence_capacity, sequence_length, io);
ensures ((\result == 0) || (\result == -1));
ensures
(
(\result == 0) ==>
(*sequence_length == (\old(*sequence_length) + 1))
);
ensures
(
(\result == 0) ==>
((*sequence_capacity) >= \old(*sequence_capacity))
);
ensures ((\result == 0) ==> (*sequence_length > \old(*sequence_length)));
ensures ((\result == -1) ==> ((*sequence_length) == \old(*sequence_length)));
ensures ((\result == -1) ==> ((*sequence[0]) == \old(*sequence[0])));
ensures
(
(\result == -1) ==>
((*sequence_capacity) == \old(*sequence_capacity))
);
ensures ((\result == -1) ==> ((*sequence_length) == \old(*sequence_length)));
ensures
(
(\result == -1) ==>
((*sequence_capacity) == \old(*sequence_capacity))
);
@*/
int ZoO_sequence_append_right
(
ZoO_index * sequence [const restrict static 1],
const ZoO_index word_id,
size_t sequence_capacity [const restrict static 1],
size_t sequence_length [const restrict static 1],
const struct ZoO_pipe io [const restrict static 1]
);
/*
* Compares two sequences.
* ZoO_END_OF_SEQUENCE marks the ending of a sequence, regardless of indicated
* sequence length, meaning that [10][ZoO_END_OF_SEQUENCE][9] and
* [10][ZoO_END_OF_SEQUENCE][8] are considered equal. Sequences do not have to
* contain ZoO_END_OF_SEQUENCE. [10][ZoO_END_OF_SEQUENCE] and [10] are
* considered different, [10][ZoO_END_OF_SEQUENCE]
* and [10][ZoO_END_OF_SEQUENCE][ZoO_END_OF_SEQUENCE] are considered equal.
* Same logic is applyied for ZoO_START_OF_SEQUENCE:
* [START_OF_SEQUENCE][10] is not [10], but
* [START_OF_SEQUENCE][START_OF_SEQUENCE][10] and [START_OF_SEQUENCE][10] are
* the same.
* Return:
* 1 iff {sequence_a} should be considered being more than {sequence_b}
* 0 iff {sequence_a} should be considered being equal to {sequence_b}
* -1 iff {sequence_a} should be considered being less than {sequence_b}
*/
int ZoO_sequence_cmp
(
const ZoO_index sequence_a [const],
size_t sequence_a_length,
const ZoO_index sequence_b [const],
size_t sequence_b_length
);
#endif
|
