between(left: Any, right: Any, inclusive: bool = True) → pyspark.pandas.series.Series¶
Return boolean Series equivalent to left <= series <= right. This function returns a boolean vector containing True wherever the corresponding Series element is between the boundary values left and right. NA values are treated as False.
- leftscalar or list-like
- rightscalar or list-like
- inclusivebool, default True
Series representing whether each element is between left and right (inclusive).
This function is equivalent to
(left <= ser) & (ser <= right)
>>> s = ps.Series([2, 0, 4, 8, np.nan])
Boundary values are included by default:
>>> s.between(1, 4) 0 True 1 False 2 True 3 False 4 False dtype: bool
With inclusive set to
Falseboundary values are excluded:
>>> s.between(1, 4, inclusive=False) 0 True 1 False 2 False 3 False 4 False dtype: bool
left and right can be any scalar value:
>>> s = ps.Series(['Alice', 'Bob', 'Carol', 'Eve']) >>> s.between('Anna', 'Daniel') 0 False 1 True 2 True 3 False dtype: bool