__int__

array.__int__() → int

Converts a zero-dimensional array to a Python int object.

Parameters:

self (array) – zero-dimensional array instance. Should have a real-valued or boolean data type. If self has a complex floating-point data type, the function must raise a TypeError.

Returns:

out (int) – a Python int object representing the single element of the array instance.

Notes

Special cases

For boolean operands,

  • If self is True, the result is 1.

  • If self is False, the result is 0.

For floating-point operands,

  • If self is a finite number, the result is the integer part of self.

  • If self is -0, the result is 0.

Raises

For floating-point operands,

  • If self is either +infinity or -infinity, raise OverflowError.

  • If self is NaN, raise ValueError.

Notes

Lazy implementations

The Python language requires the return value to be of type int. Lazy implementations are therefore not able to return any kind of lazy/delayed object here and should raise a ValueError instead.

Changed in version 2022.12: Added boolean and complex data type support.

Changed in version 2023.12: Allowed lazy implementations to error.