Supported functions

named_arrays implements the numpy protocols __array_function__ and __array_ufunc__, so most of the numpy API accepts these arrays directly, using axis names where numpy would take an axis number. Coverage is not complete, and it is not uniform across the array types, since each type implements each function separately.

The tables below are generated from the dispatch tables themselves, so they describe the version of named_arrays which built this page rather than a list someone remembered to update. A check mark means the array type supports the function and an empty cell means it does not, and a function which is absent is supported by no array type at all. If you need one which is missing, an issue or a pull request is welcome at the repository.

Every numpy universal function, such as numpy.sqrt() or numpy.add(), is supported by every array type through __array_ufunc__, and is not listed here.

A matrix is a vector whose components are themselves vectors, so it supports whatever the Vector column supports.

Functions in the numpy namespace

Function	Scalar	Uncertain	Vector	Function
numpy.all()	✓	✓	✓	✓
numpy.allclose()	✓	✓	✓	✓
numpy.any()	✓	✓	✓	✓
numpy.argmax()	✓	✓	✓	✓
numpy.argmin()	✓	✓	✓	✓
numpy.argsort()	✓	✓	✓
numpy.around()	✓	✓	✓	✓
numpy.array_equal()	✓	✓	✓	✓
numpy.array_equiv()	✓	✓	✓	✓
numpy.average()	✓	✓	✓
numpy.broadcast_to()	✓	✓	✓	✓
numpy.clip()	✓	✓	✓	✓
numpy.concatenate()	✓	✓	✓	✓
numpy.convolve()	✓	✓
numpy.copyto()	✓	✓	✓	✓
numpy.count_nonzero()	✓	✓	✓	✓
numpy.cross()			✓
numpy.cumprod()	✓	✓	✓	✓
numpy.cumsum()	✓	✓	✓	✓
numpy.cumulative_prod()	✓	✓	✓	✓
numpy.cumulative_sum()	✓	✓	✓	✓
numpy.diff()	✓	✓	✓
numpy.empty_like()	✓	✓	✓
numpy.expand_dims()	✓	✓	✓	✓
numpy.fft.fft()	✓	✓	✓
numpy.fft.fft2()	✓	✓	✓
numpy.fft.fftn()	✓	✓	✓
numpy.fft.ifft()	✓	✓	✓
numpy.fft.ifft2()	✓	✓	✓
numpy.fft.ifftn()	✓	✓	✓
numpy.fft.irfft()	✓	✓	✓
numpy.fft.irfft2()	✓	✓	✓
numpy.fft.irfftn()	✓	✓	✓
numpy.fft.rfft()	✓	✓	✓
numpy.fft.rfft2()	✓	✓	✓
numpy.fft.rfftn()	✓	✓	✓
numpy.flip()	✓	✓	✓	✓
numpy.geomspace()	✓	✓	✓
numpy.gradient()	✓	✓	✓	✓
numpy.imag()	✓	✓	✓
numpy.isclose()	✓	✓	✓	✓
numpy.lib.scimath.arccos()	✓	✓	✓
numpy.lib.scimath.arcsin()	✓	✓	✓
numpy.lib.scimath.arctanh()	✓	✓	✓
numpy.lib.scimath.log()	✓	✓	✓
numpy.lib.scimath.log10()	✓	✓	✓
numpy.lib.scimath.log2()	✓	✓	✓
numpy.lib.scimath.logn()	✓	✓	✓
numpy.lib.scimath.power()	✓	✓	✓
numpy.lib.scimath.sqrt()	✓	✓	✓
numpy.linalg.inv()		✓
numpy.linspace()	✓	✓	✓
numpy.logspace()	✓	✓	✓
numpy.max()	✓	✓	✓	✓
numpy.mean()	✓	✓	✓	✓
numpy.median()	✓	✓	✓	✓
numpy.min()	✓	✓	✓	✓
numpy.moveaxis()	✓	✓	✓	✓
numpy.nan_to_num()	✓	✓	✓
numpy.nanargmax()	✓	✓	✓	✓
numpy.nanargmin()	✓	✓	✓	✓
numpy.nancumprod()	✓	✓	✓	✓
numpy.nancumsum()	✓	✓	✓	✓
numpy.nanmax()	✓	✓	✓	✓
numpy.nanmean()	✓	✓	✓	✓
numpy.nanmedian()	✓	✓	✓	✓
numpy.nanmin()	✓	✓	✓	✓
numpy.nanpercentile()	✓	✓	✓	✓
numpy.nanprod()	✓	✓	✓	✓
numpy.nanquantile()	✓	✓	✓	✓
numpy.nanstd()	✓	✓	✓	✓
numpy.nansum()	✓	✓	✓	✓
numpy.nanvar()	✓	✓	✓	✓
numpy.ndim()	✓	✓	✓	✓
numpy.nonzero()	✓	✓	✓	✓
numpy.ones_like()	✓	✓	✓
numpy.partition()	✓	✓
numpy.percentile()	✓	✓	✓	✓
numpy.prod()	✓	✓	✓	✓
numpy.ptp()	✓	✓	✓	✓
numpy.quantile()	✓	✓	✓	✓
numpy.real()	✓	✓	✓
numpy.repeat()	✓	✓	✓	✓
numpy.reshape()	✓	✓	✓	✓
numpy.roll()	✓	✓	✓	✓
numpy.round()	✓	✓	✓	✓
numpy.shape()	✓	✓	✓	✓
numpy.sort()	✓	✓	✓
numpy.squeeze()	✓	✓	✓	✓
numpy.stack()	✓	✓	✓	✓
numpy.std()	✓	✓	✓	✓
numpy.strings.mod()	✓	✓	✓
numpy.sum()	✓	✓	✓	✓
numpy.take_along_axis()	✓	✓	✓	✓
numpy.transpose()	✓	✓	✓	✓
numpy.trapezoid()	✓	✓	✓
numpy.unravel_index()	✓	✓	✓
numpy.var()	✓	✓	✓	✓
numpy.where()	✓	✓	✓
numpy.zeros_like()	✓	✓	✓

Functions in the named_arrays namespace

Function	Scalar	Uncertain	Vector	Function
named_arrays.arange()	✓		✓
named_arrays.asanyarray()	✓	✓	✓	✓
named_arrays.asarray()	✓	✓	✓	✓
named_arrays.broadcast_to()	✓	✓	✓	✓
named_arrays.colorsynth.colorbar()	✓	✓		✓
named_arrays.colorsynth.rgb()	✓	✓	✓	✓
named_arrays.convolve()	✓	✓	✓
named_arrays.debroadcast()	✓	✓	✓	✓
named_arrays.despike()	✓	✓		✓
named_arrays.digitize()	✓	✓	✓
named_arrays.geometry.convex_hull()			✓
named_arrays.geometry.point_in_polygon()	✓	✓
named_arrays.histogram()	✓	✓	✓	✓
named_arrays.histogram2d()	✓	✓
named_arrays.histogramdd()	✓	✓
named_arrays.interp()	✓	✓	✓
named_arrays.jacobian()	✓	✓	✓
named_arrays.ndfilters.mean_filter()	✓	✓	✓	✓
named_arrays.ndfilters.trimmed_mean_filter()	✓	✓	✓	✓
named_arrays.ndfilters.variance_filter()	✓	✓	✓	✓
named_arrays.nominal()		✓	✓	✓
named_arrays.numexpr.evaluate()	✓	✓	✓
named_arrays.optimize.minimum_brent()	✓	✓
named_arrays.optimize.minimum_gradient_descent()			✓
named_arrays.optimize.root_newton()	✓	✓	✓
named_arrays.optimize.root_secant()	✓	✓
named_arrays.plt.annotate()			✓
named_arrays.plt.fill()	✓	✓	✓
named_arrays.plt.imshow()	✓
named_arrays.plt.line_collection()	✓	✓	✓
named_arrays.plt.pcolormesh()	✓		✓	✓
named_arrays.plt.pcolormovie()	✓
named_arrays.plt.plot()	✓	✓	✓
named_arrays.plt.scatter()	✓	✓
named_arrays.plt.stairs()	✓	✓
named_arrays.plt.text()	✓
named_arrays.random.binomial()	✓	✓	✓
named_arrays.random.choice()	✓	✓	✓
named_arrays.random.gamma()	✓	✓	✓
named_arrays.random.normal()	✓	✓	✓
named_arrays.random.poisson()	✓	✓	✓
named_arrays.random.uniform()	✓	✓	✓
named_arrays.regridding.convolve_weights()	✓
named_arrays.regridding.regrid_from_weights()	✓		✓
named_arrays.regridding.transpose_weights()	✓
named_arrays.regridding.transpose_weights_conservative()	✓		✓
named_arrays.regridding.weights()	✓		✓
named_arrays.searchsorted()	✓	✓	✓
named_arrays.unique()	✓
named_arrays.unit()	✓	✓	✓	✓
named_arrays.unit_normalized()	✓	✓	✓	✓