bigframes.geopandas.GeoSeries.between

GeoSeries.between(left, right, inclusive='both')

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.

Examples:

Boundary values are included by default:

>>> s = bpd.Series([2, 0, 4, 8, np.nan])
>>> s.between(1, 4)
0     True
1    False
2     True
3    False
4     <NA>
dtype: boolean

With inclusive set to “neither” boundary values are excluded:

>>> s.between(1, 4, inclusive="neither")
0     True
1    False
2    False
3    False
4     <NA>
dtype: boolean

left and right can be any scalar value:

>>> s = bpd.Series(['Alice', 'Bob', 'Carol', 'Eve'])
>>> s.between('Anna', 'Daniel')
0    False
1     True
2     True
3    False
dtype: boolean

Parameters:

• left (scalar or list-like) – Left boundary.

• right (scalar or list-like) – Right boundary.

• inclusive ({"both", "neither", "left", "right"}) – Include boundaries. Whether to set each bound as closed or open.

Returns:

Series representing whether each element is between left and right (inclusive).

Return type:

bigframes.pandas.Series