gh-81313: Add the intmath module (PEP-791) #133909

serhiy-storchaka · 2025-05-11T20:37:01Z

Issue: PEP-791: Add a module for integer related math functions #81313

📚 Documentation preview 📚: https://cpython-previews--133909.org.readthedocs.build/

serhiy-storchaka · 2025-05-11T20:41:31Z

This is a further development of #13741.

vstinner · 2025-05-11T21:11:25Z

A PEP is being written for this module: skirpichev/peps#8

skirpichev · 2025-05-12T05:31:53Z

Doc/library/imath.rst

+These functions accept integers and objects that implement the
+:meth:`~object.__index__` method which is used to convert the object to an integer


In the same way we could simplify now description of argument processing in the math module. Except for a special snowflake "log" - all use PyFloat_AsDouble(). (Well, few functions also try special dunder methods.)

Though, probably it's for following prs.

Doc/library/intmath.rst

skirpichev · 2025-06-01T08:08:11Z

Doc/library/intmath.rst

+number.  They cannot be used with floating-point numbers or complex
+numbers.


Last sentence looks redundant, though maybe it worth to be here.

Doc/library/intmath.rst

Modules/intmathmodule.c

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

Module renamed.

skirpichev · 2025-06-01T16:03:05Z

Modules/intmathmodule.c

+expression (1 + x)**n.
+
+Raises ValueError if either of the arguments are negative.
+


Suggested change

picnixz · 2025-06-01T16:14:25Z

Doc/library/intmath.rst

+   Return factorial of the nonnegative integer *n*.
+
+
+.. function:: gcd(a, b)


Isn't it gcd(*integers)?

Doc/library/intmath.rst

skirpichev · 2025-06-01T16:22:13Z

Doc/library/intmath.rst

+   Return factorial of the nonnegative integer *n*.
+
+
+.. function:: gcd(a, b)


Suggested change

.. function:: gcd(a, b)

.. function:: gcd(*integers)

Doc/library/intmath.rst

picnixz · 2025-06-01T16:38:29Z

Doc/whatsnew/3.15.rst

@@ -83,7 +83,11 @@ Other language changes
 New modules
 ===========

-* None yet.
+intmath


Maybe add an entry under the PEP-sized items as well?

Not all PEP's mentioned in release Summary (e.g. PEP 757 for the 3.13).

Yes, but for 3.14, I think we're mentioning them all? @hugovk do you want to mention the PEP? Or at least, we should have a link to the PEP. There is none at the moment (annotationlib got one)

Ask me after the PEP has been accepted :)

skirpichev · 2025-06-01T17:38:23Z

Doc/whatsnew/3.15.rst

+This module provides access to the mathematical functions for integer arguments.
+(Contributed by Serhiy Storchaka in :gh:`81313`.)


Suggested change

This module provides access to the mathematical functions for integer arguments.

(Contributed by Serhiy Storchaka in :gh:`81313`.)

This module provides access to the mathematical functions for integer

arguments (:pep:`791`).

(Contributed by Serhiy Storchaka in :gh:`81313`.)

pythongh-81313: Add the imath module

6e47acd

serhiy-storchaka requested review from a team, erlend-aasland and corona10 as code owners May 11, 2025 20:37

bedevere-app bot mentioned this pull request May 11, 2025

PEP-791: Add a module for integer related math functions #81313

Open

bedevere-app bot added the awaiting core review label May 11, 2025

Fix Sphinx warning.

62cb235

This comment was marked as resolved.

Sign in to view

skirpichev reviewed May 12, 2025

View reviewed changes

This comment was marked as resolved.

Sign in to view

Support multiple interpreters.

091dab6

This comment was marked as resolved.

Sign in to view

serhiy-storchaka added 4 commits May 12, 2025 09:55

_PyLong_NumBits returns int64_t now.

71d7f4f

Fix build on Windows.

7b61c5e

Add in a toctree.

eaea554

Regen generated files.

da3ceab

skirpichev self-requested a review May 13, 2025 12:39

This comment was marked as resolved.

Sign in to view

serhiy-storchaka added 4 commits June 1, 2025 09:17

Merge branch 'main' into imath3

2ab90a5

imath -> intmath

3299bf7

Remove ilog2().

9b6a151

Remove unneeded import.

7b327ec

skirpichev changed the title ~~gh-81313: Add the imath module~~ gh-81313: Add the intmath module Jun 1, 2025

picnixz changed the title ~~gh-81313: Add the intmath module~~ gh-81313: Add the intmath module (PEP-791) Jun 1, 2025

skirpichev reviewed Jun 1, 2025

View reviewed changes

Apply suggestions from code review

3194384

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

Apply suggestions from code review

59b1be1

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

bedevere-app bot added awaiting review and removed awaiting core review labels Jun 1, 2025

serhiy-storchaka added 2 commits June 1, 2025 11:30

Update clinic.

8137058

make regen-stdlib-module-names

ee0dbb6

skirpichev approved these changes Jun 1, 2025

View reviewed changes

Modules/intmathmodule.c

expression (1 + x)**n.

Raises ValueError if either of the arguments are negative.

Copy link

Contributor

skirpichev Jun 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

bedevere-app bot added awaiting core review and removed awaiting review labels Jun 1, 2025

picnixz reviewed Jun 1, 2025

View reviewed changes

skirpichev reviewed Jun 1, 2025

View reviewed changes

picnixz reviewed Jun 1, 2025

View reviewed changes

skirpichev reviewed Jun 1, 2025

View reviewed changes

		These functions accept integers and objects that implement the
		:meth:`~object.__index__` method which is used to convert the object to an integer

		number. They cannot be used with floating-point numbers or complex
		numbers.

		expression (1 + x)**n.

		Raises ValueError if either of the arguments are negative.

		Return factorial of the nonnegative integer n.


		.. function:: gcd(a, b)

		This module provides access to the mathematical functions for integer arguments.
		(Contributed by Serhiy Storchaka in :gh:`81313`.)

Uh oh!

gh-81313: Add the intmath module (PEP-791) #133909

Are you sure you want to change the base?

gh-81313: Add the intmath module (PEP-791) #133909

Conversation

serhiy-storchaka commented May 11, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

serhiy-storchaka commented May 11, 2025

Uh oh!

vstinner commented May 11, 2025

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

serhiy-storchaka commented May 11, 2025 •

edited by github-actions bot

Loading