between

Element-wise range check: returns a boolean Series indicating whether each value lies within [left, right]. Mirrors pandas.Series.between.

seriesBetween — inclusive="both" (default)

Python pandas equivalent:

import pandas as pd

s = pd.Series([1, 2, 3, 4, 5])
print(s.between(2, 4))
# 0    False
# 1     True
# 2     True
# 3     True
# 4    False
# dtype: bool

tsb equivalent:

import { Series, seriesBetween } from "tsb";

const s = new Series({ data: [1, 2, 3, 4, 5] });
seriesBetween(s, 2, 4).values;
// [false, true, true, true, false]

Inclusive options

Python pandas equivalent:

import pandas as pd

s = pd.Series([1, 2, 3, 4, 5])

s.between(2, 4, inclusive="left").tolist()
# [False, True, True, False, False]

s.between(2, 4, inclusive="right").tolist()
# [False, False, True, True, False]

s.between(2, 4, inclusive="neither").tolist()
# [False, False, True, False, False]

tsb equivalent:

import { Series, seriesBetween } from "tsb";

const s = new Series({ data: [1, 2, 3, 4, 5] });

seriesBetween(s, 2, 4, { inclusive: "left" }).values;
// [false, true, true, false, false]

seriesBetween(s, 2, 4, { inclusive: "right" }).values;
// [false, false, true, true, false]

seriesBetween(s, 2, 4, { inclusive: "neither" }).values;
// [false, false, true, false, false]

Missing values

Python pandas equivalent:

import pandas as pd
import numpy as np

s = pd.Series([1, None, np.nan, 4])
s.between(0, 5).tolist()
# [True, False, False, True]

tsb equivalent:

import { Series, seriesBetween } from "tsb";

const s = new Series({ data: [1, null, NaN, 4] });
seriesBetween(s, 0, 5).values;
// [true, false, false, true]

String comparison

Python pandas equivalent:

import pandas as pd

s = pd.Series(["apple", "banana", "cherry", "date"])
s.between("banana", "cherry").tolist()
# [False, True, True, False]

tsb equivalent:

import { Series, seriesBetween } from "tsb";

const s = new Series({ data: ["apple", "banana", "cherry", "date"] });
seriesBetween(s, "banana", "cherry").values;
// [false, true, true, false]