Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-111389: expose _PyHASH_INF/BITS/MODULUS/IMAG macros as public #111418

Merged
merged 18 commits into from
Mar 9, 2024
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion Doc/c-api/hash.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
PyHash API
----------

See also the :c:member:`PyTypeObject.tp_hash` member.
See also the :c:member:`PyTypeObject.tp_hash` member and :ref:`numeric-hash`.

.. c:type:: Py_hash_t

Expand All @@ -17,6 +17,29 @@ See also the :c:member:`PyTypeObject.tp_hash` member.

.. versionadded:: 3.2

.. c:macro:: PyHASH_MODULUS

The Mersenne prime ``P = 2**n -1``, used for numeric hash scheme.
skirpichev marked this conversation as resolved.
Show resolved Hide resolved
skirpichev marked this conversation as resolved.
Show resolved Hide resolved

.. versionadded:: 3.13

.. c:macro:: PyHASH_BITS

The exponent ``n`` of ``P``.
skirpichev marked this conversation as resolved.
Show resolved Hide resolved

.. versionadded:: 3.13

.. c:macro:: PyHASH_INF

The hash value returned for a positive infinity.

.. versionadded:: 3.13

.. c:macro:: PyHASH_IMAG

The multiplier used for the imaginary part of a complex number.

.. versionadded:: 3.13

.. c:type:: PyHash_FuncDef

Expand Down
5 changes: 5 additions & 0 deletions Include/cpython/pyhash.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@
# define _PyHASH_BITS 31
#endif

#define PyHASH_BITS _PyHASH_BITS
skirpichev marked this conversation as resolved.
Show resolved Hide resolved

#define _PyHASH_MODULUS (((size_t)1 << _PyHASH_BITS) - 1)
#define PyHASH_MODULUS _PyHASH_MODULUS
#define _PyHASH_INF 314159
#define PyHASH_INF _PyHASH_INF
#define _PyHASH_IMAG _PyHASH_MULTIPLIER
#define PyHASH_IMAG _PyHASH_IMAG

/* Helpers for hash functions */
PyAPI_FUNC(Py_hash_t) _Py_HashDouble(PyObject *, double);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add :c:macro:`PyHASH_MODULUS`, :c:macro:`PyHASH_BITS`, :c:macro:`PyHASH_INF`
and :c:macro:`PyHASH_IMAG` C macros. Patch by Sergey B Kirpichev.
Loading