nlcpy.ma.default_fill_value

nlcpy.ma.default_fill_value(obj)

Returns the default fill value for the argument object.

The default filling value depends on the datatype of the input array or the type of the input scalar:

datatype	default
bool	True
int	999999
float	1.e20
complex	1.e20+0j

For structured types, a structured scalar is returned, with each field the default fill value for its type.

For subarray types, the fill value is an array of the same size containing the default scalar fill value.

Parameters

objndarray, dtype or scalar

The array data-type or scalar for which the default fill value is returned.

Returns

fill_valuescalar

The default fill value.

Examples

>>> import nlcpy as vp
>>> vp.ma.default_fill_value(1)
999999
>>> vp.ma.default_fill_value(vp.array([1.1, 2., vp.pi]))
1e+20
>>> vp.ma.default_fill_value(vp.dtype(complex))
(1e+20+0j)