numpy.ma.maximum_fill_value()

numpy.ma.maximum_fill_value(obj) [source]

Return the minimum value that can be represented by the dtype of an object.

This function is useful for calculating a fill value suitable for taking the maximum of an array with a given dtype.

Parameters:

Parameters:	obj : {ndarray, dtype} An object that can be queried for it?s numeric type.
Returns:	val : scalar The minimum representable value.
Raises:	TypeError If `obj` isn?t a suitable numeric type.

obj : {ndarray, dtype}

An object that can be queried for it?s numeric type.

Returns:

val : scalar

The minimum representable value.

Raises:

TypeError

If obj isn?t a suitable numeric type.

Examples

>>> import numpy.ma as ma
>>> a = np.int8()
>>> ma.maximum_fill_value(a)
-128
>>> a = np.int32()
>>> ma.maximum_fill_value(a)
-2147483648

An array of numeric data can also be passed.

>>> a = np.array([1, 2, 3], dtype=np.int8)
>>> ma.maximum_fill_value(a)
-128
>>> a = np.array([1, 2, 3], dtype=np.float32)
>>> ma.maximum_fill_value(a)
-inf

Links:

https://docs.scipy.org/doc/numpy-1.11.0/reference/generated/numpy.ma.maximum_fill_value.html

doc_NumPy

2025-01-10 15:47:30

Comments