/usr/share/doc/libntl-dev/NTL/vector.cpp.html is in libntl-dev 9.9.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>/Volumes/unix-files/u/ntl-new/ntl-9.9.0dev/doc/vector.cpp.html</title>
<meta name="Generator" content="Vim/7.1">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff" text="#000000"><font face="monospace">
<br>
<br>
<font color="#0000ed"><i>/*</i></font><font color="#0000ed"><i>*************************************************************************\</i></font><br>
<br>
<font color="#0000ed"><i>MODULE: vector</i></font><br>
<br>
<font color="#0000ed"><i>SUMMARY:</i></font><br>
<br>
<font color="#0000ed"><i>Template class for dynamic-sized vectors.</i></font><br>
<br>
<font color="#0000ed"><i>The declaration</i></font><br>
<br>
<font color="#0000ed"><i> Vec<T> v;</i></font><br>
<br>
<font color="#0000ed"><i>creates a zero-length vector. To grow this vector to length n,</i></font><br>
<font color="#0000ed"><i>execute</i></font><br>
<br>
<font color="#0000ed"><i> v.SetLength(n)</i></font><br>
<br>
<font color="#0000ed"><i>This causes space to be allocated for (at least) n elements, and also</i></font><br>
<font color="#0000ed"><i>causes the delault constructor for T to be called to initialize these</i></font><br>
<font color="#0000ed"><i>elements.</i></font><br>
<br>
<font color="#0000ed"><i>The current length of a vector is available as v.length().</i></font><br>
<br>
<font color="#0000ed"><i>The i-th vector element (counting from 0) is accessed as v[i]. If the</i></font><br>
<font color="#0000ed"><i>macro NTL_RANGE_CHECK is defined, code is emitted to test if 0 <= i <</i></font><br>
<font color="#0000ed"><i>v.length(). This check is not performed by default.</i></font><br>
<br>
<font color="#0000ed"><i>For old-time FORTRAN programmers, the i-th vector element (counting</i></font><br>
<font color="#0000ed"><i>from 1) is accessed as v(i).</i></font><br>
<br>
<font color="#0000ed"><i>Let n = v.length(). Calling v.SetLength(m) with m <= n sets the</i></font><br>
<font color="#0000ed"><i>current length of v to m (but does not call any destructors or free</i></font><br>
<font color="#0000ed"><i>any space). Calling v.SetLength(m) with m > n will allocate space and</i></font><br>
<font color="#0000ed"><i>initialize as necessary, but will leave the values of the already</i></font><br>
<font color="#0000ed"><i>allocated elements unchanged (although their addresses may change).</i></font><br>
<font color="#0000ed"><i>If T has a user-defined default constructor, that is invoked.</i></font><br>
<font color="#0000ed"><i>Otherwise, the new memory locations are "default initialized".</i></font><br>
<font color="#0000ed"><i>In particular, this means that POD types may be uninitialized.</i></font><br>
<br>
<font color="#0000ed"><i>v.MaxLength() is the largest value of n for which v.SetLength(n) was invoked,</i></font><br>
<font color="#0000ed"><i>and is equal to the number of entries that have been initialized.</i></font><br>
<font color="#0000ed"><i>v.SetMaxLength(n) will allocate space for and initialize up to n elements,</i></font><br>
<font color="#0000ed"><i>without changing v.length().</i></font><br>
<br>
<font color="#0000ed"><i>When v's destructor is called, all constructed elements will be</i></font><br>
<font color="#0000ed"><i>destructed, and all space will be relinquished.</i></font><br>
<br>
<font color="#0000ed"><i>Space is managed using malloc, realloc, and free. When a vector is</i></font><br>
<font color="#0000ed"><i>grown, a bit more space may be allocated than was requested for</i></font><br>
<font color="#0000ed"><i>efficiency reasons.</i></font><br>
<br>
<font color="#0000ed"><i>Note that when a vector is grown, the space is reallocated using</i></font><br>
<font color="#0000ed"><i>realloc, and thus the addresses of vector elements may change,</i></font><br>
<font color="#0000ed"><i>possibly creating dangling references to vector elements. One has to</i></font><br>
<font color="#0000ed"><i>be especially careful of this when using vectors passed as reference</i></font><br>
<font color="#0000ed"><i>parameters that may alias one another.</i></font><br>
<br>
<font color="#0000ed"><i>Because realloc is used to grow a vector, the objects stored</i></font><br>
<font color="#0000ed"><i>in a vector should be "relocatable"---that is, they shouldn't care</i></font><br>
<font color="#0000ed"><i>what their actual address is, which may change over time.</i></font><br>
<font color="#0000ed"><i>Most reasonable objects satisfy this constraint.</i></font><br>
<br>
<font color="#0000ed"><i>v.allocated() is the number of elements which have been allocated,</i></font><br>
<font color="#0000ed"><i>which may be more than the number elements initialized.</i></font><br>
<font color="#0000ed"><i>Note that if n <= v.allocated(), then v.SetLength(n) is guaranteed</i></font><br>
<font color="#0000ed"><i>not to cause any memory allocation, or movement of objects.</i></font><br>
<br>
<font color="#0000ed"><i>IMPLEMENTATION DETAILS:</i></font><br>
<br>
<font color="#0000ed"><i>A Vec<T> object is just a pointer to the first element of the array.</i></font><br>
<font color="#0000ed"><i>There is a control block immediately before the first element that</i></font><br>
<font color="#0000ed"><i>keeps track of several parameters: </i></font><br>
<font color="#0000ed"><i> len -- the logical length of the array (returned by length())</i></font><br>
<font color="#0000ed"><i> init -- the number of elements constructed (returned ny MaxLength())</i></font><br>
<font color="#0000ed"><i> alloc -- the number of elements for which space has been allocated</i></font><br>
<font color="#0000ed"><i> (returned by allocated())</i></font><br>
<font color="#0000ed"><i> fixed -- flag that indicates that the length is fixed </i></font><br>
<font color="#0000ed"><i> (returned by fixed())</i></font><br>
<br>
<font color="#0000ed"><i>Note that 0 <= len <= init <- alloc</i></font><br>
<br>
<font color="#0000ed"><i>COMPARISON TO STL VECTORS:</i></font><br>
<br>
<font color="#0000ed"><i>When the length of an NTL vector is reduced, no objects are destroyed.</i></font><br>
<font color="#0000ed"><i>In contrast, when the length of an STL vector is reduced, objects are</i></font><br>
<font color="#0000ed"><i>destroyed (effectively, maintaining the invariant len == init).</i></font><br>
<br>
<font color="#0000ed"><i>When the length of an NTL vector is increased, and the new value of len</i></font><br>
<font color="#0000ed"><i>exceeds the current value of alloc, the underying array of objects is</i></font><br>
<font color="#0000ed"><i>resized using malloc. This implies that existing objects are moved using</i></font><br>
<font color="#0000ed"><i>a bit-wise copy. As mentioned above, this means that objects should</i></font><br>
<font color="#0000ed"><i>be "relocatable", in the sense that they do not care what their actual</i></font><br>
<font color="#0000ed"><i>address is. Most reasonable objects satisfy this constraint. An example</i></font><br>
<font color="#0000ed"><i>of an object that does not is one that stores in one data member a pointer</i></font><br>
<font color="#0000ed"><i>to another data member within the same object.</i></font><br>
<br>
<font color="#0000ed"><i>In contrast, when the length of an STL vector is increased, an new array</i></font><br>
<font color="#0000ed"><i>is allocated, and objects from the old array are copied to the new array,</i></font><br>
<font color="#0000ed"><i>and then destroyed in the old array. This obviously is much more expensive</i></font><br>
<font color="#0000ed"><i>that NTL's strategy. However, the new "move semantics", introduced in C++11,</i></font><br>
<font color="#0000ed"><i>mitigate this issue somewhat.</i></font><br>
<br>
<font color="#0000ed"><i>Because of NTL's relocatability requirement, it is not recommended to use NTL</i></font><br>
<font color="#0000ed"><i>vectors over classes coming from the standard library, which may not satisfy</i></font><br>
<font color="#0000ed"><i>the requirement. In those cases, you could either use an STL vector, or use an</i></font><br>
<font color="#0000ed"><i>NTL vector and wrap the suspect classes in an NTL smart pointer of some kind</i></font><br>
<font color="#0000ed"><i>(SmartPtr or OptionalVal).</i></font><br>
<br>
<font color="#0000ed"><i>Note also that Facebook's open source "folly" library also provides</i></font><br>
<font color="#0000ed"><i>a vector class that uses realloc in a manner very similar to NTL's vector class.</i></font><br>
<font color="#0000ed"><i>See <a href="https://github.com/facebook/folly/blob/master/folly/docs/FBVector.md">https://github.com/facebook/folly/blob/master/folly/docs/FBVector.md</a></i></font><br>
<br>
<br>
<br>
<font color="#0000ed"><i>\*************************************************************************</i></font><font color="#0000ed"><i>*/</i></font><br>
<br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: all functions below do not throw any exceptions,</i></font><br>
<font color="#0000ed"><i>// except as noted</i></font><br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
<font color="#008b00"><b>class</b></font> Vec { <br>
<font color="#b02f60"><b>public</b></font>: <br>
<br>
Vec(); <font color="#0000ed"><i>// initially length 0</i></font><br>
<br>
Vec(<font color="#008b00"><b>const</b></font> Vec<T>& a); <br>
<font color="#0000ed"><i>// copy constructor; uses the assignment operator of T</i></font><br>
<font color="#0000ed"><i>// for copying into locations that have already been initialized,</i></font><br>
<font color="#0000ed"><i>// and uses the copy constructor for T for initializing new locations.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw</i></font><br>
<br>
Vec& <font color="#b02f60"><b>operator</b></font>=(<font color="#008b00"><b>const</b></font> Vec<T>& a); <br>
<font color="#0000ed"><i>// assignment; uses the assignment operator of T</i></font><br>
<font color="#0000ed"><i>// for copying into locations that have already been initialized,</i></font><br>
<font color="#0000ed"><i>// and uses the copy constructor for T for initializing new locations.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: weak ES (but if it throws, neither length nor MaxLength</i></font><br>
<font color="#0000ed"><i>// will change, although some previously initialized elements</i></font><br>
<font color="#0000ed"><i>// may have been assigned new values).</i></font><br>
<br>
~Vec(); <br>
<font color="#0000ed"><i>// destructor: calls T's destructor for all initialized</i></font><br>
<font color="#0000ed"><i>// elements in the vector, and then frees the vector itself</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> SetLength(<font color="#008b00"><b>long</b></font> n); <br>
<font color="#0000ed"><i>// set current length to n, growing vector if necessary</i></font><br>
<font color="#0000ed"><i>// new objects are initialized using the default contructor for T</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: strong ES (but the vector may have been</i></font><br>
<font color="#0000ed"><i>// reallocated)</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> SetLength(<font color="#008b00"><b>long</b></font> n, <font color="#008b00"><b>const</b></font> T& a); <br>
<font color="#0000ed"><i>// set current length to n, growing vector if necessary</i></font><br>
<font color="#0000ed"><i>// new objects are initialized using the copy contructor for T</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: strong ES (but the vector may have been</i></font><br>
<font color="#0000ed"><i>// reallocated)</i></font><br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> F><br>
<font color="#008b00"><b>void</b></font> SetLengthAndApply(<font color="#008b00"><b>long</b></font> n, F f);<br>
<font color="#0000ed"><i>// set current length to n, growing vector if necessary</i></font><br>
<font color="#0000ed"><i>// any new objects are initialized using defauly constructor</i></font><br>
<font color="#0000ed"><i>// for T, and after that, f is applied to each new object x</i></font><br>
<font color="#0000ed"><i>// as f(x).</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: strong ES (but the vector may have been</i></font><br>
<font color="#0000ed"><i>// reallocated)</i></font><br>
<br>
<font color="#008b00"><b>long</b></font> length() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// current length</i></font><br>
<br>
T& <font color="#b02f60"><b>operator</b></font>[](<font color="#008b00"><b>long</b></font> i);<br>
<font color="#008b00"><b>const</b></font> T& <font color="#b02f60"><b>operator</b></font>[](<font color="#008b00"><b>long</b></font> i) <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// indexing operation, starting from 0.</i></font><br>
<font color="#0000ed"><i>// The first version is applied to non-const Vec<T>,</i></font><br>
<font color="#0000ed"><i>// and returns a non-const reference to a T, while the second version</i></font><br>
<font color="#0000ed"><i>// is applied to a const Vec<T> and returns a const reference to a T.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw if range checking turned on, strong ES</i></font><br>
<br>
T& <font color="#b02f60"><b>operator</b></font>()(<font color="#008b00"><b>long</b></font> i);<br>
<font color="#008b00"><b>const</b></font> T& <font color="#b02f60"><b>operator</b></font>()(<font color="#008b00"><b>long</b></font> i) <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// indexing operation, starting from 1</i></font><br>
<font color="#0000ed"><i>// The first version is applied to non-const Vec<T>,</i></font><br>
<font color="#0000ed"><i>// and returns a non-const reference to a T, while the second version</i></font><br>
<font color="#0000ed"><i>// is applied to a const Vec<T> and returns a const reference to a T.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw if range checking turned on, strong ES</i></font><br>
<br>
T* elts();<br>
<font color="#008b00"><b>const</b></font> T* elts() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// returns address of first vector element (or 0 if no space has been</i></font><br>
<font color="#0000ed"><i>// allocated for this vector). If a vector potentially has length 0, it is</i></font><br>
<font color="#0000ed"><i>// safer to write v.elts() instead of &v[0]: the latter is not well defined</i></font><br>
<font color="#0000ed"><i>// by the C++ standard (although this is likely an academic concern).</i></font><br>
<font color="#0000ed"><i>//</i></font><br>
<font color="#0000ed"><i>// The first version is applied to non-const Vec<T>, and returns a non-const</i></font><br>
<font color="#0000ed"><i>// pointer to a T, while the second version is applied to a const Vec<T> and</i></font><br>
<font color="#0000ed"><i>// returns a const reference to a T.</i></font><br>
<br>
<br>
<font color="#008b00"><b>void</b></font> swap(Vec<T>& y);<br>
<font color="#0000ed"><i>// swap with y (fast: just swaps pointers)</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: throws if vectors are fixed and lengths do not match, strong ES</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> append(<font color="#008b00"><b>const</b></font> T& a);<br>
<font color="#0000ed"><i>// append a to end of vector; uses the assignment operator of T</i></font><br>
<font color="#0000ed"><i>// for copying into locations that have already been initialized,</i></font><br>
<font color="#0000ed"><i>// and uses the copy constructor for T for initializing new locations.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: strong ES if initializing a new element (and in any </i></font><br>
<font color="#0000ed"><i>// case, if an exception throws, length and MaxLength remain </i></font><br>
<font color="#0000ed"><i>// unchanged).</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> append(<font color="#008b00"><b>const</b></font> Vec<T>& w);<br>
<font color="#0000ed"><i>// append w to end of vector; uses the assignment operator of T</i></font><br>
<font color="#0000ed"><i>// for copying into locations that have already been initialized,</i></font><br>
<font color="#0000ed"><i>// and uses the copy constructor for T for initializing new locations.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: strong ES if initializing new elements (and in any </i></font><br>
<font color="#0000ed"><i>// case, if an exception throws, length and MaxLength remain </i></font><br>
<font color="#0000ed"><i>// unchanged).</i></font><br>
<br>
<br>
<font color="#0000ed"><i>// Alternative access interface </i></font><br>
<br>
<font color="#008b00"><b>const</b></font> T& get(<font color="#008b00"><b>long</b></font> i) <font color="#008b00"><b>const</b></font>; <br>
<font color="#0000ed"><i>// v.get(i) returns v[i]</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> put(<font color="#008b00"><b>long</b></font> i, <font color="#008b00"><b>const</b></font> T& a); <br>
<font color="#0000ed"><i>// v.put(i, a) equivalent to v[i] = q</i></font><br>
<br>
<br>
<br>
<font color="#0000ed"><i>// Some STL compatibility</i></font><br>
<br>
<font color="#008b00"><b>typedef</b></font> T value_type;<br>
<font color="#008b00"><b>typedef</b></font> value_type& reference;<br>
<font color="#008b00"><b>typedef</b></font> <font color="#008b00"><b>const</b></font> value_type& const_reference;<br>
<font color="#008b00"><b>typedef</b></font> value_type *iterator;<br>
<font color="#008b00"><b>typedef</b></font> <font color="#008b00"><b>const</b></font> value_type *const_iterator; <br>
<br>
T* data();<br>
<font color="#008b00"><b>const</b></font> T* data() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// v.data() same as v.elts()</i></font><br>
<br>
T* begin();<br>
<font color="#008b00"><b>const</b></font> T* begin() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// v.begin() same as v.elts()</i></font><br>
<br>
T* end();<br>
<font color="#008b00"><b>const</b></font> T* end() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// pointer to last element (or NULL)</i></font><br>
<br>
T& at(<font color="#008b00"><b>long</b></font> i);<br>
<font color="#008b00"><b>const</b></font> T& at(<font color="#008b00"><b>long</b></font> i) <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// indexing with range checking</i></font><br>
<br>
<br>
<font color="#0000ed"><i>// the remaining member functions are a bit esoteric (skip on first</i></font><br>
<font color="#0000ed"><i>// reading)</i></font><br>
<br>
Vec(INIT_SIZE_TYPE, <font color="#008b00"><b>long</b></font> n);<br>
<font color="#0000ed"><i>// Vec(INIT_SIZE, n) initializes vector with an intial length of n.</i></font><br>
<font color="#0000ed"><i>// new objects are initialized using the default contructor for T</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw</i></font><br>
<br>
Vec(INIT_SIZE_TYPE, <font color="#008b00"><b>long</b></font> n, <font color="#008b00"><b>const</b></font> T& a);<br>
<font color="#0000ed"><i>// Vec(INIT_SIZE, n, a) initializes vector with an intial length of n.</i></font><br>
<font color="#0000ed"><i>// new objects are initialized using the copy contructor for T</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> kill(); <br>
<font color="#0000ed"><i>// release space and set to length 0</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> SetMaxLength(<font color="#008b00"><b>long</b></font> n); <br>
<font color="#0000ed"><i>// allocates space and initializes up to n elements. Does not change</i></font><br>
<font color="#0000ed"><i>// current length</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw, strong ES</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> FixLength(<font color="#008b00"><b>long</b></font> n);<br>
<font color="#0000ed"><i>// sets length to n and prohibits all future length changes.</i></font><br>
<font color="#0000ed"><i>// FixLength may only be invoked immediately after the default</i></font><br>
<font color="#0000ed"><i>// construction or kill.</i></font><br>
<br>
<font color="#0000ed"><i>// The kill operation is also subsequently prohibited, and swap is</i></font><br>
<font color="#0000ed"><i>// allowed on fixed length vectors of the same length.</i></font><br>
<br>
<font color="#0000ed"><i>// FixLength is provided mainly to implement Mat<T>, to enforce</i></font><br>
<font color="#0000ed"><i>// the restriction that all rows have the same length.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw, strong ES</i></font><br>
<br>
<font color="#008b00"><b>void</b></font> FixAtCurrentLength();<br>
<font color="#0000ed"><i>// fixes the length at the cuurent length and prohibits</i></font><br>
<font color="#0000ed"><i>// all future length changes. </i></font><br>
<br>
<font color="#0000ed"><i>// It is required that length() == MaxLength() when called.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: if length() != MaxLength() and error is raised;</i></font><br>
<font color="#0000ed"><i>// if length() == 0, a memory allocation error may be raised.</i></font><br>
<font color="#0000ed"><i>// Strong ES.</i></font><br>
<br>
<font color="#008b00"><b>long</b></font> fixed() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// test if length has been fixed by FixLength() or FixAtCurrentLength()</i></font><br>
<br>
<font color="#008b00"><b>long</b></font> MaxLength() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// maximum length, i.e., number of allocated and initialized elements</i></font><br>
<br>
<font color="#008b00"><b>long</b></font> allocated() <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// the number of objects for which space has been allocated, but not</i></font><br>
<font color="#0000ed"><i>// necessarily initialized; this may be larger than MaxLength().</i></font><br>
<br>
T& RawGet(<font color="#008b00"><b>long</b></font> i);<br>
<font color="#008b00"><b>const</b></font> T& RawGet(<font color="#008b00"><b>long</b></font> i) <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// indexing with no range checking</i></font><br>
<br>
<font color="#008b00"><b>long</b></font> position(<font color="#008b00"><b>const</b></font> T& a) <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// returns position of a in the vector, or -1 if it is not there.</i></font><br>
<font color="#0000ed"><i>// The search is conducted from position 0 to allocated()-1 the vector, </i></font><br>
<font color="#0000ed"><i>// and an error is raised if the object is found at position MaxLength()</i></font><br>
<font color="#0000ed"><i>// or higher (in which case a references an uninitialized object).</i></font><br>
<font color="#0000ed"><i>// Note that if NTL_CLEAN_PTR flag is set, this routine takes</i></font><br>
<font color="#0000ed"><i>// linear time, and otherwise, it takes constant time.</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw (as indicated above)</i></font><br>
<br>
<font color="#008b00"><b>long</b></font> position1(<font color="#008b00"><b>const</b></font> T& a) <font color="#008b00"><b>const</b></font>;<br>
<font color="#0000ed"><i>// returns position of a in the vector, or -1 if it is not there.</i></font><br>
<font color="#0000ed"><i>// The search is conducted from position 0 to length()-1 of the vector.</i></font><br>
<font color="#0000ed"><i>// Note that if NTL_CLEAN_PTR flag is set, this routine takes</i></font><br>
<font color="#0000ed"><i>// linear time, and otherwise, it takes constant time.</i></font><br>
<br>
}; <br>
<br>
<br>
<font color="#0000ed"><i>/*</i></font><font color="#0000ed"><i>*************************************************************************\</i></font><br>
<br>
<font color="#0000ed"><i> Some utility routines</i></font><br>
<br>
<font color="#0000ed"><i>\*************************************************************************</i></font><font color="#0000ed"><i>*/</i></font><br>
<br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
<font color="#008b00"><b>void</b></font> swap(Vec<T>& x, Vec<T>& y);<br>
<font color="#0000ed"><i>// swaps x & y; same as x.swap(y)</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: same as for swap member function</i></font><br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
<font color="#008b00"><b>void</b></font> append(Vec<T>& v, <font color="#008b00"><b>const</b></font> T& a); <br>
<font color="#0000ed"><i>// appends a to the end of v; same as v.append(a)</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: same as for append member function</i></font><br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
<font color="#008b00"><b>void</b></font> append(Vec<T>& v, <font color="#008b00"><b>const</b></font> Vec<T>& w);<br>
<font color="#0000ed"><i>// appends w to the end of v; same as v.append(w)</i></font><br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: same as for append member function</i></font><br>
<br>
<br>
<br>
<font color="#0000ed"><i>/*</i></font><font color="#0000ed"><i>*************************************************************************\</i></font><br>
<br>
<font color="#0000ed"><i> Input/Output</i></font><br>
<br>
<br>
<font color="#0000ed"><i>The I/O format for a vector v with n elements is:</i></font><br>
<br>
<font color="#0000ed"><i> [v[0] v[1] ... v[n-1]]</i></font><br>
<br>
<font color="#0000ed"><i>Uses corresponding I/O operators for T</i></font><br>
<br>
<font color="#0000ed"><i>\*************************************************************************</i></font><font color="#0000ed"><i>*/</i></font><br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
istream& <font color="#b02f60"><b>operator</b></font>>>(istream&, Vec<T>&); <br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw, weak ES</i></font><br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
ostream& <font color="#b02f60"><b>operator</b></font><<(ostream&, <font color="#008b00"><b>const</b></font> Vec<T>&); <br>
<br>
<font color="#0000ed"><i>// EXCEPTIONS: may throw, weak ES</i></font><br>
<br>
<br>
<br>
<font color="#0000ed"><i>/*</i></font><font color="#0000ed"><i>*************************************************************************\</i></font><br>
<br>
<font color="#0000ed"><i> Equality Testing</i></font><br>
<br>
<font color="#0000ed"><i>\*************************************************************************</i></font><font color="#0000ed"><i>*/</i></font><br>
<br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
<font color="#008b00"><b>long</b></font> <font color="#b02f60"><b>operator</b></font>==(<font color="#008b00"><b>const</b></font> Vec<T>& a, <font color="#008b00"><b>const</b></font> Vec<T>& b); <br>
<br>
<font color="#008b00"><b>template</b></font><<font color="#008b00"><b>class</b></font> T><br>
<font color="#008b00"><b>long</b></font> <font color="#b02f60"><b>operator</b></font>!=(<font color="#008b00"><b>const</b></font> Vec<T>& a, <font color="#008b00"><b>const</b></font> Vec<T>& b);<br>
<br>
<br>
<font color="#0000ed"><i>/*</i></font><font color="#0000ed"><i>*************************************************************************\</i></font><br>
<br>
<font color="#0000ed"><i> Customized Constructors and Destructors</i></font><br>
<font color="#0000ed"><i> </i></font><br>
<font color="#0000ed"><i>Esoteric: skip on first reading...also these interfaces are subject to change</i></font><br>
<br>
<font color="#0000ed"><i>When new elements in a vector need to be constructed, one of the</i></font><br>
<font color="#0000ed"><i>following routines is called:</i></font><br>
<br>
<font color="#0000ed"><i> void BlockConstruct(T* p, long n); </i></font><br>
<font color="#0000ed"><i> // invokes T() to initialize p[i] for i = 0..n-1</i></font><br>
<br>
<font color="#0000ed"><i> void BlockConstructFromVec(T* p, long n, const T* q);</i></font><br>
<font color="#0000ed"><i> // invokes T(q[i]) to initialize p[i] for i = 0..n-1;</i></font><br>
<font color="#0000ed"><i> // q points to elements from a Vec<T></i></font><br>
<br>
<font color="#0000ed"><i> void BlockConstructFromObj(T* p, long n, const T& q);</i></font><br>
<font color="#0000ed"><i> // invokes T(q) to initialize p[i] for i = 0..n-1</i></font><br>
<br>
<br>
<font color="#0000ed"><i>When a vector is destroyed, the following routine is called:</i></font><br>
<br>
<font color="#0000ed"><i> void BlockDestroy(T* p, long n);</i></font><br>
<font color="#0000ed"><i> // invokes ~T() on p[i] for i = 0..n-1</i></font><br>
<br>
<font color="#0000ed"><i>The default behavior of these routines may be modified by </i></font><br>
<font color="#0000ed"><i>overloading these functions with a custom implementation.</i></font><br>
<br>
<font color="#0000ed"><i>EXCEPTIONS:</i></font><br>
<font color="#0000ed"><i>In order to provide exception safe code, the Construct routines</i></font><br>
<font color="#0000ed"><i>should provide strong ES; in particular, if any constructor</i></font><br>
<font color="#0000ed"><i>throws, all newly constructed objects should be destroyed.</i></font><br>
<font color="#0000ed"><i>Moreover, the BlockDestroy routine should not throw at all.</i></font><br>
<br>
<br>
<font color="#0000ed"><i>In NTL, these routines are overridden for the ZZ_p and GF2E classes,</i></font><br>
<font color="#0000ed"><i>so that many vector entries will be packed into contiguous storage</i></font><br>
<font color="#0000ed"><i>locations. This reduces the number of invocations of malloc, and</i></font><br>
<font color="#0000ed"><i>increases locality of reference.</i></font><br>
<br>
<br>
<br>
<font color="#0000ed"><i>\*************************************************************************</i></font><font color="#0000ed"><i>*/</i></font><br>
<br>
</font></body>
</html>
|