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
|
<!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>~/junk6/ntl-10.4.0/doc/ZZ_p.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; }
.String { color: #4a708b; }
.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: ZZ_p</span>
<span class="Comment">SUMMARY:</span>
<span class="Comment">The class ZZ_p is used to represent integers mod p. The modulus p may</span>
<span class="Comment">be any positive integer, not necessarily prime. </span>
<span class="Comment">Objects of the class ZZ_p are represented as a ZZ in the range 0..p-1.</span>
<span class="Comment">An executing program maintains a "current modulus", which is set to p using</span>
<span class="Comment">ZZ_p::init(p). The current modulus *must* be initialized before any operations</span>
<span class="Comment">on ZZ_p's are performed. The modulus may be changed, and a mechanism is provided</span>
<span class="Comment">for saving and restoring a modulus (see classes ZZ_pPush and ZZ_pContext below).</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="PreProc">#include </span><span class="String"><NTL/ZZ.h></span>
<span class="PreProc">#include </span><span class="String"><NTL/ZZVec.h></span>
<span class="PreProc">#include </span><span class="String"><NTL/SmartPtr.h></span>
<span class="Type">class</span> ZZ_p {
<span class="Statement">public</span>:
ZZ_p(); <span class="Comment">// initialize to 0</span>
ZZ_p(<span class="Type">const</span> ZZ_p& a); <span class="Comment">// copy constructor</span>
<span class="Type">explicit</span> ZZ_p(<span class="Type">long</span> a); <span class="Comment">// promotion constructor</span>
~ZZ_p(); <span class="Comment">// destructor</span>
ZZ_p& <span class="Statement">operator</span>=(<span class="Type">const</span> ZZ_p& a); <span class="Comment">// assignment</span>
ZZ_p& <span class="Statement">operator</span>=(<span class="Type">long</span> a); <span class="Comment">// assignment</span>
ZZ_p(ZZ_p&& a);
<span class="Comment">// move constructor (C++11 only)</span>
<span class="Comment">// declared noexcept unless NTL_EXCEPTIONS flag is set</span>
ZZ_p& <span class="Statement">operator</span>=(ZZ_p&& a);
<span class="Comment">// move assignment (C++11 only)</span>
<span class="Comment">// declared noexcept unless NTL_EXCEPTIONS flag is set</span>
<span class="Type">static</span> <span class="Type">void</span> init(<span class="Type">const</span> ZZ& p);
<span class="Comment">// ZZ_p::init(p) sets the modulus to p (p > 1)</span>
<span class="Type">static</span> <span class="Type">const</span> ZZ& modulus();
<span class="Comment">// ZZ_p::modulus() yields read-only reference to the current</span>
<span class="Comment">// modulus</span>
<span class="Comment">// typedefs to aid in generic programming</span>
<span class="Type">typedef</span> ZZ rep_type;
<span class="Type">typedef</span> ZZ_pContext context_type;
<span class="Type">typedef</span> ZZ_pBak bak_type;
<span class="Type">typedef</span> ZZ_pPush push_type;
<span class="Type">typedef</span> ZZ_pX poly_type;
};
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Access to representation</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">const</span> ZZ& rep(<span class="Type">const</span> ZZ_p& a);
<span class="Comment">// read-only access to representation of a</span>
<span class="Comment">/*</span><span class="Comment">***** Example: ******** </span>
<span class="Comment"> ZZ x;</span>
<span class="Comment"> ZZ_p a;</span>
<span class="Comment"> x = rep(a);</span>
<span class="Comment">************************</span><span class="Comment">*/</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Comparison</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">long</span> <span class="Statement">operator</span>==(<span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b);
<span class="Type">long</span> <span class="Statement">operator</span>!=(<span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b);
<span class="Comment">// PROMOTIONS: the comparison operators provide promotions</span>
<span class="Comment">// from long to ZZ_p on (a, b)</span>
<span class="Type">long</span> IsZero(<span class="Type">const</span> ZZ_p& a); <span class="Comment">// test for 0</span>
<span class="Type">long</span> IsOne(<span class="Type">const</span> ZZ_p& a); <span class="Comment">// test for 1</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Addition </span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Comment">// operator notation:</span>
ZZ_p <span class="Statement">operator</span>+(<span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b);
ZZ_p <span class="Statement">operator</span>-(<span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b);
ZZ_p <span class="Statement">operator</span>-(<span class="Type">const</span> ZZ_p& a); <span class="Comment">// unary -</span>
ZZ_p& <span class="Statement">operator</span>+=(ZZ_p& x, <span class="Type">const</span> ZZ_p& b);
ZZ_p& <span class="Statement">operator</span>+=(ZZ_p& x, <span class="Type">long</span> b);
ZZ_p& <span class="Statement">operator</span>-=(ZZ_p& x, <span class="Type">const</span> ZZ_p& b);
ZZ_p& <span class="Statement">operator</span>-=(ZZ_p& x, <span class="Type">long</span> b);
ZZ_p& <span class="Statement">operator</span>++(ZZ_p& x); <span class="Comment">// prefix</span>
<span class="Type">void</span> <span class="Statement">operator</span>++(ZZ_p& x, <span class="Type">int</span>); <span class="Comment">// postfix</span>
ZZ_p& <span class="Statement">operator</span>--(ZZ_p& x); <span class="Comment">// prefix</span>
<span class="Type">void</span> <span class="Statement">operator</span>--(ZZ_p& x, <span class="Type">int</span>); <span class="Comment">// postfix</span>
<span class="Comment">// procedural versions:</span>
<span class="Type">void</span> add(ZZ_p& x, <span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b); <span class="Comment">// x = a + b</span>
<span class="Type">void</span> sub(ZZ_p& x, <span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b); <span class="Comment">// x = a - b </span>
<span class="Type">void</span> negate(ZZ_p& x, <span class="Type">const</span> ZZ_p& a); <span class="Comment">// x = -a</span>
<span class="Comment">// PROMOTIONS: binary +, - and procedures add, sub provide promotions</span>
<span class="Comment">// from long to ZZ_p on (a, b)</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Multiplication </span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Comment">// operator notation:</span>
ZZ_p <span class="Statement">operator</span>*(<span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b);
ZZ_p& <span class="Statement">operator</span>*=(ZZ_p& x, <span class="Type">const</span> ZZ_p& b);
ZZ_p& <span class="Statement">operator</span>*=(ZZ_p& x, <span class="Type">long</span> b);
<span class="Comment">// procedural versions:</span>
<span class="Type">void</span> mul(ZZ_p& x, <span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b); <span class="Comment">// x = a * b</span>
<span class="Type">void</span> sqr(ZZ_p& x, <span class="Type">const</span> ZZ_p& a); <span class="Comment">// x = a^2</span>
ZZ_p sqr(<span class="Type">const</span> ZZ_p& a); <span class="Comment">// x = a^2</span>
<span class="Comment">// PROMOTIONS: operator * and procedure mul provide promotions </span>
<span class="Comment">// from long to ZZ_p on (a, b)</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Division</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Comment">// operator notation:</span>
ZZ_p <span class="Statement">operator</span>/(<span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b);
ZZ_p& <span class="Statement">operator</span>/=(ZZ_p& x, <span class="Type">const</span> ZZ_p& b);
ZZ_p& <span class="Statement">operator</span>/=(ZZ_p& x, <span class="Type">long</span> b);
<span class="Comment">// procedural versions:</span>
<span class="Type">void</span> div(ZZ_p& x, <span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ_p& b);
<span class="Comment">// x = a/b.</span>
<span class="Comment">// By default, if b is not invertible, an error is raised. </span>
<span class="Comment">// If exceptions are enabled, an InvModErrorObject is thrown</span>
<span class="Comment">// (see documentation in the ZZ module); otherwise, the program</span>
<span class="Comment">// aborts with an error message.</span>
<span class="Comment">// For backward compatibility, one can define an error handler</span>
<span class="Comment">// void H(const ZZ_p& b), and setting ZZ_p::DivHandler = H. Then if b</span>
<span class="Comment">// != 0 and b is not invertible, the function H is invoked with b as</span>
<span class="Comment">// its argument. If the error handler function returns to its caller,</span>
<span class="Comment">// error handling proceeds as described above.</span>
<span class="Type">void</span> inv(ZZ_p& x, <span class="Type">const</span> ZZ_p& a); <span class="Comment">// x = 1/a</span>
ZZ_p inv(<span class="Type">const</span> ZZ_p& a);
<span class="Comment">// Error handling is the same as above.</span>
<span class="Comment">// PROMOTIONS: operator / and procedure div provide promotions</span>
<span class="Comment">// from long to ZZ_p on (a, b)</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Exponentiation</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">void</span> power(ZZ_p& x, <span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ& e); <span class="Comment">// x = a^e (e may be negative)</span>
ZZ_p power(<span class="Type">const</span> ZZ_p& a, <span class="Type">const</span> ZZ& e); <span class="Comment">// functional variants</span>
<span class="Type">void</span> power(ZZ_p& x, <span class="Type">const</span> ZZ_p& a, <span class="Type">long</span> e);
ZZ_p power(ZZ_p& x, <span class="Type">const</span> ZZ_p& a, <span class="Type">long</span> e);
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Random Elements</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">void</span> random(ZZ_p& x);
ZZ_p random_ZZ_p();
<span class="Comment">// x = random element in ZZ_p. </span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Input/Output</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
ostream& <span class="Statement">operator</span><<(ostream& s, <span class="Type">const</span> ZZ_p& a);
istream& <span class="Statement">operator</span>>>(istream& s, ZZ_p& x);
<span class="Comment">// a ZZ is read and reduced mod p</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Modulus Switching </span>
<span class="Comment">A class ZZ_pPush is provided for "backing up" the current modulus</span>
<span class="Comment">and installing a new one.</span>
<span class="Comment">Here is what you do to save the current modulus, temporarily</span>
<span class="Comment">set it to p, and automatically restore it:</span>
<span class="Comment"> { </span>
<span class="Comment"> ZZ_pPush push(p); </span>
<span class="Comment"> ...</span>
<span class="Comment"> }</span>
<span class="Comment">The constructor for push will save the current modulus, and install p as the</span>
<span class="Comment">current modulus. The destructor for push will restore the old modulus when the</span>
<span class="Comment">scope enclosing it exits. This is the so-called RAII (resource acquisition is</span>
<span class="Comment">initialization) paradigm.</span>
<span class="Comment">You could also do the following:</span>
<span class="Comment"> {</span>
<span class="Comment"> ZZ_pPush push; // just backup current modulus</span>
<span class="Comment"> ...</span>
<span class="Comment"> ZZ_p::init(p1); // install p1 </span>
<span class="Comment"> ...</span>
<span class="Comment"> ZZ_p::init(p2); // install p2</span>
<span class="Comment"> // reinstall original modulus at close of scope</span>
<span class="Comment"> }</span>
<span class="Comment"> </span>
<span class="Comment">The ZZ_pPush interface is good for implementing simple stack-like</span>
<span class="Comment">modulus "context switching". For more general context switching,</span>
<span class="Comment">see ZZ_pContext below. There is also an older ZZ_pBak class</span>
<span class="Comment">that may also be useful.</span>
<span class="Comment">..........................................................................</span>
<span class="Comment">It is critical that ZZ_p objects created under one ZZ_p modulus are not used in</span>
<span class="Comment">any non-trivial way "out of context", i.e., under a different (or undefined)</span>
<span class="Comment">ZZ_p modulus. However, for ease-of-use, some operations may be safely</span>
<span class="Comment">performed out of context. These safe operations include: the default and copy</span>
<span class="Comment">constructor, the destructor, and the assignment operator. In addition is is</span>
<span class="Comment">generally safe to read any ZZ_p object out of context (i.e., printing it out, or</span>
<span class="Comment">fetching its underlying representive using the rep() function).</span>
<span class="Comment">Any unsafe uses out of context are not in general checked, and may </span>
<span class="Comment">lead to unpredictable behavior.</span>
<span class="Comment">NOTE: the implementation of Vec<ZZ_p> is specialized to manage memory more</span>
<span class="Comment">efficiently than in the default implementation of Vec<T>. Specifically,</span>
<span class="Comment">contiguous elements in a Vec<ZZ_p> are allocated in a contiguous region of</span>
<span class="Comment">memory. This reduces the number of calls to the memory allocator, and --- more</span>
<span class="Comment">significantly --- leads to greater locality of reference. A consequence of</span>
<span class="Comment">this implementation is that any calls to SetLength on a Vec<ZZ_p> object will</span>
<span class="Comment">need to use information about the current modulus, and so such calls should</span>
<span class="Comment">only be done "in context". That said, it is still safe to construct a</span>
<span class="Comment">Vec<ZZ_p> using the default or copy contructor, and to assign or append one</span>
<span class="Comment">Vec<ZZ_p> to another "out of context".</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Comment">// A convenient interface for common cases:</span>
<span class="Type">class</span> ZZ_pPush {
<span class="Statement">public</span>:
ZZ_pPush(); <span class="Comment">// backup current modulus</span>
<span class="Type">explicit</span> ZZ_pPush(<span class="Type">const</span> ZZ& p);
<span class="Type">explicit</span> ZZ_pPush(<span class="Type">const</span> ZZ_pContext& context);
<span class="Comment">// backup current modulus and install the given one</span>
<span class="Statement">private</span>:
ZZ_pPush(<span class="Type">const</span> ZZ_pPush&); <span class="Comment">// disabled</span>
<span class="Type">void</span> <span class="Statement">operator</span>=(<span class="Type">const</span> ZZ_pPush&); <span class="Comment">// disabled</span>
};
<span class="Comment">// more general context switching:</span>
<span class="Comment">// A ZZ_pContext object has a modulus q (possibly "null")</span>
<span class="Type">class</span> ZZ_pContext {
<span class="Statement">public</span>:
ZZ_pContext(); <span class="Comment">// q = "null"</span>
<span class="Type">explicit</span> ZZ_pContext(<span class="Type">const</span> ZZ& p); <span class="Comment">// q = p</span>
<span class="Type">void</span> save(); <span class="Comment">// q = CurrentModulus</span>
<span class="Type">void</span> restore() <span class="Type">const</span>; <span class="Comment">// CurrentModulus = q</span>
ZZ_pContext(<span class="Type">const</span> ZZ_pContext&); <span class="Comment">// copy</span>
ZZ_pContext& <span class="Statement">operator</span>=(<span class="Type">const</span> ZZ_pContext&); <span class="Comment">// assignment</span>
~ZZ_pContext(); <span class="Comment">// destructor</span>
};
<span class="Comment">// An older interface:</span>
<span class="Comment">// To describe this logic, think of a ZZ_pBak object</span>
<span class="Comment">// of having two components: a modulus q (possibly "null") and </span>
<span class="Comment">// an "auto-restore bit" b.</span>
<span class="Type">class</span> ZZ_pBak {
<span class="Statement">public</span>:
ZZ_pBak(); <span class="Comment">// q = "null", b = 0</span>
~ZZ_pBak(); <span class="Comment">// if (b) CurrentModulus = q</span>
<span class="Type">void</span> save(); <span class="Comment">// q = CurrentModulus, b = 1 </span>
<span class="Type">void</span> restore(); <span class="Comment">// CurrentModulus = q, b = 0</span>
<span class="Statement">private</span>:
ZZ_pBak(<span class="Type">const</span> ZZ_pBak&); <span class="Comment">// copy disabled</span>
<span class="Type">void</span> <span class="Statement">operator</span>=(<span class="Type">const</span> ZZ_pBak&); <span class="Comment">// assignment disabled</span>
};
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Miscellany</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">void</span> clear(ZZ_p& x); <span class="Comment">// x = 0</span>
<span class="Type">void</span> set(ZZ_p& x); <span class="Comment">// x = 1</span>
<span class="Type">static</span> <span class="Type">long</span> ZZ_p::ModulusSize();
<span class="Comment">// ZZ_p::ModulusSize() returns ZZ_p::modulus().size()</span>
<span class="Type">static</span> <span class="Type">const</span> ZZ_p& ZZ_p::zero();
<span class="Comment">// ZZ_p::zero() yields a read-only reference to zero</span>
<span class="Type">void</span> swap(ZZ_p& x, ZZ_p& y);
<span class="Comment">// swap x and y (done by "pointer swapping", if possible).</span>
<span class="Type">void</span> ZZ_p::swap(ZZ& x);
<span class="Comment">// swap member function</span>
ZZ_p::ZZ_p(INIT_NO_ALLOC_TYPE);
<span class="Comment">// special constructor: invoke as ZZ_p x(INIT_NO_ALLOC);</span>
<span class="Comment">// initializes x to 0, but allocates no space (this is now the default)</span>
ZZ_p::ZZ_p(INIT_ALLOC_TYPE);
<span class="Comment">// special constructor: invoke as ZZ_p x(INIT_ALLOC);</span>
<span class="Comment">// initializes x to 0, but allocates space</span>
ZZ_p::allocate();
<span class="Comment">// useful in conjunction with the INIT_NO_ALLLOC constructor:</span>
<span class="Comment">// x.allocate() will pre-allocate space for x, using the</span>
<span class="Comment">// current modulus</span>
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->
|