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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>~/ntl-11.4.2/doc/vec_GF2.cpp.html</title>
<meta name="Generator" content="Vim/8.0">
<meta name="plugin-version" content="vim7.4_v2">
<meta name="syntax" content="cpp">
<meta name="settings" content="use_css,pre_wrap,no_foldcolumn,expand_tabs,prevent_copy=">
<meta name="colorscheme" content="macvim">
<style type="text/css">
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #000000; background-color: #ffffff; }
body { font-family: monospace; color: #000000; background-color: #ffffff; }
* { font-size: 1em; }
.PreProc { color: #1874cd; }
.Statement { color: #b03060; font-weight: bold; }
.Comment { color: #0000ee; font-style: italic; }
.Type { color: #008b00; font-weight: bold; }
-->
</style>
<script type='text/javascript'>
<!--
-->
</script>
</head>
<body>
<pre id='vimCodeElement'>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment">MODULE: vec_GF2</span>
<span class="Comment">SUMMARY:</span>
<span class="Comment">The class Vec<GF2> is explicitly specialized. It behaves much like a generic</span>
<span class="Comment">Vec<T> (see vector.txt), but there are some differences.</span>
<span class="Comment">For efficiency, elements of a Vec<GF2> are "packed" into a word. You can still</span>
<span class="Comment">use subscript notation v[i] or v(i). For const vectors, these evaluate to</span>
<span class="Comment">values of type const GF2. For non-const vectors, these evaluate to values of</span>
<span class="Comment">the special type ref_GF2, which is defined in the GF2 header file.</span>
<span class="Comment">There are implicit conversions from ref_GF2 to const GF2 and from GF2& to</span>
<span class="Comment">ref_GF2. Therefore, if you want to declare a function that takes a non-const</span>
<span class="Comment">reference to a GF2, you should declare the parameter of type ref_GF2: this will</span>
<span class="Comment">allow you to pass variables of type GF2 as well as elements of vec_GF2's</span>
<span class="Comment">obtained through indexing.</span>
<span class="Comment">As an alternative, one can use the get and put methods below to access</span>
<span class="Comment">vector elements.</span>
<span class="Comment">There is a subtle but important difference in the semantics of Vec<GF2> and</span>
<span class="Comment">that of generic NTL vectors. With a Vec<GF2>, whenever its length is increased</span>
<span class="Comment">(via SetLength), the "new" bits are always 0. For example, if </span>
<span class="Comment">v.length() == 20, then </span>
<span class="Comment"> v.SetLength(10); v.setLength(20);</span>
<span class="Comment">will effectively clear bits 10..19 of v. This is quite different from the</span>
<span class="Comment">semantics of generic NTL vectors, where the above sequence would not change the</span>
<span class="Comment">value of v at all. One has to be aware of this difference, but it will not</span>
<span class="Comment">matter in most ordinary circumstances.</span>
<span class="Comment">Another thing to be aware of is the use of Vec<GF2> in range-based</span>
<span class="Comment">for loops. The safest ways to do this are as follows:</span>
<span class="Comment"> for (auto&& item : vec) { ... } // for read-only or read/write access</span>
<span class="Comment">or</span>
<span class="Comment"> for (GF2 item : vec) { ... } // for access via a copy</span>
<span class="Comment">Note that:</span>
<span class="Comment"> * declaring item as "auto&" or "GF2&" will yield a syntax error</span>
<span class="Comment"> * declaring item as "auto" or "const auto&" will potentially</span>
<span class="Comment"> allow code to modify vec via item, without a warning or error,</span>
<span class="Comment"> contrary to expectations (although this cannot happen if vec</span>
<span class="Comment"> itself is const)</span>
<span class="Comment">However, declaring item as "auto&&" will work as expected, and the compiler</span>
<span class="Comment">will raise an error if you try to modify a const Vec<GF2>. </span>
<span class="Comment">All of these issues arise because ref_GF2 is not a true reference, and the</span>
<span class="Comment">semantics of "auto" and "auto&" interact badly. Similar issues arise with</span>
<span class="Comment">vector<bool> in the STL.</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">template</span><>
<span class="Type">class</span> Vec<GF2> {
<span class="Statement">public</span>:
Vec(); <span class="Comment">// 0 length vector</span>
Vec(INIT_SIZE_TYPE, <span class="Type">long</span> n); <span class="Comment">// initialize to length n</span>
<span class="Comment">// usage: Vec(INIT_SIZE, n)</span>
Vec(<span class="Type">const</span> Vec<GF2>& a); <span class="Comment">// copy constructor</span>
Vec& <span class="Statement">operator</span>=(<span class="Type">const</span> Vec<GF2>& a); <span class="Comment">// assignment</span>
Vec(Vec&& a);
<span class="Comment">// move constructor (C++11 only)</span>
<span class="Comment">// declared noexcept unless NTL_EXCEPTIONS flag is set</span>
<span class="Comment">// will revert to copy constructor if a is fixed</span>
<span class="PreProc">#ifndef NTL_DISABLE_MOVE_ASSIGN</span>
Vec& <span class="Statement">operator</span>=(Vec&& a);
<span class="Comment">// move assignment (C++11 only)</span>
<span class="Comment">// declared noexcept unless NTL_EXCEPTIONS flag is set</span>
<span class="Comment">// will revert to copy assignment if *this or a is fixed</span>
<span class="PreProc">#endif</span>
~Vec(); <span class="Comment">// destructor</span>
<span class="Type">void</span> SetLength(<span class="Type">long</span> n); <span class="Comment">// set length to n bits</span>
<span class="Type">void</span> SetLength(<span class="Type">long</span> n, GF2 a);
<span class="Comment">// set length to n, if length increases, initialize new bits to a</span>
<span class="Type">void</span> SetMaxLength(<span class="Type">long</span> n); <span class="Comment">// allocate space for n bits</span>
<span class="Type">long</span> length() <span class="Type">const</span>; <span class="Comment">// current length, in bits</span>
<span class="Type">long</span> MaxLength() <span class="Type">const</span>; <span class="Comment">// maximum length, i.e., the maximum</span>
<span class="Comment">// value passed to either SetLength or SetMaxLength</span>
<span class="Comment">// since creation or last kill</span>
<span class="Type">long</span> allocated() <span class="Type">const</span>; <span class="Comment">// number of bits for which space is allocated;</span>
<span class="Comment">// if n <= v.allocated(), then v.SetLength(n)</span>
<span class="Comment">// will not result in any memory re-allocation.</span>
<span class="Comment">// INVARIANT: </span>
<span class="Comment">// length() <= MaxLength() <= allocated() < 2^(NTL_BITS_PER_LONG-4)</span>
<span class="Type">void</span> FixLength(<span class="Type">long</span> n); <span class="Comment">// fix length to n bits</span>
<span class="Comment">// can only be applied after default initialization or kill</span>
<span class="Type">void</span> FixAtCurrentLength();
<span class="Comment">// fixes the length at the cuurent length and prohibits</span>
<span class="Comment">// all future length changes. </span>
<span class="Comment">// It is required that length() == MaxLength() when called.</span>
<span class="Comment">// EXCEPTIONS: if length() != MaxLength() and error is raised;</span>
<span class="Comment">// Strong ES.</span>
<span class="Type">long</span> fixed() <span class="Type">const</span>; <span class="Comment">// test if length has been fixed</span>
<span class="Type">void</span> kill(); <span class="Comment">// free space and make length 0</span>
<span class="Type">const</span> GF2 get(<span class="Type">long</span> i) <span class="Type">const</span>; <span class="Comment">// fetch value at index i (indexing from 0)</span>
<span class="Type">void</span> put(<span class="Type">long</span> i, GF2 a); <span class="Comment">// write value a to index i (indexing from 0)</span>
<span class="Type">void</span> put(<span class="Type">long</span> i, <span class="Type">long</span> a);
<span class="Comment">// Here are the subscripting operators, defined using the</span>
<span class="Comment">// "helper" class ref_GF2</span>
ref_GF2 <span class="Statement">operator</span>[](<span class="Type">long</span> i);
ref_GF2 <span class="Statement">operator</span>()(<span class="Type">long</span> i);
<span class="Type">const</span> GF2 <span class="Statement">operator</span>[](<span class="Type">long</span> i) <span class="Type">const</span>;
<span class="Type">const</span> GF2 <span class="Statement">operator</span>()(<span class="Type">long</span> i) <span class="Type">const</span>;
<span class="Type">void</span> swap(Vec<GF2>& y);
<span class="Comment">// swap with y (fast: just swaps pointers)</span>
<span class="Type">void</span> move(Vec<GF2>& y);
<span class="Comment">// move y to *this (fast: just moves pointers)</span>
<span class="Type">void</span> append(GF2 a);
<span class="Comment">// append a to end of vector</span>
<span class="Type">void</span> append(<span class="Type">const</span> Vec<GF2>& w);
<span class="Comment">// append w to end of vector</span>
<span class="Comment">// Some partial STL compatibility...also used</span>
<span class="Comment">// to interface with the Matrix template class</span>
<span class="Type">typedef</span> GF2 value_type;
<span class="Type">typedef</span> ref_GF2 reference;
<span class="Type">typedef</span> <span class="Type">const</span> GF2 const_reference;
<span class="Type">typedef</span> <span class="Comment">/*</span><span class="Comment"> implementation defined type </span><span class="Comment">*/</span> iterator;
<span class="Type">typedef</span> <span class="Comment">/*</span><span class="Comment"> implementation defined type </span><span class="Comment">*/</span> const_iterator;
ref_GF2 at(<span class="Type">long</span> i);
<span class="Type">const</span> GF2 at(<span class="Type">long</span> i) <span class="Type">const</span>;
<span class="Comment">// indexing with range checking</span>
iterator begin();
const_iterator begin() <span class="Type">const</span>;
<span class="Comment">// pointer to beginning of vector</span>
iterator end();
const_iterator end() <span class="Type">const</span>;
<span class="Comment">// pointer to (one past) end of vector</span>
<span class="Comment">// NOTES: The iterator types act like pointers. You can perform all the</span>
<span class="Comment">// usual arithmetic on them, as well as dereferencing and subscripting.</span>
<span class="Comment">// Dereferencing an iterator yields a ref_GF2. Dereferencing a</span>
<span class="Comment">// const_iterator yields a const GF2.</span>
};
<span class="Type">void</span> swap(Vec<GF2>& x, Vec<GF2>& y);
<span class="Comment">// swap x and y (fast pointer swap)</span>
<span class="Type">void</span> append(Vec<GF2>& v, GF2 a);
<span class="Comment">// append a to v</span>
<span class="Type">void</span> append(Vec<GF2>& v, <span class="Type">const</span> Vec<GF2>& a);
<span class="Comment">// append a to v</span>
<span class="Comment">// equality operators:</span>
<span class="Type">long</span> <span class="Statement">operator</span>==(<span class="Type">const</span> Vec<GF2>& a, <span class="Type">const</span> Vec<GF2>& b);
<span class="Type">long</span> <span class="Statement">operator</span>!=(<span class="Type">const</span> Vec<GF2>& a, <span class="Type">const</span> Vec<GF2>& b);
<span class="Comment">// I/O operators:</span>
ostream& <span class="Statement">operator</span><<(ostream& s, <span class="Type">const</span> Vec<GF2>& a);
istream& <span class="Statement">operator</span>>>(istream& s, Vec<GF2>& a);
<span class="Comment">// The I/O format is [a_0 a_1 ... a_{n-1}], where each a_i is "0" or "1".</span>
<span class="Comment">// On input, the a_i may be arbitrary integers, which are reduced mod 2.</span>
<span class="Type">typedef</span> Vec<GF2> vec_GF2; <span class="Comment">// backward compatibility</span>
<span class="Comment">// utility routines:</span>
<span class="Type">void</span> clear(vec_GF2& x); <span class="Comment">// clear all bits--length unchanged</span>
<span class="Type">long</span> IsZero(<span class="Type">const</span> vec_GF2& a); <span class="Comment">// test if all bits are zero</span>
<span class="Type">void</span> shift(vec_GF2& x, <span class="Type">const</span> vec_GF2& a, <span class="Type">long</span> n);
vec_GF2 shift(<span class="Type">const</span> vec_GF2& a, <span class="Type">long</span> n);
<span class="Comment">// x = a shifted n places, where n may be positive or negative.</span>
<span class="Comment">// Generally, x[i] = a[i-n], so positive n shifts to a higher index.</span>
<span class="Comment">// The length of x is set to the length of a, and bits </span>
<span class="Comment">// are zero-filled or discarded as necessary.</span>
<span class="Type">void</span> reverse(vec_GF2& x, <span class="Type">const</span> vec_GF2& a); <span class="Comment">// c = a reversed</span>
vec_GF2 reverse(<span class="Type">const</span> vec_GF2& a);
<span class="Type">long</span> weight(<span class="Type">const</span> vec_GF2& a); <span class="Comment">// return number of 1 bits in a</span>
<span class="Comment">// arithmetic operations over GF(2):</span>
<span class="Type">void</span> add(vec_GF2& x, <span class="Type">const</span> vec_GF2& a, <span class="Type">const</span> vec_GF2& b);
<span class="Type">void</span> sub(vec_GF2& x, <span class="Type">const</span> vec_GF2& a, <span class="Type">const</span> vec_GF2& b);
<span class="Type">void</span> negate(vec_GF2& x, <span class="Type">const</span> vec_GF2& a);
<span class="Type">void</span> mul(vec_GF2& x, <span class="Type">const</span> vec_GF2& a, GF2 b);
<span class="Type">void</span> mul(vec_GF2& x, <span class="Type">const</span> vec_GF2& a, <span class="Type">long</span> b);
<span class="Type">void</span> mul(vec_GF2& x, GF2 a, <span class="Type">const</span> vec_GF2& b);
<span class="Type">void</span> mul(vec_GF2& x, <span class="Type">long</span> a, <span class="Type">const</span> vec_GF2& b);
<span class="Comment">// x = a * b</span>
<span class="Type">void</span> InnerProduct(ref_GF2 x, <span class="Type">const</span> vec_GF2& a, <span class="Type">const</span> vec_GF2& b);
<span class="Comment">// vectors may differ in length</span>
<span class="Type">void</span> VectorCopy(vec_GF2& x, <span class="Type">const</span> vec_GF2& a, <span class="Type">long</span> n);
vec_GF2 VectorCopy(<span class="Type">const</span> vec_GF2& a, <span class="Type">long</span> n);
<span class="Comment">// x = a copy of a of length exactly n.</span>
<span class="Comment">// The input is truncated or padded with zeroes, as necessary.</span>
<span class="Type">void</span> random(vec_GF2& x, <span class="Type">long</span> n); <span class="Comment">// x = random vector of length n</span>
vec_GF2 random_vec_GF2(<span class="Type">long</span> n);
<span class="Comment">// arithmetic operator notation:</span>
vec_GF2 <span class="Statement">operator</span>+(<span class="Type">const</span> vec_GF2& a, <span class="Type">const</span> vec_GF2& b);
vec_GF2 <span class="Statement">operator</span>-(<span class="Type">const</span> vec_GF2& a, <span class="Type">const</span> vec_GF2& b);
vec_GF2 <span class="Statement">operator</span>-(<span class="Type">const</span> vec_GF2& a);
<span class="Comment">// scalar mul:</span>
vec_GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> vec_GF2& a, GF2 b);
vec_GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> vec_GF2& a, <span class="Type">long</span> b);
vec_GF2 <span class="Statement">operator</span>*(GF2 a, <span class="Type">const</span> vec_GF2& b);
vec_GF2 <span class="Statement">operator</span>*(<span class="Type">long</span> a, <span class="Type">const</span> vec_GF2& b);
<span class="Comment">// inner product: </span>
<span class="Type">inline</span> GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> vec_GF2& a, <span class="Type">const</span> vec_GF2& b);
<span class="Comment">// assignment operator notation:</span>
vec_GF2& <span class="Statement">operator</span>+=(vec_GF2& x, <span class="Type">const</span> vec_GF2& a);
vec_GF2& <span class="Statement">operator</span>-=(vec_GF2& x, <span class="Type">const</span> vec_GF2& a);
vec_GF2& <span class="Statement">operator</span>*=(vec_GF2& x, GF2 a);
vec_GF2& <span class="Statement">operator</span>*=(vec_GF2& x, <span class="Type">long</span> a);
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->
|
