papyri
{ } Raw JSON

bundles / scipy 1.17.1 / scipy / stats / _mstats_basic / _mask_to_limits

function

scipy.stats._mstats_basic:_mask_to_limits

source: /scipy/stats/_mstats_basic.py :2271

Signature

def   _mask_to_limits ( a ,  limits ,  inclusive )

Summary

Mask an array for values outside of given limits.

Extended Summary

This is primarily a utility function.

Parameters

a : array
limits : (float or None, float or None)
A tuple consisting of the (lower limit, upper limit). Values in the
input array less than the lower limit or greater than the upper limit
will be masked out. None implies no limit.
inclusive : (bool, bool)
A tuple consisting of the (lower flag, upper flag). These flags
determine whether values exactly equal to lower or upper are allowed.

Returns

: A MaskedArray.

Raises

: A ValueError if there are no values within the given limits.

Aliases

  • scipy.stats._mstats_basic._mask_to_limits