Doc/c-api/number.rst

   1 .. highlightlang:: c
   2
   3 .. _number:
   4
   5 Number Protocol
   6 ===============
   7
   8
   9 .. cfunction:: int PyNumber_Check(PyObject *o)
  10
  11    Returns ``1`` if the object *o* provides numeric protocols, and false otherwise.
  12    This function always succeeds.
  13
  14
  15 .. cfunction:: PyObject* PyNumber_Add(PyObject *o1, PyObject *o2)
  16
  17    Returns the result of adding *o1* and *o2*, or *NULL* on failure.  This is the
  18    equivalent of the Python expression ``o1 + o2``.
  19
  20
  21 .. cfunction:: PyObject* PyNumber_Subtract(PyObject *o1, PyObject *o2)
  22
  23    Returns the result of subtracting *o2* from *o1*, or *NULL* on failure.  This is
  24    the equivalent of the Python expression ``o1 - o2``.
  25
  26
  27 .. cfunction:: PyObject* PyNumber_Multiply(PyObject *o1, PyObject *o2)
  28
  29    Returns the result of multiplying *o1* and *o2*, or *NULL* on failure.  This is
  30    the equivalent of the Python expression ``o1 * o2``.
  31
  32
  33 .. cfunction:: PyObject* PyNumber_Divide(PyObject *o1, PyObject *o2)
  34
  35    Returns the result of dividing *o1* by *o2*, or *NULL* on failure.  This is the
  36    equivalent of the Python expression ``o1 / o2``.
  37
  38
  39 .. cfunction:: PyObject* PyNumber_FloorDivide(PyObject *o1, PyObject *o2)
  40
  41    Return the floor of *o1* divided by *o2*, or *NULL* on failure.  This is
  42    equivalent to the "classic" division of integers.
  43
  44
  45 .. cfunction:: PyObject* PyNumber_TrueDivide(PyObject *o1, PyObject *o2)
  46
  47    Return a reasonable approximation for the mathematical value of *o1* divided by
  48    *o2*, or *NULL* on failure.  The return value is "approximate" because binary
  49    floating point numbers are approximate; it is not possible to represent all real
  50    numbers in base two.  This function can return a floating point value when
  51    passed two integers.
  52
  53
  54 .. cfunction:: PyObject* PyNumber_Remainder(PyObject *o1, PyObject *o2)
  55
  56    Returns the remainder of dividing *o1* by *o2*, or *NULL* on failure.  This is
  57    the equivalent of the Python expression ``o1 % o2``.
  58
  59
  60 .. cfunction:: PyObject* PyNumber_Divmod(PyObject *o1, PyObject *o2)
  61
  62    .. index:: builtin: divmod
  63
  64    See the built-in function :func:`divmod`. Returns *NULL* on failure.  This is
  65    the equivalent of the Python expression ``divmod(o1, o2)``.
  66
  67
  68 .. cfunction:: PyObject* PyNumber_Power(PyObject *o1, PyObject *o2, PyObject *o3)
  69
  70    .. index:: builtin: pow
  71
  72    See the built-in function :func:`pow`. Returns *NULL* on failure.  This is the
  73    equivalent of the Python expression ``pow(o1, o2, o3)``, where *o3* is optional.
  74    If *o3* is to be ignored, pass :cdata:`Py_None` in its place (passing *NULL* for
  75    *o3* would cause an illegal memory access).
  76
  77
  78 .. cfunction:: PyObject* PyNumber_Negative(PyObject *o)
  79
  80    Returns the negation of *o* on success, or *NULL* on failure. This is the
  81    equivalent of the Python expression ``-o``.
  82
  83
  84 .. cfunction:: PyObject* PyNumber_Positive(PyObject *o)
  85
  86    Returns *o* on success, or *NULL* on failure.  This is the equivalent of the
  87    Python expression ``+o``.
  88
  89
  90 .. cfunction:: PyObject* PyNumber_Absolute(PyObject *o)
  91
  92    .. index:: builtin: abs
  93
  94    Returns the absolute value of *o*, or *NULL* on failure.  This is the equivalent
  95    of the Python expression ``abs(o)``.
  96
  97
  98 .. cfunction:: PyObject* PyNumber_Invert(PyObject *o)
  99
 100    Returns the bitwise negation of *o* on success, or *NULL* on failure.  This is
 101    the equivalent of the Python expression ``~o``.
 102
 103
 104 .. cfunction:: PyObject* PyNumber_Lshift(PyObject *o1, PyObject *o2)
 105
 106    Returns the result of left shifting *o1* by *o2* on success, or *NULL* on
 107    failure.  This is the equivalent of the Python expression ``o1 << o2``.
 108
 109
 110 .. cfunction:: PyObject* PyNumber_Rshift(PyObject *o1, PyObject *o2)
 111
 112    Returns the result of right shifting *o1* by *o2* on success, or *NULL* on
 113    failure.  This is the equivalent of the Python expression ``o1 >> o2``.
 114
 115
 116 .. cfunction:: PyObject* PyNumber_And(PyObject *o1, PyObject *o2)
 117
 118    Returns the "bitwise and" of *o1* and *o2* on success and *NULL* on failure.
 119    This is the equivalent of the Python expression ``o1 & o2``.
 120
 121
 122 .. cfunction:: PyObject* PyNumber_Xor(PyObject *o1, PyObject *o2)
 123
 124    Returns the "bitwise exclusive or" of *o1* by *o2* on success, or *NULL* on
 125    failure.  This is the equivalent of the Python expression ``o1 ^ o2``.
 126
 127
 128 .. cfunction:: PyObject* PyNumber_Or(PyObject *o1, PyObject *o2)
 129
 130    Returns the "bitwise or" of *o1* and *o2* on success, or *NULL* on failure.
 131    This is the equivalent of the Python expression ``o1 | o2``.
 132
 133
 134 .. cfunction:: PyObject* PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2)
 135
 136    Returns the result of adding *o1* and *o2*, or *NULL* on failure.  The operation
 137    is done *in-place* when *o1* supports it.  This is the equivalent of the Python
 138    statement ``o1 += o2``.
 139
 140
 141 .. cfunction:: PyObject* PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2)
 142
 143    Returns the result of subtracting *o2* from *o1*, or *NULL* on failure.  The
 144    operation is done *in-place* when *o1* supports it.  This is the equivalent of
 145    the Python statement ``o1 -= o2``.
 146
 147
 148 .. cfunction:: PyObject* PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2)
 149
 150    Returns the result of multiplying *o1* and *o2*, or *NULL* on failure.  The
 151    operation is done *in-place* when *o1* supports it.  This is the equivalent of
 152    the Python statement ``o1 *= o2``.
 153
 154
 155 .. cfunction:: PyObject* PyNumber_InPlaceDivide(PyObject *o1, PyObject *o2)
 156
 157    Returns the result of dividing *o1* by *o2*, or *NULL* on failure.  The
 158    operation is done *in-place* when *o1* supports it. This is the equivalent of
 159    the Python statement ``o1 /= o2``.
 160
 161
 162 .. cfunction:: PyObject* PyNumber_InPlaceFloorDivide(PyObject *o1, PyObject *o2)
 163
 164    Returns the mathematical floor of dividing *o1* by *o2*, or *NULL* on failure.
 165    The operation is done *in-place* when *o1* supports it.  This is the equivalent
 166    of the Python statement ``o1 //= o2``.
 167
 168
 169 .. cfunction:: PyObject* PyNumber_InPlaceTrueDivide(PyObject *o1, PyObject *o2)
 170
 171    Return a reasonable approximation for the mathematical value of *o1* divided by
 172    *o2*, or *NULL* on failure.  The return value is "approximate" because binary
 173    floating point numbers are approximate; it is not possible to represent all real
 174    numbers in base two.  This function can return a floating point value when
 175    passed two integers.  The operation is done *in-place* when *o1* supports it.
 176
 177
 178 .. cfunction:: PyObject* PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2)
 179
 180    Returns the remainder of dividing *o1* by *o2*, or *NULL* on failure.  The
 181    operation is done *in-place* when *o1* supports it.  This is the equivalent of
 182    the Python statement ``o1 %= o2``.
 183
 184
 185 .. cfunction:: PyObject* PyNumber_InPlacePower(PyObject *o1, PyObject *o2, PyObject *o3)
 186
 187    .. index:: builtin: pow
 188
 189    See the built-in function :func:`pow`. Returns *NULL* on failure.  The operation
 190    is done *in-place* when *o1* supports it.  This is the equivalent of the Python
 191    statement ``o1 **= o2`` when o3 is :cdata:`Py_None`, or an in-place variant of
 192    ``pow(o1, o2, o3)`` otherwise. If *o3* is to be ignored, pass :cdata:`Py_None`
 193    in its place (passing *NULL* for *o3* would cause an illegal memory access).
 194
 195
 196 .. cfunction:: PyObject* PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2)
 197
 198    Returns the result of left shifting *o1* by *o2* on success, or *NULL* on
 199    failure.  The operation is done *in-place* when *o1* supports it.  This is the
 200    equivalent of the Python statement ``o1 <<= o2``.
 201
 202
 203 .. cfunction:: PyObject* PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2)
 204
 205    Returns the result of right shifting *o1* by *o2* on success, or *NULL* on
 206    failure.  The operation is done *in-place* when *o1* supports it.  This is the
 207    equivalent of the Python statement ``o1 >>= o2``.
 208
 209
 210 .. cfunction:: PyObject* PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2)
 211
 212    Returns the "bitwise and" of *o1* and *o2* on success and *NULL* on failure. The
 213    operation is done *in-place* when *o1* supports it.  This is the equivalent of
 214    the Python statement ``o1 &= o2``.
 215
 216
 217 .. cfunction:: PyObject* PyNumber_InPlaceXor(PyObject *o1, PyObject *o2)
 218
 219    Returns the "bitwise exclusive or" of *o1* by *o2* on success, or *NULL* on
 220    failure.  The operation is done *in-place* when *o1* supports it.  This is the
 221    equivalent of the Python statement ``o1 ^= o2``.
 222
 223
 224 .. cfunction:: PyObject* PyNumber_InPlaceOr(PyObject *o1, PyObject *o2)
 225
 226    Returns the "bitwise or" of *o1* and *o2* on success, or *NULL* on failure.  The
 227    operation is done *in-place* when *o1* supports it.  This is the equivalent of
 228    the Python statement ``o1 |= o2``.
 229
 230
 231 .. cfunction:: PyObject* PyNumber_Int(PyObject *o)
 232
 233    .. index:: builtin: int
 234
 235    Returns the *o* converted to an integer object on success, or *NULL* on failure.
 236    If the argument is outside the integer range a long object will be returned
 237    instead. This is the equivalent of the Python expression ``int(o)``.
 238
 239
 240 .. cfunction:: PyObject* PyNumber_Long(PyObject *o)
 241
 242    .. index:: builtin: long
 243
 244    Returns the *o* converted to an integer object on success, or *NULL* on
 245    failure.  This is the equivalent of the Python expression ``long(o)``.
 246
 247
 248 .. cfunction:: PyObject* PyNumber_Float(PyObject *o)
 249
 250    .. index:: builtin: float
 251
 252    Returns the *o* converted to a float object on success, or *NULL* on failure.
 253    This is the equivalent of the Python expression ``float(o)``.
 254
 255
 256 .. cfunction:: PyObject* PyNumber_Index(PyObject *o)
 257
 258    Returns the *o* converted to a Python int or long on success or *NULL* with a
 259    TypeError exception raised on failure.
 260
 261
 262 .. cfunction:: PyObject* PyNumber_ToBase(PyObject *n, int base)
 263
 264    Returns the the integer *n* converted to *base* as a string with a base
 265    marker of ``'0b'``, ``'0o'``, or ``'0x'`` if appended applicable.  When
 266    *base* is not 2, 8, 10, or 16, the format is ``'x#num'`` where x is the
 267    base. If *n* is not an int object, it is converted with
 268    :cfunc:`PyNumber_Index` first.
 269
 270    .. versionadded:: 2.6
 271
 272
 273 .. cfunction:: Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc)
 274
 275    Returns *o* converted to a Py_ssize_t value if *o* can be interpreted as an
 276    integer. If *o* can be converted to a Python int or long but the attempt to
 277    convert to a Py_ssize_t value would raise an :exc:`OverflowError`, then the
 278    *exc* argument is the type of exception that will be raised (usually
 279    :exc:`IndexError` or :exc:`OverflowError`).  If *exc* is *NULL*, then the
 280    exception is cleared and the value is clipped to *PY_SSIZE_T_MIN* for a negative
 281    integer or *PY_SSIZE_T_MAX* for a positive integer.
 282
 283
 284 .. cfunction:: int PyIndex_Check(PyObject *o)
 285
 286    Returns True if *o* is an index integer (has the nb_index slot of  the
 287    tp_as_number structure filled in).