ENH: `trunc` for floating and integer types #28949

ganesh-k13 · 2025-05-13T13:52:53Z

Changes

Add __trunc__ for floating and integer types

Testing

>>> np.float32(np.pi).__trunc__()
3
>>> import math
>>> math.trunc(np.float32(-np.pi))
-3
>>> math.trunc(np.float16(127))
127

Todo

jorenham

don't forget about the stubs :)

numpy/_core/src/multiarray/scalartypes.c.src

jorenham · 2025-05-14T14:24:15Z

I think it would make sense to also do this for np.integer:

>>> float.__trunc__
<method '__trunc__' of 'float' objects>
>>> int.__trunc__
<method '__trunc__' of 'int' objects>

The other rounding dunders are currently also present in both floating and integer.
Thoughts?

jorenham · 2025-05-14T17:57:03Z

the type-test at numpy/typing/tests/data/fail/scalars.pyi:86 should be removed now

ganesh-k13 · 2025-05-15T02:23:00Z

I think it would make sense to also do this for np.integer:

Oh for sure, since the implementation is small, I'll squeeze it in here. Thanks for the info!

the type-test at numpy/typing/tests/data/fail/scalars.pyi:86 should be removed now

Ah that makes sense.

- Added edgcases for float - Added TCs for integer

numpy/__init__.pyi

Co-authored-by: Joren Hammudoglu <jhammudoglu@gmail.com>

numpy/_core/_add_newdocs_scalars.py

numpy/_core/tests/test_scalar_methods.py

jorenham · 2025-05-16T04:17:50Z

numpy/_core/src/multiarray/scalartypes.c.src

any reason in particular why you defined it on the individual subclasses, and not directly on floating and integer, like __round__?

oh like in floatingtype_methods? I was actually very curious on how it's getting picked up as it's not referenced anywhere else in numpy/. How does that work?

note that integer also includes timedelta64

oh like in floatingtype_methods? I was actually very curious on how it's getting picked up as it's not referenced anywhere else in numpy/. How does that work?

I have minimal knowledge of the C codebase actually haha. Maybe some macro magic, or in some generated C sources?

It works magically :). Let me ask in slack, it feels like magic as I'm not finding it in the generated source as well. Thanks for catching it though!

Ok so it's in

numpy/numpy/_core/src/multiarray/scalartypes.c.src

Line 4490 in 8d722b8

Py@NAME@ArrType_Type.tp_methods = @name@type_methods;

lol. Thanks to Sebastian for pointing it out.

jorenham · 2025-05-16T04:25:07Z

numpy/_core/_add_newdocs_scalars.py

+        f"""
+        {float_name}.__trunc__() -> int
+
+        Return the floating point number with the fractional part removed,
+        leaving the integer part.
+        {'\n        .. versionadded:: 2.3\n' if float_name != 'double' else ''}
+        Examples
+        --------
+        >>> np.{float_name}(np.pi).__trunc__()
+        3
+        >>> import math
+        >>> math.trunc(np.{float_name}(-np.pi))
+        -3
+        """))


a classic .format might be a bit cleaner here, also for the triple {float_name}

ganesh-k13 · 2025-05-19T04:00:48Z

@jorenham a basic query on integer's typing: How did it get added? There is no diff indicating it's added:

Help on method_descriptor:

__trunc__(self, /) unbound numpy.integer method
    int8.__trunc__() -> int

jorenham · 2025-05-19T13:44:26Z

@jorenham a basic query on integer's typing: How did it get added? There is no diff indicating it's added:
Help on method_descriptor:

__trunc__(self, /) unbound numpy.integer method
    int8.__trunc__() -> int

I'm not sure I understand you question. Are you asking how to verify that the method you added in the stubs actually works? Because if so, you could do that by adding a type-test in typing/tests/data/pass.

ganesh-k13 added 2 commits May 13, 2025 19:08

ENH: Added float.__trunc__

1b9f6fa

DOC: Added documentation for float.__trunc__

e7634c2

ganesh-k13 added 01 - Enhancement 62 - Python API Changes or additions to the Python API. Mailing list should usually be notified. labels May 13, 2025

ganesh-k13 self-assigned this May 13, 2025

ganesh-k13 changed the title ~~__trunc__ for floating types~~ ENH: __trunc__ for floating types May 13, 2025

jorenham reviewed May 13, 2025

View reviewed changes

ganesh-k13 commented May 13, 2025

View reviewed changes

numpy/_core/src/multiarray/scalartypes.c.src Outdated Show resolved Hide resolved

ganesh-k13 added 3 commits May 14, 2025 11:15

BUG: Cast halfs to prevent overflow

79f102d

TST: Added TCs for float.__trunc__

b442ec0

TYP: Typing for float.__trunc__

4280f69

ganesh-k13 added the 56 - Needs Release Note. Needs an entry in doc/release/upcoming_changes label May 14, 2025

ganesh-k13 added 3 commits May 15, 2025 12:23

MAINT: Refactor to use gentype_int

fa2a67a

TYP: Removed trunc ignore

4c60023

ENH: Added int.__trunc__

89a0f9e

ganesh-k13 changed the title ~~ENH: __trunc__ for floating types~~ ENH: __trunc__ for floating and integer types May 15, 2025

ganesh-k13 added 2 commits May 15, 2025 14:24

TST: Refined UT for Truncate

c091527

- Added edgcases for float - Added TCs for integer

TST, BUG: Use int in float tests to avoid overflow

24e6e21

jorenham reviewed May 15, 2025

View reviewed changes

numpy/__init__.pyi Outdated Show resolved Hide resolved

ganesh-k13 added 2 commits May 16, 2025 09:19

TYP: Moved trunc to _RoundMixin

4bdc3ba

DOC: __trunc__ for scalars (numpy#27789)

bb11cf4

ganesh-k13 force-pushed the trunc branch from 245bee9 to bb11cf4 Compare May 16, 2025 03:56

DOC: Added version for int.__trunc__

2dcd189

jorenham reviewed May 16, 2025

View reviewed changes

numpy/__init__.pyi Outdated Show resolved Hide resolved

DOC: Remove overload

7a46194

Co-authored-by: Joren Hammudoglu <jhammudoglu@gmail.com>

jorenham reviewed May 16, 2025

View reviewed changes

numpy/_core/_add_newdocs_scalars.py Outdated Show resolved Hide resolved

jorenham reviewed May 16, 2025

View reviewed changes

numpy/_core/tests/test_scalar_methods.py Outdated Show resolved Hide resolved

DOC: Removed versionadded for float64

91e0961

jorenham reviewed May 16, 2025

View reviewed changes

ganesh-k13 added 2 commits May 19, 2025 09:22

MAINT: Move trunc to *type_methods[]

fea22cf

DOC, MAINT: Fix docstring to use format

426d3b2

ganesh-k13 marked this pull request as ready for review May 19, 2025 04:01

Uh oh!

ENH: __trunc__ for floating and integer types #28949

Are you sure you want to change the base?

ENH: __trunc__ for floating and integer types #28949

Uh oh!

Conversation

ganesh-k13 commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Testing

Related

Todo

Uh oh!

jorenham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jorenham commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jorenham commented May 14, 2025

Uh oh!

ganesh-k13 commented May 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jorenham May 16, 2025

Choose a reason for hiding this comment

Uh oh!

ganesh-k13 May 16, 2025

Choose a reason for hiding this comment

Uh oh!

jorenham May 16, 2025

Choose a reason for hiding this comment

Uh oh!

jorenham May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ganesh-k13 May 19, 2025

Choose a reason for hiding this comment

Uh oh!

ganesh-k13 May 19, 2025

Choose a reason for hiding this comment

Uh oh!

jorenham May 16, 2025

Choose a reason for hiding this comment

Uh oh!

ganesh-k13 commented May 19, 2025

Uh oh!

jorenham commented May 19, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

ENH: `trunc` for floating and integer types #28949

ENH: `trunc` for floating and integer types #28949

ganesh-k13 commented May 13, 2025 •

edited

Loading

jorenham commented May 14, 2025 •

edited

Loading

jorenham May 16, 2025 •

edited

Loading