numpy.ma.extras._fromnxfunction

class documentation

class _fromnxfunction:

Known subclasses: numpy.ma.extras._fromnxfunction_allargs, numpy.ma.extras._fromnxfunction_args, numpy.ma.extras._fromnxfunction_seq, numpy.ma.extras._fromnxfunction_single

View In Hierarchy

Defines a wrapper to adapt NumPy functions to masked arrays.

An instance of _fromnxfunction can be called with the same parameters as the wrapped NumPy function. The docstring of newfunc is adapted from the wrapped function as well, see getdoc.

This class should not be used directly. Instead, one of its extensions that provides support for a specific type of input should be used.

Parameters

funcname : str
The name of the function to be adapted. The function should be in the NumPy namespace (i.e. np.funcname).
Method __call__ Undocumented
Method __init__ Undocumented
Method getdoc Retrieve the docstring and signature from the function.
Instance Variable __name__ Undocumented
def __call__(self, *args, **params):
overridden in numpy.ma.extras._fromnxfunction_allargs, numpy.ma.extras._fromnxfunction_args, numpy.ma.extras._fromnxfunction_seq, numpy.ma.extras._fromnxfunction_single

Undocumented

def __init__(self, funcname):

Undocumented

def getdoc(self):

Retrieve the docstring and signature from the function.

The __doc__ attribute of the function is used as the docstring for the new masked array version of the function. A note on application of the function to the mask is appended.

Parameters

None

__name__ =

Undocumented