-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathRR.cpp.html
622 lines (396 loc) · 37.1 KB
/
RR.cpp.html
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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
<!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>/Volumes/Unix/unix-files.noindex/ntl-new/ntl-9.6.0/doc/RR.cpp.html</title>
<meta name="Generator" content="Vim/7.3">
<meta name="plugin-version" content="vim7.3_v6">
<meta name="syntax" content="cpp">
<meta name="settings" content="use_css">
<style type="text/css">
<!--
pre { font-family: monospace; color: #000000; background-color: #ffffff; }
body { font-family: monospace; color: #000000; background-color: #ffffff; }
.Statement { color: #b03060; font-weight: bold; }
.Type { color: #008b00; font-weight: bold; }
.String { color: #4a708b; }
.PreProc { color: #1874cd; }
.Comment { color: #0000ee; font-style: italic; }
-->
</style>
</head>
<body>
<pre>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment">MODULE: RR</span>
<span class="Comment">SUMMARY:</span>
<span class="Comment">The class RR is used to represent arbitrary-precision floating point</span>
<span class="Comment">numbers.</span>
<span class="Comment">The functions in this module guarantee very strong accuracy conditions</span>
<span class="Comment">which make it easy to reason about the behavior of programs using</span>
<span class="Comment">these functions.</span>
<span class="Comment">The arithmetic operations always round their results to p bits, where</span>
<span class="Comment">p is the current precision. The current precision can be changed</span>
<span class="Comment">using RR::SetPrecision(), and can be read using RR::precision(). </span>
<span class="Comment">The minimum precision that can be set is 53 bits.</span>
<span class="Comment">The maximum precision is limited only by the word size of the machine.</span>
<span class="Comment">A convenience class RRPush is provided to automatically save and</span>
<span class="Comment">restore the current precision.</span>
<span class="Comment">All arithmetic operations are implemented so that the effect is as if the</span>
<span class="Comment">result was computed exactly, and then rounded to p bits. If a number</span>
<span class="Comment">lies exactly half-way between two p-bit numbers, the "round to even"</span>
<span class="Comment">rule is used. So in particular, the computed result will have a relative error</span>
<span class="Comment">of at most 2^{-p}.</span>
<span class="Comment">The above rounding rules apply to all arithmetic operations in this</span>
<span class="Comment">module, except for the following routines:</span>
<span class="Comment">* The transcendental functions: </span>
<span class="Comment"> log, exp, log10, expm1, log1p, pow, sin, cos, ComputePi</span>
<span class="Comment">* The power function</span>
<span class="Comment">* The input and ascii to RR conversion functions when using "e"-notation </span>
<span class="Comment">For these functions, a very strong accuracy condition is still </span>
<span class="Comment">guaranteed: the computed result has a relative error of less than 2^{-p + 1}</span>
<span class="Comment">(and actually much closer to 2^{-p}).</span>
<span class="Comment">That is, it is as if the resulted were computed exactly, and then</span>
<span class="Comment">rounded to one of the two neighboring p-bit numbers (but not necessarily</span>
<span class="Comment">the closest).</span>
<span class="Comment">The behavior of all functions in this module is completely platform </span>
<span class="Comment">independent: you should get *exactly* the same results on any platform</span>
<span class="Comment">(the only exception to this rule is the random number generator).</span>
<span class="Comment">Note that because precision is variable, a number may be computed with</span>
<span class="Comment">to a high precision p', and then be used as input to an arithmetic operation</span>
<span class="Comment">when the current precision is p < p'. </span>
<span class="Comment">The above accuracy guarantees still apply; in particular, </span>
<span class="Comment">no rounding is done until *after* the operation is performed. </span>
<span class="Comment">EXAMPLE: If x and y are computed to 200 bits of precision,</span>
<span class="Comment">and then the precision is set to 100 bits, then x-y will</span>
<span class="Comment">be computed correctly to 100 bits, even if, say, x and y agree</span>
<span class="Comment">in their high-order 50 bits. If x and y had been rounded to</span>
<span class="Comment">100 bits before the subtraction, then the difference would</span>
<span class="Comment">only be accurate to 50 bits of precision.</span>
<span class="Comment">Note that the assignment operator and the copy constructor </span>
<span class="Comment">produce *exact* copies of their inputs---they are *never* rounded. </span>
<span class="Comment">This is a change in semantics from versions 2.0 and earlier</span>
<span class="Comment">in which assignment and copy rounded their outputs.</span>
<span class="Comment">This was deemed a design error and has been changed.</span>
<span class="Comment">If you want to force rounding to current precision, the easiest</span>
<span class="Comment">way to do this is with the RR to RR conversion routines:</span>
<span class="Comment"> conv(x, a);</span>
<span class="Comment">or</span>
<span class="Comment"> x = to_RR(a); </span>
<span class="Comment">This will round a to current precision and store the result in x.</span>
<span class="Comment">Note that writing</span>
<span class="Comment"> x = a + 0;</span>
<span class="Comment">or</span>
<span class="Comment"> x = a*1;</span>
<span class="Comment">also has the same effect.</span>
<span class="Comment">Unlike IEEE standard floating point, there are no "special values",</span>
<span class="Comment">like "infinity" or "not a number", nor are there any "denormalized</span>
<span class="Comment">numbers". Overflow, underflow, or taking a square root of a negative</span>
<span class="Comment">number all result in an error being raised.</span>
<span class="Comment">An RR is represented as a mantissa/exponent pair (x, e), where x is a</span>
<span class="Comment">ZZ and e is a long. The real number represented by (x, e) is x * 2^e.</span>
<span class="Comment">Zero is always represented as (0, 0). For all other numbers, x is</span>
<span class="Comment">always odd.</span>
<span class="Comment">CONVERSIONS AND PROMOTIONS:</span>
<span class="Comment">The complete set of conversion routines between RR and other types is</span>
<span class="Comment">documented in the file "conversions.txt". Conversion from any type</span>
<span class="Comment">to RR always rounds the result to the current precision.</span>
<span class="Comment">The basic operations also support the notion of "promotions", </span>
<span class="Comment">so that they promote a double to an RR. For example, one can write </span>
<span class="Comment"> x = y + 1.5;</span>
<span class="Comment">where x and y are RR's. One should be aware that these promotions are </span>
<span class="Comment">always implemented using the double to RR conversion routine.</span>
<span class="Comment">SIZE INVARIANT: max(NumBits(x), |e|) < 2^(NTL_BITS_PER_LONG-4)</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/xdouble.h></span>
<span class="PreProc">#include </span><span class="String"><NTL/quad_float.h></span>
<span class="Type">class</span> RR {
<span class="Statement">public</span>:
RR(); <span class="Comment">// = 0</span>
RR(<span class="Type">const</span> RR& a); <span class="Comment">// copy constructor</span>
<span class="Type">explicit</span> RR(<span class="Type">double</span> a); <span class="Comment">// promotion constructor</span>
RR& <span class="Statement">operator</span>=(<span class="Type">const</span> RR& a); <span class="Comment">// assignment operator</span>
<span class="Comment">// NOTE: the copy constructor and assignment operator</span>
<span class="Comment">// produce exact copies of their inputs, and do not round</span>
<span class="Comment">// to current precision. </span>
RR& <span class="Statement">operator</span>=(<span class="Type">double</span> a); <span class="Comment">// convert and assign</span>
~RR(); <span class="Comment">// destructor</span>
<span class="Type">const</span> ZZ& mantissa() <span class="Type">const</span>; <span class="Comment">// read the mantissa</span>
<span class="Type">long</span> exponent() <span class="Type">const</span>; <span class="Comment">// read the exponent</span>
<span class="Type">static</span> <span class="Type">void</span> SetPrecision(<span class="Type">long</span> p);
<span class="Comment">// set current precision to max(p, 53) bits.</span>
<span class="Comment">// The default is 150</span>
<span class="Type">static</span> <span class="Type">long</span> precision(); <span class="Comment">// read current value of precision</span>
<span class="Type">static</span> <span class="Type">void</span> SetOutputPrecision(<span class="Type">long</span> p);
<span class="Comment">// set the number of output decimal digits to max(p, 1).</span>
<span class="Comment">// The default is 10</span>
<span class="Type">static</span> <span class="Type">long</span> OutputPrecision();
<span class="Comment">// read the current number of output decimal digits</span>
};
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Comparison</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Comment">// standard comparison operators:</span>
<span class="Type">long</span> <span class="Statement">operator</span>==(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
<span class="Type">long</span> <span class="Statement">operator</span>!=(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
<span class="Type">long</span> <span class="Statement">operator</span><=(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
<span class="Type">long</span> <span class="Statement">operator</span>>=(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
<span class="Type">long</span> <span class="Statement">operator</span> <(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
<span class="Type">long</span> <span class="Statement">operator</span> >(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
<span class="Type">long</span> IsZero(<span class="Type">const</span> RR& a); <span class="Comment">// test if 0</span>
<span class="Type">long</span> IsOne(<span class="Type">const</span> RR& a); <span class="Comment">// test if 1</span>
<span class="Type">long</span> sign(<span class="Type">const</span> RR& a); <span class="Comment">// returns sign of a (+1, -1, 0)</span>
<span class="Type">long</span> compare(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b); <span class="Comment">// returns sign(a-b);</span>
<span class="Comment">// PROMOTIONS: operators ==, ..., > and function compare</span>
<span class="Comment">// promote double to RR on (a, b).</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>
RR <span class="Statement">operator</span>+(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
RR <span class="Statement">operator</span>-(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
RR <span class="Statement">operator</span>-(<span class="Type">const</span> RR& a); <span class="Comment">// unary -</span>
RR& <span class="Statement">operator</span>+=(RR& x, <span class="Type">const</span> RR& a);
RR& <span class="Statement">operator</span>+=(RR& x, <span class="Type">double</span> a);
RR& <span class="Statement">operator</span>-=(RR& x, <span class="Type">const</span> RR& a);
RR& <span class="Statement">operator</span>-=(RR& x, <span class="Type">double</span> a);
RR& <span class="Statement">operator</span>++(RR& x); <span class="Comment">// prefix</span>
<span class="Type">void</span> <span class="Statement">operator</span>++(RR& x, <span class="Type">int</span>); <span class="Comment">// postfix</span>
RR& <span class="Statement">operator</span>--(RR& x); <span class="Comment">// prefix</span>
<span class="Type">void</span> <span class="Statement">operator</span>--(RR& x, <span class="Type">int</span>); <span class="Comment">// postfix</span>
<span class="Comment">// procedural versions:</span>
<span class="Type">void</span> add(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b); <span class="Comment">// z = a+b</span>
<span class="Type">void</span> sub(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b); <span class="Comment">// z = a-b</span>
<span class="Type">void</span> negate(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = -a</span>
<span class="Comment">// PROMOTIONS: operators +, -, and procedures add, sub promote double</span>
<span class="Comment">// to RR on (a, b).</span>
<span class="Type">void</span> abs(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = |a|</span>
RR fabs(<span class="Type">const</span> RR& a);
RR abs(<span class="Type">const</span> RR& a);
<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>
RR <span class="Statement">operator</span>*(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
RR& <span class="Statement">operator</span>*=(RR& x, <span class="Type">const</span> RR& a);
RR& <span class="Statement">operator</span>*=(RR& x, <span class="Type">double</span> a);
<span class="Comment">// procedural versions:</span>
<span class="Type">void</span> mul(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b); <span class="Comment">// z = a*b</span>
<span class="Type">void</span> sqr(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a * a</span>
RR sqr(<span class="Type">const</span> RR& a);
<span class="Comment">// PROMOTIONS: operator * and procedure mul promote double to RR 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>
RR <span class="Statement">operator</span>/(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b);
RR& <span class="Statement">operator</span>/=(RR& x, <span class="Type">const</span> RR& a);
RR& <span class="Statement">operator</span>/=(RR& x, <span class="Type">double</span> a);
<span class="Comment">// procedural versions:</span>
<span class="Type">void</span> div(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b); z = a/b
<span class="Type">void</span> inv(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = 1 / a</span>
RR inv(<span class="Type">const</span> RR& a);
<span class="Comment">// PROMOTIONS: operator / and procedure div promote double to RR on (a, b).</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Transcendental functions </span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">void</span> exp(RR& res, <span class="Type">const</span> RR& x); <span class="Comment">// e^x</span>
RR exp(<span class="Type">const</span> RR& x);
<span class="Type">void</span> log(RR& res, <span class="Type">const</span> RR& x); <span class="Comment">// log(x) (natural log)</span>
RR log(<span class="Type">const</span> RR& x);
<span class="Type">void</span> log10(RR& res, <span class="Type">const</span> RR& x); <span class="Comment">// log(x)/log(10)</span>
RR log10(<span class="Type">const</span> RR& x);
<span class="Type">void</span> expm1(RR& res, <span class="Type">const</span> RR& x);
RR expm1(<span class="Type">const</span> RR& x);
<span class="Comment">// e^(x)-1; more accurate than exp(x)-1 when |x| is small</span>
<span class="Type">void</span> log1p(RR& res, <span class="Type">const</span> RR& x);
RR log1p(<span class="Type">const</span> RR& x);
<span class="Comment">// log(1 + x); more accurate than log(1 + x) when |x| is small</span>
<span class="Type">void</span> pow(RR& res, <span class="Type">const</span> RR& x, <span class="Type">const</span> RR& y); <span class="Comment">// x^y</span>
RR pow(<span class="Type">const</span> RR& x, <span class="Type">const</span> RR& y);
<span class="Type">void</span> sin(RR& res, <span class="Type">const</span> RR& x); <span class="Comment">// sin(x); restriction: |x| < 2^1000</span>
RR sin(<span class="Type">const</span> RR& x);
<span class="Type">void</span> cos(RR& res, <span class="Type">const</span> RR& x); <span class="Comment">// cos(x); restriction: |x| < 2^1000</span>
RR cos(<span class="Type">const</span> RR& x);
<span class="Type">void</span> ComputePi(RR& pi); <span class="Comment">// approximate pi to current precision</span>
RR ComputePi_RR();
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Rounding to integer values </span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Comment">/*</span><span class="Comment">** RR output **</span><span class="Comment">*/</span>
<span class="Type">void</span> trunc(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to 0</span>
RR trunc(<span class="Type">const</span> RR& a);
<span class="Type">void</span> floor(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to -infinity</span>
RR floor(<span class="Type">const</span> RR& a);
<span class="Type">void</span> ceil(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to +infinity</span>
RR ceil(<span class="Type">const</span> RR& a);
<span class="Type">void</span> round(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to nearest integer</span>
RR round(<span class="Type">const</span> RR& a); <span class="Comment">// ties are rounded to an even integer</span>
<span class="Comment">/*</span><span class="Comment">** ZZ output **</span><span class="Comment">*/</span>
<span class="Type">void</span> TruncToZZ(ZZ& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to 0</span>
ZZ TruncToZZ(<span class="Type">const</span> RR& a);
<span class="Type">void</span> FloorToZZ(ZZ& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to -infinity</span>
ZZ FloorToZZ(<span class="Type">const</span> RR& a); <span class="Comment">// same as RR to ZZ conversion</span>
<span class="Type">void</span> CeilToZZ(ZZ& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to +infinity</span>
ZZ CeilToZZ(<span class="Type">const</span> ZZ& a);
<span class="Type">void</span> RoundToZZ(ZZ& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = a, truncated to nearest integer</span>
ZZ RoundToZZ(<span class="Type">const</span> RR& a); <span class="Comment">// ties are rounded to an even integer</span>
<a name="push"></a>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Saving and restoring the current precision</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">class</span> RRPush {
<span class="Statement">public</span>:
RRPush(); <span class="Comment">// saves the cuurent precision</span>
~RRPush(); <span class="Comment">// restores the saved precision</span>
<span class="Statement">private</span>:
RRPush(<span class="Type">const</span> RRPush&); <span class="Comment">// disable</span>
<span class="Type">void</span> <span class="Statement">operator</span>=(<span class="Type">const</span> RRPush&); <span class="Comment">// disable</span>
};
<span class="Comment">// Example: </span>
<span class="Comment">//</span>
<span class="Comment">// {</span>
<span class="Comment">// RRPush push; // don't forget to declare a variable!!</span>
<span class="Comment">// RR::SetPrecsion(new_p);</span>
<span class="Comment">// ...</span>
<span class="Comment">// } // old precsion restored when scope is exited</span>
<span class="Type">class</span> RROutputPush {
<span class="Statement">public</span>:
RROutputPush(); <span class="Comment">// saves the cuurent output precision</span>
~RROutputPush(); <span class="Comment">// restores the saved output precision</span>
<span class="Statement">private</span>:
RROutputPush(<span class="Type">const</span> RROutputPush&); <span class="Comment">// disable</span>
<span class="Type">void</span> <span class="Statement">operator</span>=(<span class="Type">const</span> RROutputPush&); <span class="Comment">// disable</span>
};
<span class="Comment">// Example: </span>
<span class="Comment">//</span>
<span class="Comment">// {</span>
<span class="Comment">// RROutputPush push; // don't forget to declare a variable!!</span>
<span class="Comment">// RR::SetOutputPrecsion(new_op);</span>
<span class="Comment">// ...</span>
<span class="Comment">// } // old output precsion restored when scope is exited</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Miscelaneous</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">void</span> MakeRR(RR& z, <span class="Type">const</span> ZZ& a, <span class="Type">long</span> e);
RR MakeRR(<span class="Type">const</span> ZZ& a, <span class="Type">long</span> e);
<span class="Comment">// z = a*2^e, rounded to current precision</span>
<span class="Type">void</span> random(RR& z);
RR random_RR();
<span class="Comment">// z = pseudo-random number in the range [0,1).</span>
<span class="Comment">// Note that the behaviour of this function is somewhat platform</span>
<span class="Comment">// dependent, because the underlying pseudo-ramdom generator is.</span>
<span class="Type">void</span> SqrRoot(RR& z, <span class="Type">const</span> RR& a); <span class="Comment">// z = sqrt(a);</span>
RR SqrRoot(<span class="Type">const</span> RR& a);
RR sqrt(<span class="Type">const</span> RR& a);
<span class="Type">void</span> power(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> e); <span class="Comment">// z = a^e, e may be negative</span>
RR power(<span class="Type">const</span> RR& a, <span class="Type">long</span> e);
<span class="Type">void</span> power2(RR& z, <span class="Type">long</span> e); <span class="Comment">// z = 2^e, e may be negative</span>
RR power2_RR(<span class="Type">long</span> e);
<span class="Type">void</span> clear(RR& z); <span class="Comment">// z = 0</span>
<span class="Type">void</span> set(RR& z); <span class="Comment">// z = 1</span>
<span class="Type">void</span> RR::swap(RR& a);
<span class="Type">void</span> swap(RR& a, RR& b);
<span class="Comment">// swap (pointer swap)</span>
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Input/Output</span>
<span class="Comment">Input Syntax:</span>
<span class="Comment"><number>: [ "-" ] <unsigned-number></span>
<span class="Comment"><unsigned-number>: <dotted-number> [ <e-part> ] | <e-part></span>
<span class="Comment"><dotted-number>: <digits> | <digits> "." <digits> | "." <digits> | <digits> "."</span>
<span class="Comment"><digits>: <digit> <digits> | <digit></span>
<span class="Comment"><digit>: "0" | ... | "9"</span>
<span class="Comment"><e-part>: ( "E" | "e" ) [ "+" | "-" ] <digits></span>
<span class="Comment">Examples of valid input:</span>
<span class="Comment">17 1.5 0.5 .5 5. -.5 e10 e-10 e+10 1.5e10 .5e10 .5E10</span>
<span class="Comment">Note that the number of decimal digits of precision that are used</span>
<span class="Comment">for output can be set to any number p >= 1 by calling</span>
<span class="Comment">the routine RR::SetOutputPrecision(p). The default value of p is 10.</span>
<span class="Comment">The current value of p is returned by a call to RR::OutputPrecision().</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
ostream& <span class="Statement">operator</span><<(ostream& s, <span class="Type">const</span> RR& a);
istream& <span class="Statement">operator</span>>>(istream& s, RR& x);
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment"> Specialized routines with explicit precision parameter</span>
<span class="Comment">These routines take an explicit precision parameter p. The value of p may be</span>
<span class="Comment">any positive integer. All results are computed to *precisely* p bits of</span>
<span class="Comment">precision, regardless of the current precision (as set by RR::SetPrecision).</span>
<span class="Comment">These routines are provided both for convenience and for situations where the</span>
<span class="Comment">computation must be done with a precision that may be less than 53.</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
<span class="Type">void</span> AddPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p); <span class="Comment">// z = a + b</span>
RR AddPrec(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p);
<span class="Type">void</span> SubPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p); <span class="Comment">// z = a - b</span>
RR SubPrec(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p);
<span class="Type">void</span> NegatePrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = -a</span>
RR NegatePrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> AbsPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = |a|</span>
RR AbsPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> MulPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p); <span class="Comment">// z = a*b</span>
RR MulPrec(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p);
<span class="Type">void</span> SqrPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = a*a</span>
RR SqrPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> DivPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p); <span class="Comment">// z = a/b</span>
RR DivPrec(<span class="Type">const</span> RR& a, <span class="Type">const</span> RR& b, <span class="Type">long</span> p);
<span class="Type">void</span> InvPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = 1/a</span>
RR DivPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> SqrRootPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = sqrt(a)</span>
RR SqrRootPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> TruncPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = a, truncated to 0</span>
RR TruncPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> FloorPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = a, truncated to -infinity</span>
RR FloorPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> CeilPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = a, truncated to +infinity</span>
RR CeilPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> RoundPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = a, </span>
<span class="Comment">// truncated to nearest integer,</span>
<span class="Comment">// ties are roundec to an even </span>
<span class="Comment">// integer</span>
RR RoundPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">const</span> RR& a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">const</span> RR& a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">const</span> ZZ& a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">const</span> ZZ& a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">long</span> a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">long</span> a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">int</span> a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">int</span> a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">unsigned</span> <span class="Type">long</span> a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">unsigned</span> <span class="Type">long</span> a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">unsigned</span> <span class="Type">int</span> a, <span class="Type">long</span> p); <span class="Comment">// z = a </span>
RR ConvPrec(<span class="Type">unsigned</span> <span class="Type">int</span> a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">double</span> a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">double</span> a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">const</span> xdouble& a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">const</span> xdouble& a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">const</span> quad_float& a, <span class="Type">long</span> p); <span class="Comment">// z = a</span>
RR ConvPrec(<span class="Type">const</span> quad_float& a, <span class="Type">long</span> p);
<span class="Type">void</span> ConvPrec(RR& z, <span class="Type">const</span> <span class="Type">char</span> *s, <span class="Type">long</span> p); <span class="Comment">// read z from s</span>
RR ConvPrec(<span class="Type">const</span> <span class="Type">char</span> *s, <span class="Type">long</span> p);
istream& InputPrec(RR& z, istream& s, <span class="Type">long</span> p); <span class="Comment">// read z from s</span>
RR InputPrec(istream& s, <span class="Type">long</span> p);
<span class="Comment">// The functional variant raises an error if input</span>
<span class="Comment">// is missing or ill-formed, while procedural form</span>
<span class="Comment">// does not.</span>
<span class="Type">void</span> MakeRRPrec(RR& z, <span class="Type">const</span> ZZ& a, <span class="Type">long</span> e, <span class="Type">long</span> p); <span class="Comment">// z = a*2^e</span>
RR MakeRRPrec(<span class="Type">const</span> ZZ& a, <span class="Type">long</span> e, <span class="Type">long</span> p);
<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>
<span class="Comment">COMPATABILITY NOTES: </span>
<span class="Comment"> (1) Prior to version 5.3, the documentation indicated that under certain</span>
<span class="Comment"> circumstances, the value of the current precision could be directly set</span>
<span class="Comment"> by setting the variable RR::prec. Such usage is now considered</span>
<span class="Comment"> obsolete. To perform computations using a precision of less than 53</span>
<span class="Comment"> bits, users should use the specialized routines AddPrec, SubPrec, etc.,</span>
<span class="Comment"> documented above.</span>
<span class="Comment"> (2) The routine RoundToPrecision is obsolete, although for backward</span>
<span class="Comment"> compatability, it is still declared (in both procedural and function</span>
<span class="Comment"> forms), and is equivalent to ConvPrec.</span>
<span class="Comment"> (3) In versions 2.0 and earlier, the assignment operator and copy</span>
<span class="Comment"> constructor for the class RR rounded their outputs to the current</span>
<span class="Comment"> precision. This is no longer the case: their outputs are now exact</span>
<span class="Comment"> copies of their inputs, regardless of the current precision.</span>
<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>
</pre>
</body>
</html>