__float__

array.__float__() → float

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

Note

Casting integer values outside the representable bounds of Python’s float type is not specified and is implementation-dependent.

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 (float) – a Python float 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.

Lazy implementations

The Python language requires the return value to be of type float. 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.