Document mpz/mpq/mpf_class swap functions.

This commit is contained in:
William Hart 2014-03-27 15:45:23 +00:00
parent 431d655e69
commit 0fef849a42
4 changed files with 102 additions and 78 deletions

View File

@ -25,7 +25,7 @@ END-INFO-DIR-ENTRY

Indirect:
mpir.info-1: 1044
mpir.info-2: 299956
mpir.info-2: 300280

Tag Table:
(Indirect)
@ -105,73 +105,73 @@ Node: C++ Formatted Input215791
Node: C++ Class Interface217699
Node: C++ Interface General218697
Node: C++ Interface Integers221777
Node: C++ Interface Rationals225163
Node: C++ Interface Floats228809
Node: C++ Interface Random Numbers234036
Node: C++ Interface Limitations236144
Node: Custom Allocation238990
Node: Language Bindings243636
Node: Algorithms247666
Node: Multiplication Algorithms248371
Node: Basecase Multiplication249583
Node: Karatsuba Multiplication251495
Node: Toom 3-Way Multiplication255125
Node: Toom 4-Way Multiplication261541
Node: FFT Multiplication262915
Node: Other Multiplication268341
Node: Unbalanced Multiplication271023
Node: Division Algorithms271919
Node: Single Limb Division272267
Node: Basecase Division275187
Node: Divide and Conquer Division276390
Node: Exact Division278660
Node: Exact Remainder281860
Node: Small Quotient Division284153
Node: Greatest Common Divisor Algorithms285752
Node: Binary GCD286044
Node: Lehmer's GCD288720
Node: Subquadratic GCD290924
Node: Extended GCD293378
Node: Jacobi Symbol293937
Node: Powering Algorithms294854
Node: Normal Powering Algorithm295118
Node: Modular Powering Algorithm295647
Node: Root Extraction Algorithms296711
Node: Square Root Algorithm297027
Node: Nth Root Algorithm299170
Node: Perfect Square Algorithm299956
Node: Perfect Power Algorithm302043
Node: Radix Conversion Algorithms302665
Node: Binary to Radix303042
Node: Radix to Binary306973
Node: Other Algorithms308938
Node: Prime Testing Algorithm309292
Node: Factorial Algorithm310519
Node: Binomial Coefficients Algorithm311956
Node: Fibonacci Numbers Algorithm312851
Node: Lucas Numbers Algorithm315327
Node: Random Number Algorithms316049
Node: Assembler Coding318173
Node: Assembler Code Organisation319150
Node: Assembler Basics320123
Node: Assembler Carry Propagation321282
Node: Assembler Cache Handling323120
Node: Assembler Functional Units325288
Node: Assembler Floating Point326909
Node: Assembler SIMD Instructions330692
Node: Assembler Software Pipelining331681
Node: Assembler Loop Unrolling332749
Node: Assembler Writing Guide334969
Node: Internals337739
Node: Integer Internals338253
Node: Rational Internals340510
Node: Float Internals341750
Node: Raw Output Internals349078
Node: C++ Interface Internals350273
Node: Contributors353560
Node: References362555
Node: GNU Free Documentation License370302
Node: Concept Index395472
Node: Function Index438211
Node: C++ Interface Rationals225271
Node: C++ Interface Floats229025
Node: C++ Interface Random Numbers234360
Node: C++ Interface Limitations236468
Node: Custom Allocation239314
Node: Language Bindings243960
Node: Algorithms247990
Node: Multiplication Algorithms248695
Node: Basecase Multiplication249907
Node: Karatsuba Multiplication251819
Node: Toom 3-Way Multiplication255449
Node: Toom 4-Way Multiplication261865
Node: FFT Multiplication263239
Node: Other Multiplication268665
Node: Unbalanced Multiplication271347
Node: Division Algorithms272243
Node: Single Limb Division272591
Node: Basecase Division275511
Node: Divide and Conquer Division276714
Node: Exact Division278984
Node: Exact Remainder282184
Node: Small Quotient Division284477
Node: Greatest Common Divisor Algorithms286076
Node: Binary GCD286368
Node: Lehmer's GCD289044
Node: Subquadratic GCD291248
Node: Extended GCD293702
Node: Jacobi Symbol294261
Node: Powering Algorithms295178
Node: Normal Powering Algorithm295442
Node: Modular Powering Algorithm295971
Node: Root Extraction Algorithms297035
Node: Square Root Algorithm297351
Node: Nth Root Algorithm299494
Node: Perfect Square Algorithm300280
Node: Perfect Power Algorithm302367
Node: Radix Conversion Algorithms302989
Node: Binary to Radix303366
Node: Radix to Binary307297
Node: Other Algorithms309262
Node: Prime Testing Algorithm309616
Node: Factorial Algorithm310843
Node: Binomial Coefficients Algorithm312280
Node: Fibonacci Numbers Algorithm313175
Node: Lucas Numbers Algorithm315651
Node: Random Number Algorithms316373
Node: Assembler Coding318497
Node: Assembler Code Organisation319474
Node: Assembler Basics320447
Node: Assembler Carry Propagation321606
Node: Assembler Cache Handling323444
Node: Assembler Functional Units325612
Node: Assembler Floating Point327233
Node: Assembler SIMD Instructions331016
Node: Assembler Software Pipelining332005
Node: Assembler Loop Unrolling333073
Node: Assembler Writing Guide335293
Node: Internals338063
Node: Integer Internals338577
Node: Rational Internals340834
Node: Float Internals342074
Node: Raw Output Internals349402
Node: C++ Interface Internals350597
Node: Contributors353884
Node: References362879
Node: GNU Free Documentation License370626
Node: Concept Index395796
Node: Function Index438535

End Tag Table

View File

@ -5313,6 +5313,8 @@ File: mpir.info, Node: C++ Interface Integers, Next: C++ Interface Rationals,
-- Function: int mpz_class::set_str (const string& STR, int BASE)
-- Function: int sgn (mpz_class OP)
-- Function: mpz_class sqrt (mpz_class OP)
-- Function: void mpz_class::swap (mpz_class& OP)
-- Function: void swap (mpz_class& OP1, mpz_class& OP2)
These functions provide a C++ class interface to the corresponding
MPIR C routines.
@ -5381,6 +5383,8 @@ called.
-- Function: int mpq_class::set_str (const char *STR, int BASE)
-- Function: int mpq_class::set_str (const string& STR, int BASE)
-- Function: int sgn (mpq_class OP)
-- Function: void mpq_class::swap (mpq_class& OP)
-- Function: void swap (mpq_class& OP1, mpq_class& OP2)
These functions provide a C++ class interface to the corresponding
MPIR C routines.
@ -5503,6 +5507,8 @@ used if this doesn't suit.
-- Function: int mpf_class::set_str (const string& STR, int BASE)
-- Function: int sgn (mpf_class OP)
-- Function: mpf_class sqrt (mpf_class OP)
-- Function: void mpf_class::swap (mpf_class& OP)
-- Function: void swap (mpf_class& OP1, mpf_class& OP2)
-- Function: mpf_class trunc (mpf_class OP)
These functions provide a C++ class interface to the corresponding
MPIR C routines.

View File

@ -2909,7 +2909,7 @@ Function and Type Index
* mpf_class::get_mpf_t: C++ Interface General.
(line 66)
* mpf_class::get_prec: C++ Interface Floats.
(line 99)
(line 101)
* mpf_class::get_si: C++ Interface Floats.
(line 82)
* mpf_class::get_str: C++ Interface Floats.
@ -2921,11 +2921,13 @@ Function and Type Index
* mpf_class::operator=: C++ Interface Floats.
(line 46)
* mpf_class::set_prec: C++ Interface Floats.
(line 100)
(line 102)
* mpf_class::set_prec_raw: C++ Interface Floats.
(line 101)
(line 103)
* mpf_class::set_str: C++ Interface Floats.
(line 86)
* mpf_class::swap: C++ Interface Floats.
(line 90)
* mpf_clear: Initializing Floats. (line 37)
* mpf_clears: Initializing Floats. (line 41)
* mpf_cmp: Float Comparison. (line 7)
@ -3073,21 +3075,23 @@ Function and Type Index
* mpq_class::get_d: C++ Interface Rationals.
(line 46)
* mpq_class::get_den: C++ Interface Rationals.
(line 58)
(line 60)
* mpq_class::get_den_mpz_t: C++ Interface Rationals.
(line 68)
(line 70)
* mpq_class::get_mpq_t: C++ Interface General.
(line 65)
* mpq_class::get_num: C++ Interface Rationals.
(line 57)
(line 59)
* mpq_class::get_num_mpz_t: C++ Interface Rationals.
(line 67)
(line 69)
* mpq_class::get_str: C++ Interface Rationals.
(line 47)
* mpq_class::mpq_class: C++ Interface Rationals.
(line 11)
* mpq_class::set_str: C++ Interface Rationals.
(line 48)
* mpq_class::swap: C++ Interface Rationals.
(line 51)
* mpq_clear: Initializing Rationals.
(line 16)
* mpq_clears: Initializing Rationals.
@ -3196,6 +3200,8 @@ Function and Type Index
(line 7)
* mpz_class::set_str: C++ Interface Integers.
(line 54)
* mpz_class::swap: C++ Interface Integers.
(line 58)
* mpz_clear: Initializing Integers.
(line 41)
* mpz_clears: Initializing Integers.
@ -3423,7 +3429,7 @@ Function and Type Index
* operator<<: C++ Formatted Output.
(line 11)
* operator>> <1>: C++ Interface Rationals.
(line 77)
(line 79)
* operator>>: C++ Formatted Input. (line 11)
* sgn <1>: C++ Interface Floats.
(line 88)
@ -3435,7 +3441,13 @@ Function and Type Index
(line 89)
* sqrt: C++ Interface Integers.
(line 57)
* swap <1>: C++ Interface Floats.
(line 91)
* swap <2>: C++ Interface Rationals.
(line 52)
* swap: C++ Interface Integers.
(line 59)
* trunc: C++ Interface Floats.
(line 90)
(line 92)

View File

@ -6382,6 +6382,8 @@ mpz_fdiv_q (q.get_mpz_t(), a.get_mpz_t(), d.get_mpz_t());
@deftypefunx int mpz_class::set_str (const string& @var{str}, int @var{base})
@deftypefunx int sgn (mpz_class @var{op})
@deftypefunx mpz_class sqrt (mpz_class @var{op})
@deftypefunx void mpz_class::swap (mpz_class& @var{op})
@deftypefunx void swap (mpz_class& @var{op1}, mpz_class& @var{op2})
These functions provide a C++ class interface to the corresponding MPIR C
routines.
@ -6454,6 +6456,8 @@ form, and will return results in canonical form.
@deftypefunx int mpq_class::set_str (const char *@var{str}, int @var{base})
@deftypefunx int mpq_class::set_str (const string& @var{str}, int @var{base})
@deftypefunx int sgn (mpq_class @var{op})
@deftypefunx void mpq_class::swap (mpq_class& @var{op})
@deftypefunx void swap (mpq_class& @var{op1}, mpq_class& @var{op2})
These functions provide a C++ class interface to the corresponding MPIR C
routines.
@ -6586,6 +6590,8 @@ with the builtin float types.
@deftypefunx int mpf_class::set_str (const string& @var{str}, int @var{base})
@deftypefunx int sgn (mpf_class @var{op})
@deftypefunx mpf_class sqrt (mpf_class @var{op})
@deftypefunx void mpf_class::swap (mpf_class& @var{op})
@deftypefunx void swap (mpf_class& @var{op1}, mpf_class& @var{op2})
@deftypefunx mpf_class trunc (mpf_class @var{op})
These functions provide a C++ class interface to the corresponding MPIR C
routines.