cpython-lru_cache-weakref: Modules/_decimal/docstrings.h annotate

annotate Modules/_decimal/docstrings.h @ 79691:05c8928362ee

Merge __next__ method link fixes with 3.3.

author	Ezio Melotti <ezio.melotti@gmail.com>
date	Fri, 12 Oct 2012 13:46:37 +0300
parents	7355550d5357
children	29becac5dd9b

rev	line source
75850 7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	1 /*
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	2 * Copyright (c) 2001-2012 Python Software Foundation. All Rights Reserved.
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	3 * Modified and extended by Stefan Krah.
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	4 */
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	5
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	6
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	7 #ifndef DOCSTRINGS_H
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	8 #define DOCSTRINGS_H
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	9
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	10
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	11 #include "pymacro.h"
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	12
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	13
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	14 /******************************************************************************/
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	15 /* Module */
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	16 /******************************************************************************/
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	17
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	18
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	19 PyDoc_STRVAR(doc__decimal,
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	20 "C decimal arithmetic module");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	21
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	22 PyDoc_STRVAR(doc_getcontext,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	23 getcontext() - Get the current default context.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	24 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	25
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	26 PyDoc_STRVAR(doc_setcontext,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	27 setcontext(c) - Set a new default context.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	28 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	29
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	30 PyDoc_STRVAR(doc_localcontext,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	31 localcontext(c) - Return a context manager that will set the default context\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	32 to a copy of c on entry to the with-statement and restore the previous default\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	33 context when exiting the with-statement. If no context is specified, a copy of\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	34 the current default context is used.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	35 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	36
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	37 #ifdef EXTRA_FUNCTIONALITY
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	38 PyDoc_STRVAR(doc_ieee_context,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	39 IEEEContext(bits) - Return a context object initialized to the proper values for\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	40 one of the IEEE interchange formats. The argument must be a multiple of 32 and\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	41 less than IEEE_CONTEXT_MAX_BITS. For the most common values, the constants\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	42 DECIMAL32, DECIMAL64 and DECIMAL128 are provided.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	43 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	44 #endif
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	45
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	46
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	47 /******************************************************************************/
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	48 /* Decimal Object and Methods */
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	49 /******************************************************************************/
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	50
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	51 PyDoc_STRVAR(doc_decimal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	52 Decimal([value[, context]]): Construct a new Decimal object from value.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	53 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	54 value can be an integer, string, tuple, or another Decimal object.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	55 If no value is given, return Decimal('0'). The context does not affect\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	56 the conversion and is only passed to determine if the InvalidOperation\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	57 trap is active.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	58 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	59
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	60 PyDoc_STRVAR(doc_adjusted,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	61 adjusted() - Return the adjusted exponent of the number.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	62 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	63 Defined as exp + digits - 1.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	64 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	65
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	66 PyDoc_STRVAR(doc_as_tuple,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	67 as_tuple() - Return a tuple representation of the number.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	68 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	69
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	70 PyDoc_STRVAR(doc_canonical,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	71 canonical() - Return the canonical encoding of the argument. Currently,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	72 the encoding of a Decimal instance is always canonical, so this operation\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	73 returns its argument unchanged.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	74 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	75
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	76 PyDoc_STRVAR(doc_compare,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	77 compare(other[, context]) - Compare self to other. Return a decimal value:\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	78 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	79 a or b is a NaN ==> Decimal('NaN')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	80 a < b ==> Decimal('-1')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	81 a == b ==> Decimal('0')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	82 a > b ==> Decimal('1')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	83 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	84
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	85 PyDoc_STRVAR(doc_compare_signal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	86 compare_signal(other[, context]) - Identical to compare, except that\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	87 all NaNs signal.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	88 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	89
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	90 PyDoc_STRVAR(doc_compare_total,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	91 compare_total(other) - Compare two operands using their abstract representation\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	92 rather than their numerical value. Similar to the compare() method, but the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	93 result gives a total ordering on Decimal instances. Two Decimal instances with\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	94 the same numeric value but different representations compare unequal in this\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	95 ordering:\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	96 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	97 >>> Decimal('12.0').compare_total(Decimal('12'))\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	98 Decimal('-1')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	99 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	100 Quiet and signaling NaNs are also included in the total ordering. The result\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	101 of this function is Decimal('0') if both operands have the same representation,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	102 Decimal('-1') if the first operand is lower in the total order than the second,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	103 and Decimal('1') if the first operand is higher in the total order than the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	104 second operand. See the specification for details of the total order.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	105 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	106
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	107 PyDoc_STRVAR(doc_compare_total_mag,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	108 compare_total_mag(other) - Compare two operands using their abstract\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	109 representation rather than their value as in compare_total(), but\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	110 ignoring the sign of each operand. x.compare_total_mag(y) is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	111 equivalent to x.copy_abs().compare_total(y.copy_abs()).\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	112 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	113
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	114 PyDoc_STRVAR(doc_conjugate,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	115 conjugate() - Return self.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	116 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	117
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	118 PyDoc_STRVAR(doc_copy_abs,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	119 copy_abs() - Return the absolute value of the argument. This operation\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	120 is unaffected by the context and is quiet: no flags are changed and no\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	121 rounding is performed.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	122 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	123
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	124 PyDoc_STRVAR(doc_copy_negate,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	125 copy_negate() - Return the negation of the argument. This operation is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	126 unaffected by the context and is quiet: no flags are changed and no\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	127 rounding is performed.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	128 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	129
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	130 PyDoc_STRVAR(doc_copy_sign,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	131 copy_sign(other) - Return a copy of the first operand with the sign set\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	132 to be the same as the sign of the second operand. For example:\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	133 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	134 >>> Decimal('2.3').copy_sign(Decimal('-1.5'))\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	135 Decimal('-2.3')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	136 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	137 This operation is unaffected by the context and is quiet: no flags are\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	138 changed and no rounding is performed.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	139 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	140
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	141 PyDoc_STRVAR(doc_exp,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	142 exp([context]) - Return the value of the (natural) exponential function e**x\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	143 at the given number. The function always uses the ROUND_HALF_EVEN mode and\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	144 the result is correctly rounded.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	145 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	146
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	147 PyDoc_STRVAR(doc_from_float,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	148 from_float(f) - Class method that converts a float to a decimal number, exactly.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	149 Since 0.1 is not exactly representable in binary floating point,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	150 Decimal.from_float(0.1) is not the same as Decimal('0.1').\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	151 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	152 >>> Decimal.from_float(0.1)\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	153 Decimal('0.1000000000000000055511151231257827021181583404541015625')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	154 >>> Decimal.from_float(float('nan'))\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	155 Decimal('NaN')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	156 >>> Decimal.from_float(float('inf'))\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	157 Decimal('Infinity')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	158 >>> Decimal.from_float(float('-inf'))\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	159 Decimal('-Infinity')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	160 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	161 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	162
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	163 PyDoc_STRVAR(doc_fma,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	164 fma(other, third[, context]) - Fused multiply-add. Return self*other+third\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	165 with no rounding of the intermediate product self*other.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	166 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	167 >>> Decimal(2).fma(3, 5)\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	168 Decimal('11')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	169 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	170 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	171
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	172 PyDoc_STRVAR(doc_is_canonical,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	173 is_canonical() - Return True if the argument is canonical and False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	174 Currently, a Decimal instance is always canonical, so this operation always\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	175 returns True.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	176 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	177
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	178 PyDoc_STRVAR(doc_is_finite,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	179 is_finite() - Return True if the argument is a finite number, and False if the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	180 argument is infinite or a NaN.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	181 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	182
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	183 PyDoc_STRVAR(doc_is_infinite,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	184 is_infinite() - Return True if the argument is either positive or negative\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	185 infinity and False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	186 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	187
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	188 PyDoc_STRVAR(doc_is_nan,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	189 is_nan() - Return True if the argument is a (quiet or signaling) NaN and\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	190 False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	191 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	192
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	193 PyDoc_STRVAR(doc_is_normal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	194 is_normal([context]) - Return True if the argument is a normal finite non-zero\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	195 number with an adjusted exponent greater than or equal to Emin. Return False\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	196 if the argument is zero, subnormal, infinite or a NaN.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	197 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	198
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	199 PyDoc_STRVAR(doc_is_qnan,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	200 is_qnan() - Return True if the argument is a quiet NaN, and False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	201 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	202
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	203 PyDoc_STRVAR(doc_is_signed,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	204 is_signed() - Return True if the argument has a negative sign and\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	205 False otherwise. Note that both zeros and NaNs can carry signs.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	206 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	207
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	208 PyDoc_STRVAR(doc_is_snan,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	209 is_snan() - Return True if the argument is a signaling NaN and False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	210 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	211
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	212 PyDoc_STRVAR(doc_is_subnormal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	213 is_subnormal([context]) - Return True if the argument is subnormal, and False\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	214 otherwise. A number is subnormal if it is non-zero, finite, and has an\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	215 adjusted exponent less than Emin.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	216 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	217
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	218 PyDoc_STRVAR(doc_is_zero,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	219 is_zero() - Return True if the argument is a (positive or negative) zero and\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	220 False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	221 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	222
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	223 PyDoc_STRVAR(doc_ln,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	224 ln([context]) - Return the natural (base e) logarithm of the operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	225 The function always uses the ROUND_HALF_EVEN mode and the result is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	226 correctly rounded.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	227 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	228
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	229 PyDoc_STRVAR(doc_log10,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	230 log10([context]) - Return the base ten logarithm of the operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	231 The function always uses the ROUND_HALF_EVEN mode and the result is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	232 correctly rounded.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	233 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	234
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	235 PyDoc_STRVAR(doc_logb,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	236 logb([context]) - For a non-zero number, return the adjusted exponent\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	237 of the operand as a Decimal instance. If the operand is a zero, then\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	238 Decimal('-Infinity') is returned and the DivisionByZero condition is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	239 raised. If the operand is an infinity then Decimal('Infinity') is returned.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	240 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	241
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	242 PyDoc_STRVAR(doc_logical_and,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	243 logical_and(other[, context]) - Return the digit-wise and of the two\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	244 (logical) operands.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	245 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	246
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	247 PyDoc_STRVAR(doc_logical_invert,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	248 logical_invert([context]) - Return the digit-wise inversion of the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	249 (logical) operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	250 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	251
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	252 PyDoc_STRVAR(doc_logical_or,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	253 logical_or(other[, context]) - Return the digit-wise or of the two\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	254 (logical) operands.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	255 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	256
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	257 PyDoc_STRVAR(doc_logical_xor,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	258 logical_xor(other[, context]) - Return the digit-wise exclusive or of the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	259 two (logical) operands.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	260 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	261
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	262 PyDoc_STRVAR(doc_max,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	263 max(other[, context]) - Maximum of self and other. If one operand is a quiet\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	264 NaN and the other is numeric, the numeric operand is returned.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	265 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	266
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	267 PyDoc_STRVAR(doc_max_mag,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	268 max_mag(other[, context]) - Similar to the max() method, but the comparison is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	269 done using the absolute values of the operands.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	270 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	271
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	272 PyDoc_STRVAR(doc_min,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	273 min(other[, context]) - Minimum of self and other. If one operand is a quiet\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	274 NaN and the other is numeric, the numeric operand is returned.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	275 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	276
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	277 PyDoc_STRVAR(doc_min_mag,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	278 min_mag(other[, context]) - Similar to the min() method, but the comparison is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	279 done using the absolute values of the operands.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	280 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	281
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	282 PyDoc_STRVAR(doc_next_minus,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	283 next_minus([context]) - Return the largest number representable in the given\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	284 context (or in the current default context if no context is given) that is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	285 smaller than the given operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	286 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	287
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	288 PyDoc_STRVAR(doc_next_plus,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	289 next_plus([context]) - Return the smallest number representable in the given\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	290 context (or in the current default context if no context is given) that is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	291 larger than the given operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	292 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	293
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	294 PyDoc_STRVAR(doc_next_toward,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	295 next_toward(other[, context]) - If the two operands are unequal, return the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	296 number closest to the first operand in the direction of the second operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	297 If both operands are numerically equal, return a copy of the first operand\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	298 with the sign set to be the same as the sign of the second operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	299 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	300
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	301 PyDoc_STRVAR(doc_normalize,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	302 normalize([context]) - Normalize the number by stripping the rightmost trailing\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	303 zeros and converting any result equal to Decimal('0') to Decimal('0e0'). Used\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	304 for producing canonical values for members of an equivalence class. For example,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	305 Decimal('32.100') and Decimal('0.321000e+2') both normalize to the equivalent\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	306 value Decimal('32.1').\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	307 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	308
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	309 PyDoc_STRVAR(doc_number_class,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	310 number_class([context]) - Return a string describing the class of the operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	311 The returned value is one of the following ten strings:\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	312 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	313 * '-Infinity', indicating that the operand is negative infinity.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	314 * '-Normal', indicating that the operand is a negative normal number.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	315 * '-Subnormal', indicating that the operand is negative and subnormal.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	316 * '-Zero', indicating that the operand is a negative zero.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	317 * '+Zero', indicating that the operand is a positive zero.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	318 * '+Subnormal', indicating that the operand is positive and subnormal.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	319 * '+Normal', indicating that the operand is a positive normal number.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	320 * '+Infinity', indicating that the operand is positive infinity.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	321 * 'NaN', indicating that the operand is a quiet NaN (Not a Number).\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	322 * 'sNaN', indicating that the operand is a signaling NaN.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	323 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	324 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	325
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	326 PyDoc_STRVAR(doc_quantize,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	327 quantize(exp[, rounding[, context]]) - Return a value equal to the first\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	328 operand after rounding and having the exponent of the second operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	329 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	330 >>> Decimal('1.41421356').quantize(Decimal('1.000'))\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	331 Decimal('1.414')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	332 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	333 Unlike other operations, if the length of the coefficient after the quantize\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	334 operation would be greater than precision, then an InvalidOperation is signaled.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	335 This guarantees that, unless there is an error condition, the quantized exponent\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	336 is always equal to that of the right-hand operand.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	337 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	338 Also unlike other operations, quantize never signals Underflow, even if the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	339 result is subnormal and inexact.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	340 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	341 If the exponent of the second operand is larger than that of the first, then\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	342 rounding may be necessary. In this case, the rounding mode is determined by the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	343 rounding argument if given, else by the given context argument; if neither\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	344 argument is given, the rounding mode of the current thread's context is used.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	345 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	346
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	347 PyDoc_STRVAR(doc_radix,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	348 radix() - Return Decimal(10), the radix (base) in which the Decimal class does\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	349 all its arithmetic. Included for compatibility with the specification.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	350 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	351
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	352 PyDoc_STRVAR(doc_remainder_near,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	353 remainder_near(other[, context]) - Compute the modulo as either a positive\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	354 or negative value depending on which is closest to zero. For instance,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	355 Decimal(10).remainder_near(6) returns Decimal('-2'), which is closer to zero\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	356 than Decimal('4').\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	357 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	358 If both are equally close, the one chosen will have the same sign as self.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	359 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	360
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	361 PyDoc_STRVAR(doc_rotate,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	362 rotate(other[, context]) - Return the result of rotating the digits of the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	363 first operand by an amount specified by the second operand. The second operand\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	364 must be an integer in the range -precision through precision. The absolute\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	365 value of the second operand gives the number of places to rotate. If the second\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	366 operand is positive then rotation is to the left; otherwise rotation is to the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	367 right. The coefficient of the first operand is padded on the left with zeros to\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	368 length precision if necessary. The sign and exponent of the first operand are\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	369 unchanged.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	370 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	371
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	372 PyDoc_STRVAR(doc_same_quantum,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	373 same_quantum(other[, context]) - Test whether self and other have the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	374 same exponent or whether both are NaN.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	375 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	376
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	377 PyDoc_STRVAR(doc_scaleb,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	378 scaleb(other[, context]) - Return the first operand with the exponent adjusted\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	379 the second. Equivalently, return the first operand multiplied by 10**other.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	380 The second operand must be an integer.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	381 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	382
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	383 PyDoc_STRVAR(doc_shift,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	384 shift(other[, context]) - Return the result of shifting the digits of\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	385 the first operand by an amount specified by the second operand. The second\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	386 operand must be an integer in the range -precision through precision. The\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	387 absolute value of the second operand gives the number of places to shift.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	388 If the second operand is positive, then the shift is to the left; otherwise\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	389 the shift is to the right. Digits shifted into the coefficient are zeros.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	390 The sign and exponent of the first operand are unchanged.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	391 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	392
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	393 PyDoc_STRVAR(doc_sqrt,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	394 sqrt([context]) - Return the square root of the argument to full precision.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	395 The result is correctly rounded using the ROUND_HALF_EVEN rounding mode.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	396 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	397
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	398 PyDoc_STRVAR(doc_to_eng_string,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	399 to_eng_string([context]) - Convert to an engineering-type string.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	400 Engineering notation has an exponent which is a multiple of 3, so\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	401 there are up to 3 digits left of the decimal place. For example,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	402 Decimal('123E+1') is converted to Decimal('1.23E+3')\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	403 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	404
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	405 PyDoc_STRVAR(doc_to_integral,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	406 to_integral([rounding[, context]]) - Identical to the to_integral_value()\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	407 method. The to_integral name has been kept for compatibility with older\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	408 versions.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	409 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	410
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	411 PyDoc_STRVAR(doc_to_integral_exact,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	412 to_integral_exact([rounding[, context]]) - Round to the nearest integer,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	413 signaling Inexact or Rounded as appropriate if rounding occurs. The rounding\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	414 mode is determined by the rounding parameter if given, else by the given\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	415 context. If neither parameter is given, then the rounding mode of the current\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	416 default context is used.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	417 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	418
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	419 PyDoc_STRVAR(doc_to_integral_value,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	420 to_integral_value([rounding[, context]]) - Round to the nearest integer without\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	421 signaling Inexact or Rounded. The rounding mode is determined by the rounding\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	422 parameter if given, else by the given context. If neither parameter is given,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	423 then the rounding mode of the current default context is used.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	424 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	425
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	426
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	427 /******************************************************************************/
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	428 /* Context Object and Methods */
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	429 /******************************************************************************/
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	430
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	431 PyDoc_STRVAR(doc_context,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	432 The context affects almost all operations and controls rounding,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	433 Over/Underflow, raising of exceptions and much more. A new context\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	434 can be constructed as follows:\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	435 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	436 >>> c = Context(prec=28, Emin=-425000000, Emax=425000000,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	437 ... rounding=ROUND_HALF_EVEN, capitals=1, clamp=1,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	438 ... traps=[InvalidOperation, DivisionByZero, Overflow],\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	439 ... flags=[])\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	440 >>>\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	441 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	442 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	443
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	444 #ifdef EXTRA_FUNCTIONALITY
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	445 PyDoc_STRVAR(doc_ctx_apply,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	446 apply(x) - Apply self to Decimal x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	447 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	448 #endif
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	449
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	450 PyDoc_STRVAR(doc_ctx_clear_flags,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	451 clear_flags() - Reset all flags to False.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	452 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	453
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	454 PyDoc_STRVAR(doc_ctx_clear_traps,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	455 clear_traps() - Set all traps to False.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	456 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	457
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	458 PyDoc_STRVAR(doc_ctx_copy,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	459 copy() - Return a duplicate of the context with all flags cleared.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	460 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	461
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	462 PyDoc_STRVAR(doc_ctx_copy_decimal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	463 copy_decimal(x) - Return a copy of Decimal x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	464 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	465
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	466 PyDoc_STRVAR(doc_ctx_create_decimal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	467 create_decimal(x) - Create a new Decimal instance from x, using self as the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	468 context. Unlike the Decimal constructor, this function observes the context\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	469 limits.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	470 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	471
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	472 PyDoc_STRVAR(doc_ctx_create_decimal_from_float,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	473 create_decimal_from_float(f) - Create a new Decimal instance from float f.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	474 Unlike the Decimal.from_float() class method, this function observes the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	475 context limits.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	476 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	477
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	478 PyDoc_STRVAR(doc_ctx_Etiny,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	479 Etiny() - Return a value equal to Emin - prec + 1, which is the minimum\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	480 exponent value for subnormal results. When underflow occurs, the exponent\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	481 is set to Etiny.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	482 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	483
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	484 PyDoc_STRVAR(doc_ctx_Etop,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	485 Etop() - Return a value equal to Emax - prec + 1. This is the maximum exponent\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	486 if the _clamp field of the context is set to 1 (IEEE clamp mode). Etop() must\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	487 not be negative.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	488 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	489
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	490 PyDoc_STRVAR(doc_ctx_abs,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	491 abs(x) - Return the absolute value of x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	492 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	493
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	494 PyDoc_STRVAR(doc_ctx_add,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	495 add(x, y) - Return the sum of x and y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	496 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	497
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	498 PyDoc_STRVAR(doc_ctx_canonical,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	499 canonical(x) - Return a new instance of x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	500 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	501
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	502 PyDoc_STRVAR(doc_ctx_compare,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	503 compare(x, y) - Compare x and y numerically.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	504 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	505
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	506 PyDoc_STRVAR(doc_ctx_compare_signal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	507 compare_signal(x, y) - Compare x and y numerically. All NaNs signal.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	508 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	509
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	510 PyDoc_STRVAR(doc_ctx_compare_total,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	511 compare_total(x, y) - Compare x and y using their abstract representation.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	512 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	513
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	514 PyDoc_STRVAR(doc_ctx_compare_total_mag,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	515 compare_total_mag(x, y) - Compare x and y using their abstract representation,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	516 ignoring sign.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	517 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	518
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	519 PyDoc_STRVAR(doc_ctx_copy_abs,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	520 copy_abs(x) - Return a copy of x with the sign set to 0.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	521 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	522
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	523 PyDoc_STRVAR(doc_ctx_copy_negate,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	524 copy_negate(x) - Return a copy of x with the sign inverted.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	525 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	526
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	527 PyDoc_STRVAR(doc_ctx_copy_sign,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	528 copy_sign(x, y) - Copy the sign from y to x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	529 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	530
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	531 PyDoc_STRVAR(doc_ctx_divide,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	532 divide(x, y) - Return x divided by y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	533 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	534
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	535 PyDoc_STRVAR(doc_ctx_divide_int,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	536 divide_int(x, y) - Return x divided by y, truncated to an integer.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	537 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	538
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	539 PyDoc_STRVAR(doc_ctx_divmod,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	540 divmod(x, y) - Return quotient and remainder of the division x / y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	541 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	542
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	543 PyDoc_STRVAR(doc_ctx_exp,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	544 exp(x) - Return e ** x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	545 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	546
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	547 PyDoc_STRVAR(doc_ctx_fma,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	548 fma(x, y, z) - Return x multiplied by y, plus z.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	549 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	550
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	551 PyDoc_STRVAR(doc_ctx_is_canonical,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	552 is_canonical(x) - Return True if x is canonical, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	553 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	554
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	555 PyDoc_STRVAR(doc_ctx_is_finite,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	556 is_finite(x) - Return True if x is finite, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	557 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	558
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	559 PyDoc_STRVAR(doc_ctx_is_infinite,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	560 is_infinite(x) - Return True if x is infinite, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	561 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	562
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	563 PyDoc_STRVAR(doc_ctx_is_nan,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	564 is_nan(x) - Return True if x is a qNaN or sNaN, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	565 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	566
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	567 PyDoc_STRVAR(doc_ctx_is_normal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	568 is_normal(x) - Return True if x is a normal number, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	569 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	570
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	571 PyDoc_STRVAR(doc_ctx_is_qnan,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	572 is_qnan(x) - Return True if x is a quiet NaN, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	573 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	574
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	575 PyDoc_STRVAR(doc_ctx_is_signed,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	576 is_signed(x) - Return True if x is negative, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	577 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	578
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	579 PyDoc_STRVAR(doc_ctx_is_snan,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	580 is_snan() - Return True if x is a signaling NaN, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	581 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	582
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	583 PyDoc_STRVAR(doc_ctx_is_subnormal,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	584 is_subnormal(x) - Return True if x is subnormal, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	585 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	586
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	587 PyDoc_STRVAR(doc_ctx_is_zero,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	588 is_zero(x) - Return True if x is a zero, False otherwise.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	589 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	590
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	591 PyDoc_STRVAR(doc_ctx_ln,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	592 ln(x) - Return the natural (base e) logarithm of x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	593 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	594
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	595 PyDoc_STRVAR(doc_ctx_log10,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	596 log10(x) - Return the base 10 logarithm of x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	597 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	598
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	599 PyDoc_STRVAR(doc_ctx_logb,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	600 logb(x) - Return the exponent of the magnitude of the operand's MSD.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	601 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	602
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	603 PyDoc_STRVAR(doc_ctx_logical_and,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	604 logical_and(x, y) - Digit-wise and of x and y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	605 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	606
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	607 PyDoc_STRVAR(doc_ctx_logical_invert,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	608 logical_invert(x) - Invert all digits of x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	609 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	610
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	611 PyDoc_STRVAR(doc_ctx_logical_or,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	612 logical_or(x, y) - Digit-wise or of x and y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	613 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	614
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	615 PyDoc_STRVAR(doc_ctx_logical_xor,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	616 logical_xor(x, y) - Digit-wise xor of x and y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	617 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	618
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	619 PyDoc_STRVAR(doc_ctx_max,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	620 max(x, y) - Compare the values numerically and return the maximum.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	621 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	622
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	623 PyDoc_STRVAR(doc_ctx_max_mag,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	624 max_mag(x, y) - Compare the values numerically with their sign ignored.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	625 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	626
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	627 PyDoc_STRVAR(doc_ctx_min,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	628 min(x, y) - Compare the values numerically and return the minimum.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	629 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	630
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	631 PyDoc_STRVAR(doc_ctx_min_mag,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	632 min_mag(x, y) - Compare the values numerically with their sign ignored.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	633 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	634
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	635 PyDoc_STRVAR(doc_ctx_minus,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	636 minus(x) - Minus corresponds to the unary prefix minus operator in Python,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	637 but applies the context to the result.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	638 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	639
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	640 PyDoc_STRVAR(doc_ctx_multiply,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	641 multiply(x, y) - Return the product of x and y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	642 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	643
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	644 PyDoc_STRVAR(doc_ctx_next_minus,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	645 next_minus(x) - Return the largest representable number smaller than x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	646 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	647
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	648 PyDoc_STRVAR(doc_ctx_next_plus,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	649 next_plus(x) - Return the smallest representable number larger than x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	650 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	651
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	652 PyDoc_STRVAR(doc_ctx_next_toward,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	653 next_toward(x) - Return the number closest to x, in the direction towards y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	654 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	655
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	656 PyDoc_STRVAR(doc_ctx_normalize,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	657 normalize(x) - Reduce x to its simplest form. Alias for reduce(x).\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	658 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	659
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	660 PyDoc_STRVAR(doc_ctx_number_class,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	661 number_class(x) - Return an indication of the class of x.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	662 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	663
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	664 PyDoc_STRVAR(doc_ctx_plus,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	665 plus(x) - Plus corresponds to the unary prefix plus operator in Python,\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	666 but applies the context to the result.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	667 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	668
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	669 PyDoc_STRVAR(doc_ctx_power,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	670 power(x, y) - Compute x**y. If x is negative, then y must be integral.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	671 The result will be inexact unless y is integral and the result is finite\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	672 and can be expressed exactly in 'precision' digits. In the Python version\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	673 the result is always correctly rounded, in the C version the result is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	674 almost always correctly rounded.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	675 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	676 power(x, y, m) - Compute (x**y) % m. The following restrictions hold:\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	677 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	678 * all three arguments must be integral\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	679 * y must be nonnegative\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	680 * at least one of x or y must be nonzero\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	681 * m must be nonzero and less than 10**prec in absolute value\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	682 \n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	683 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	684
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	685 PyDoc_STRVAR(doc_ctx_quantize,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	686 quantize(x, y) - Return a value equal to x (rounded), having the exponent of y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	687 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	688
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	689 PyDoc_STRVAR(doc_ctx_radix,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	690 radix() - Return 10.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	691 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	692
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	693 PyDoc_STRVAR(doc_ctx_remainder,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	694 remainder(x, y) - Return the remainder from integer division. The sign of\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	695 the result, if non-zero, is the same as that of the original dividend.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	696 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	697
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	698 PyDoc_STRVAR(doc_ctx_remainder_near,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	699 remainder_near(x, y) - Return x - y * n, where n is the integer nearest the\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	700 exact value of x / y (if the result is 0 then its sign will be the sign of x).\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	701 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	702
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	703 PyDoc_STRVAR(doc_ctx_rotate,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	704 rotate(x, y) - Return a copy of x, rotated by y places.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	705 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	706
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	707 PyDoc_STRVAR(doc_ctx_same_quantum,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	708 same_quantum(x, y) - Return True if the two operands have the same exponent.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	709 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	710
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	711 PyDoc_STRVAR(doc_ctx_scaleb,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	712 scaleb(x, y) - Return the first operand after adding the second value\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	713 to its exp.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	714 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	715
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	716 PyDoc_STRVAR(doc_ctx_shift,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	717 shift(x, y) - Return a copy of x, shifted by y places.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	718 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	719
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	720 PyDoc_STRVAR(doc_ctx_sqrt,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	721 sqrt(x) - Square root of a non-negative number to context precision.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	722 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	723
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	724 PyDoc_STRVAR(doc_ctx_subtract,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	725 subtract(x, y) - Return the difference between x and y.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	726 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	727
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	728 PyDoc_STRVAR(doc_ctx_to_eng_string,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	729 to_eng_string(x) - Convert a number to a string, using engineering notation.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	730 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	731
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	732 PyDoc_STRVAR(doc_ctx_to_integral,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	733 to_integral(x) - Identical to to_integral_value(x).\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	734 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	735
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	736 PyDoc_STRVAR(doc_ctx_to_integral_exact,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	737 to_integral_exact(x) - Round to an integer. Signal if the result is\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	738 rounded or inexact.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	739 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	740
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	741 PyDoc_STRVAR(doc_ctx_to_integral_value,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	742 to_integral_value(x) - Round to an integer.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	743 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	744
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	745 PyDoc_STRVAR(doc_ctx_to_sci_string,"\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	746 to_sci_string(x) - Convert a number to a string using scientific notation.\n\
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	747 \n");
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	748
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	749
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	750 #endif /* DOCSTRINGS_H */
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	751
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	752
7355550d5357 Issue #7652: Integrate the decimal floating point libmpdec library to speed Stefan Krah <skrah@bytereef.org> parents: diff changeset	753

Mercurial > cpython-lru_cache-weakref

annotate Modules/_decimal/docstrings.h @ 79691:05c8928362ee