bottleneck.nonreduce module

Module contents

Bottleneck nonreducing functions.

bottleneck.nonreduce.replace(a, old, new)

Replace (inplace) given scalar values of an array with new values.

The equivalent numpy function:

a[a==old] = new

Or in the case where old=np.nan:

a[np.isnan(old)] = new

Parameters

anumpy.ndarray

The input array, which is also the output array since this functions works inplace.

oldscalar

All elements in a with this value will be replaced by new.

newscalar

All elements in a with a value of old will be replaced by new.

Returns

Returns a view of the input array after performing the replacements,

if any.

Examples

Replace zero with 3 (note that the input array is modified):

>>> a = np.array([1, 2, 0])
>>> bn.replace(a, 0, 3)
>>> a
array([1, 2, 3])

Replace np.nan with 0:

>>> a = np.array([1, 2, np.nan])
>>> bn.replace(a, np.nan, 0)
>>> a
array([ 1.,  2.,  0.])