scipp.issorted#

scipp.issorted(x, dim, order='ascending')#

Check if the values of a variable are sorted.

  • If order is ‘ascending’, check if values are non-decreasing along dim.

  • If order is ‘descending’, check if values are non-increasing along dim.

Parameters:
  • x (TypeVar(_T, Variable, DataGroup)) – Variable to check.

  • dim (str) – Dimension along which order is checked.

  • order (Literal[‘ascending’, ‘descending’], default: 'ascending') – Sorting order.

Returns:

TypeVar(_T, Variable, DataGroup) – Variable containing one less dim than the original variable with the corresponding boolean value for whether it was sorted along the given dim for the other dimensions.

See also

scipp.allsorted