piso.interval.issuperset

piso.interval.issuperset(interval, *intervals, squeeze=True)

Indicates whether one pandas.Interval is a superset of one, or more, others.

Parameters

intervalpandas.Interval

An interval, against which all other intervals belonging to intervals are compared.

*intervalsargument list of pandas.Interval

Must contain at least one argument.

squeezeboolean, default True

If True, will try to coerce the return value to a single boolean

Returns

boolean, or numpy.ndarray of booleans

Examples

>>> import pandas as pd
>>> import piso.interval

>>> piso.interval.issuperset(
...    pd.Interval(1, 4),
...    pd.Interval(2, 4),
... )
True

>>> piso.interval.issuperset(
...    pd.Interval(1, 4),
...    pd.Interval(0, 3),
... )
False

>>> piso.interval.issuperset(
...    pd.Interval(1, 4),
...    pd.Interval(2, 4),
...    pd.Interval(0, 3),
... )
array([ True,  False])

>>> piso.interval.issuperset(
...    pd.Interval(0, 3),
...    pd.Interval(0, 3),
...    squeeze=False
... )
array([ True])