doc_content
stringlengths
1
386k
doc_id
stringlengths
5
188
class decimal.Context(prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None) Creates a new context. If a field is not specified or is None, the default values are copied from the DefaultContext. If the flags field is not specified or is None, all flags are cleared. prec is ...
python.library.decimal#decimal.Context
abs(x) Returns the absolute value of x.
python.library.decimal#decimal.Context.abs
add(x, y) Return the sum of x and y.
python.library.decimal#decimal.Context.add
canonical(x) Returns the same Decimal object x.
python.library.decimal#decimal.Context.canonical
clear_flags() Resets all of the flags to 0.
python.library.decimal#decimal.Context.clear_flags
clear_traps() Resets all of the traps to 0. New in version 3.3.
python.library.decimal#decimal.Context.clear_traps
compare(x, y) Compares x and y numerically.
python.library.decimal#decimal.Context.compare
compare_signal(x, y) Compares the values of the two operands numerically.
python.library.decimal#decimal.Context.compare_signal
compare_total(x, y) Compares two operands using their abstract representation.
python.library.decimal#decimal.Context.compare_total
compare_total_mag(x, y) Compares two operands using their abstract representation, ignoring sign.
python.library.decimal#decimal.Context.compare_total_mag
copy() Return a duplicate of the context.
python.library.decimal#decimal.Context.copy
copy_abs(x) Returns a copy of x with the sign set to 0.
python.library.decimal#decimal.Context.copy_abs
copy_decimal(num) Return a copy of the Decimal instance num.
python.library.decimal#decimal.Context.copy_decimal
copy_negate(x) Returns a copy of x with the sign inverted.
python.library.decimal#decimal.Context.copy_negate
copy_sign(x, y) Copies the sign from y to x.
python.library.decimal#decimal.Context.copy_sign
create_decimal(num) Creates a new Decimal instance from num but using self as context. Unlike the Decimal constructor, the context precision, rounding method, flags, and traps are applied to the conversion. This is useful because constants are often given to a greater precision than is needed by the application. Anot...
python.library.decimal#decimal.Context.create_decimal
create_decimal_from_float(f) Creates a new Decimal instance from a float f but rounding using self as the context. Unlike the Decimal.from_float() class method, the context precision, rounding method, flags, and traps are applied to the conversion. >>> context = Context(prec=5, rounding=ROUND_DOWN) >>> context.create...
python.library.decimal#decimal.Context.create_decimal_from_float
divide(x, y) Return x divided by y.
python.library.decimal#decimal.Context.divide
divide_int(x, y) Return x divided by y, truncated to an integer.
python.library.decimal#decimal.Context.divide_int
divmod(x, y) Divides two numbers and returns the integer part of the result.
python.library.decimal#decimal.Context.divmod
Etiny() Returns a value equal to Emin - prec + 1 which is the minimum exponent value for subnormal results. When underflow occurs, the exponent is set to Etiny.
python.library.decimal#decimal.Context.Etiny
Etop() Returns a value equal to Emax - prec + 1.
python.library.decimal#decimal.Context.Etop
exp(x) Returns e ** x.
python.library.decimal#decimal.Context.exp
fma(x, y, z) Returns x multiplied by y, plus z.
python.library.decimal#decimal.Context.fma
is_canonical(x) Returns True if x is canonical; otherwise returns False.
python.library.decimal#decimal.Context.is_canonical
is_finite(x) Returns True if x is finite; otherwise returns False.
python.library.decimal#decimal.Context.is_finite
is_infinite(x) Returns True if x is infinite; otherwise returns False.
python.library.decimal#decimal.Context.is_infinite
is_nan(x) Returns True if x is a qNaN or sNaN; otherwise returns False.
python.library.decimal#decimal.Context.is_nan
is_normal(x) Returns True if x is a normal number; otherwise returns False.
python.library.decimal#decimal.Context.is_normal
is_qnan(x) Returns True if x is a quiet NaN; otherwise returns False.
python.library.decimal#decimal.Context.is_qnan
is_signed(x) Returns True if x is negative; otherwise returns False.
python.library.decimal#decimal.Context.is_signed
is_snan(x) Returns True if x is a signaling NaN; otherwise returns False.
python.library.decimal#decimal.Context.is_snan
is_subnormal(x) Returns True if x is subnormal; otherwise returns False.
python.library.decimal#decimal.Context.is_subnormal
is_zero(x) Returns True if x is a zero; otherwise returns False.
python.library.decimal#decimal.Context.is_zero
ln(x) Returns the natural (base e) logarithm of x.
python.library.decimal#decimal.Context.ln
log10(x) Returns the base 10 logarithm of x.
python.library.decimal#decimal.Context.log10
logb(x) Returns the exponent of the magnitude of the operand’s MSD.
python.library.decimal#decimal.Context.logb
logical_and(x, y) Applies the logical operation and between each operand’s digits.
python.library.decimal#decimal.Context.logical_and
logical_invert(x) Invert all the digits in x.
python.library.decimal#decimal.Context.logical_invert
logical_or(x, y) Applies the logical operation or between each operand’s digits.
python.library.decimal#decimal.Context.logical_or
logical_xor(x, y) Applies the logical operation xor between each operand’s digits.
python.library.decimal#decimal.Context.logical_xor
max(x, y) Compares two values numerically and returns the maximum.
python.library.decimal#decimal.Context.max
max_mag(x, y) Compares the values numerically with their sign ignored.
python.library.decimal#decimal.Context.max_mag
min(x, y) Compares two values numerically and returns the minimum.
python.library.decimal#decimal.Context.min
minus(x) Minus corresponds to the unary prefix minus operator in Python.
python.library.decimal#decimal.Context.minus
min_mag(x, y) Compares the values numerically with their sign ignored.
python.library.decimal#decimal.Context.min_mag
multiply(x, y) Return the product of x and y.
python.library.decimal#decimal.Context.multiply
next_minus(x) Returns the largest representable number smaller than x.
python.library.decimal#decimal.Context.next_minus
next_plus(x) Returns the smallest representable number larger than x.
python.library.decimal#decimal.Context.next_plus
next_toward(x, y) Returns the number closest to x, in direction towards y.
python.library.decimal#decimal.Context.next_toward
normalize(x) Reduces x to its simplest form.
python.library.decimal#decimal.Context.normalize
number_class(x) Returns an indication of the class of x.
python.library.decimal#decimal.Context.number_class
plus(x) Plus corresponds to the unary prefix plus operator in Python. This operation applies the context precision and rounding, so it is not an identity operation.
python.library.decimal#decimal.Context.plus
power(x, y, modulo=None) Return x to the power of y, reduced modulo modulo if given. With two arguments, compute x**y. If x is negative then y must be integral. The result will be inexact unless y is integral and the result is finite and can be expressed exactly in ‘precision’ digits. The rounding mode of the context...
python.library.decimal#decimal.Context.power
quantize(x, y) Returns a value equal to x (rounded), having the exponent of y.
python.library.decimal#decimal.Context.quantize
radix() Just returns 10, as this is Decimal, :)
python.library.decimal#decimal.Context.radix
remainder(x, y) Returns the remainder from integer division. The sign of the result, if non-zero, is the same as that of the original dividend.
python.library.decimal#decimal.Context.remainder
remainder_near(x, y) Returns x - y * n, where n is the integer nearest the exact value of x / y (if the result is 0 then its sign will be the sign of x).
python.library.decimal#decimal.Context.remainder_near
rotate(x, y) Returns a rotated copy of x, y times.
python.library.decimal#decimal.Context.rotate
same_quantum(x, y) Returns True if the two operands have the same exponent.
python.library.decimal#decimal.Context.same_quantum
scaleb(x, y) Returns the first operand after adding the second value its exp.
python.library.decimal#decimal.Context.scaleb
shift(x, y) Returns a shifted copy of x, y times.
python.library.decimal#decimal.Context.shift
sqrt(x) Square root of a non-negative number to context precision.
python.library.decimal#decimal.Context.sqrt
subtract(x, y) Return the difference between x and y.
python.library.decimal#decimal.Context.subtract
to_eng_string(x) Convert to a string, using engineering notation if an exponent is needed. Engineering notation has an exponent which is a multiple of 3. This can leave up to 3 digits to the left of the decimal place and may require the addition of either one or two trailing zeros.
python.library.decimal#decimal.Context.to_eng_string
to_integral_exact(x) Rounds to an integer.
python.library.decimal#decimal.Context.to_integral_exact
to_sci_string(x) Converts a number to a string using scientific notation.
python.library.decimal#decimal.Context.to_sci_string
class decimal.Decimal(value="0", context=None) Construct a new Decimal object based from value. value can be an integer, string, tuple, float, or another Decimal object. If no value is given, returns Decimal('0'). If value is a string, it should conform to the decimal numeric string syntax after leading and trailing ...
python.library.decimal#decimal.Decimal
adjusted() Return the adjusted exponent after shifting out the coefficient’s rightmost digits until only the lead digit remains: Decimal('321e+5').adjusted() returns seven. Used for determining the position of the most significant digit with respect to the decimal point.
python.library.decimal#decimal.Decimal.adjusted
as_integer_ratio() Return a pair (n, d) of integers that represent the given Decimal instance as a fraction, in lowest terms and with a positive denominator: >>> Decimal('-3.14').as_integer_ratio() (-157, 50) The conversion is exact. Raise OverflowError on infinities and ValueError on NaNs.
python.library.decimal#decimal.Decimal.as_integer_ratio
as_tuple() Return a named tuple representation of the number: DecimalTuple(sign, digits, exponent).
python.library.decimal#decimal.Decimal.as_tuple
canonical() Return the canonical encoding of the argument. Currently, the encoding of a Decimal instance is always canonical, so this operation returns its argument unchanged.
python.library.decimal#decimal.Decimal.canonical
compare(other, context=None) Compare the values of two Decimal instances. compare() returns a Decimal instance, and if either operand is a NaN then the result is a NaN: a or b is a NaN ==> Decimal('NaN') a < b ==> Decimal('-1') a == b ==> Decimal('0') a > b ==> Decimal('1')
python.library.decimal#decimal.Decimal.compare
compare_signal(other, context=None) This operation is identical to the compare() method, except that all NaNs signal. That is, if neither operand is a signaling NaN then any quiet NaN operand is treated as though it were a signaling NaN.
python.library.decimal#decimal.Decimal.compare_signal
compare_total(other, context=None) Compare two operands using their abstract representation rather than their numerical value. Similar to the compare() method, but the result gives a total ordering on Decimal instances. Two Decimal instances with the same numeric value but different representations compare unequal in...
python.library.decimal#decimal.Decimal.compare_total
compare_total_mag(other, context=None) Compare two operands using their abstract representation rather than their value as in compare_total(), but ignoring the sign of each operand. x.compare_total_mag(y) is equivalent to x.copy_abs().compare_total(y.copy_abs()). This operation is unaffected by context and is quiet: ...
python.library.decimal#decimal.Decimal.compare_total_mag
conjugate() Just returns self, this method is only to comply with the Decimal Specification.
python.library.decimal#decimal.Decimal.conjugate
copy_abs() Return the absolute value of the argument. This operation is unaffected by the context and is quiet: no flags are changed and no rounding is performed.
python.library.decimal#decimal.Decimal.copy_abs
copy_negate() Return the negation of the argument. This operation is unaffected by the context and is quiet: no flags are changed and no rounding is performed.
python.library.decimal#decimal.Decimal.copy_negate
copy_sign(other, context=None) Return a copy of the first operand with the sign set to be the same as the sign of the second operand. For example: >>> Decimal('2.3').copy_sign(Decimal('-1.5')) Decimal('-2.3') This operation is unaffected by context and is quiet: no flags are changed and no rounding is performed. As ...
python.library.decimal#decimal.Decimal.copy_sign
exp(context=None) Return the value of the (natural) exponential function e**x at the given number. The result is correctly rounded using the ROUND_HALF_EVEN rounding mode. >>> Decimal(1).exp() Decimal('2.718281828459045235360287471') >>> Decimal(321).exp() Decimal('2.561702493119680037517373933E+139')
python.library.decimal#decimal.Decimal.exp
fma(other, third, context=None) Fused multiply-add. Return self*other+third with no rounding of the intermediate product self*other. >>> Decimal(2).fma(3, 5) Decimal('11')
python.library.decimal#decimal.Decimal.fma
from_float(f) Classmethod that converts a float to a decimal number, exactly. Note Decimal.from_float(0.1) is not the same as Decimal(‘0.1’). Since 0.1 is not exactly representable in binary floating point, the value is stored as the nearest representable value which is 0x1.999999999999ap-4. That equivalent value in ...
python.library.decimal#decimal.Decimal.from_float
is_canonical() Return True if the argument is canonical and False otherwise. Currently, a Decimal instance is always canonical, so this operation always returns True.
python.library.decimal#decimal.Decimal.is_canonical
is_finite() Return True if the argument is a finite number, and False if the argument is an infinity or a NaN.
python.library.decimal#decimal.Decimal.is_finite
is_infinite() Return True if the argument is either positive or negative infinity and False otherwise.
python.library.decimal#decimal.Decimal.is_infinite
is_nan() Return True if the argument is a (quiet or signaling) NaN and False otherwise.
python.library.decimal#decimal.Decimal.is_nan
is_normal(context=None) Return True if the argument is a normal finite number. Return False if the argument is zero, subnormal, infinite or a NaN.
python.library.decimal#decimal.Decimal.is_normal
is_qnan() Return True if the argument is a quiet NaN, and False otherwise.
python.library.decimal#decimal.Decimal.is_qnan
is_signed() Return True if the argument has a negative sign and False otherwise. Note that zeros and NaNs can both carry signs.
python.library.decimal#decimal.Decimal.is_signed
is_snan() Return True if the argument is a signaling NaN and False otherwise.
python.library.decimal#decimal.Decimal.is_snan
is_subnormal(context=None) Return True if the argument is subnormal, and False otherwise.
python.library.decimal#decimal.Decimal.is_subnormal
is_zero() Return True if the argument is a (positive or negative) zero and False otherwise.
python.library.decimal#decimal.Decimal.is_zero
ln(context=None) Return the natural (base e) logarithm of the operand. The result is correctly rounded using the ROUND_HALF_EVEN rounding mode.
python.library.decimal#decimal.Decimal.ln
log10(context=None) Return the base ten logarithm of the operand. The result is correctly rounded using the ROUND_HALF_EVEN rounding mode.
python.library.decimal#decimal.Decimal.log10
logb(context=None) For a nonzero number, return the adjusted exponent of its operand as a Decimal instance. If the operand is a zero then Decimal('-Infinity') is returned and the DivisionByZero flag is raised. If the operand is an infinity then Decimal('Infinity') is returned.
python.library.decimal#decimal.Decimal.logb
logical_and(other, context=None) logical_and() is a logical operation which takes two logical operands (see Logical operands). The result is the digit-wise and of the two operands.
python.library.decimal#decimal.Decimal.logical_and
logical_invert(context=None) logical_invert() is a logical operation. The result is the digit-wise inversion of the operand.
python.library.decimal#decimal.Decimal.logical_invert
logical_or(other, context=None) logical_or() is a logical operation which takes two logical operands (see Logical operands). The result is the digit-wise or of the two operands.
python.library.decimal#decimal.Decimal.logical_or
logical_xor(other, context=None) logical_xor() is a logical operation which takes two logical operands (see Logical operands). The result is the digit-wise exclusive or of the two operands.
python.library.decimal#decimal.Decimal.logical_xor