Pandas IntervalIndex: 区間インデックスと値の包含関係を判定する方法

pandas.IntervalIndex.contains：区間インデックスと値の包含関係を判定

このチュートリアルでは、pandas.IntervalIndex.containsメソッドについて解説します。このメソッドは、区間インデックスと値の包含関係を判定するために使用されます。

インデックスオブジェクトと区間インデックス

Pandasのデータフレームやシリーズは、行や列を識別するためにインデックスを使用します。インデックスには、数値、文字列、日付など、さまざまなデータ型を使用できます。

区間インデックスは、連続した値の範囲を表す特殊なインデックスです。例えば、以下のコードは、2023年1月から3月までの各月の開始と終了を表す区間インデックスを作成します。

import pandas as pd

# 区間インデックスの作成
interval_index = pd.IntervalIndex.from_tuples([
    (pd.to_datetime('2023-01-01'), pd.to_datetime('2023-01-31')),
    (pd.to_datetime('2023-02-01'), pd.to_datetime('2023-02-28')),
    (pd.to_datetime('2023-03-01'), pd.to_datetime('2023-03-31')),
])

pandas.IntervalIndex.containsメソッドは、区間インデックスと値の包含関係を判定するために使用されます。このメソッドは、以下の引数を受け取ります。

• values: 判定対象の値。単一の値、リスト、または配列を渡すことができます。
• closed: 区間境界の包含関係を指定します。デフォルトはTrueで、境界を含む場合に包含と判定されます。Falseの場合は、境界を含まない場合に包含と判定されます。

メソッドは、判定結果を要素ごとにTrue/False値で返します。

使用例

以下に、pandas.IntervalIndex.containsメソッドの使用例をいくつか示します。

例1：単一の値の包含判定

# 2023年2月15日が含まれているか判定
interval_index.contains(pd.to_datetime('2023-02-15'))

# 出力：True

例2：複数の値の包含判定

# 2023年1月15日と2023年3月15日が含まれているか判定
interval_index.contains([pd.to_datetime('2023-01-15'), pd.to_datetime('2023-03-15')])

# 出力：[False, True]

例3：境界の包含関係を指定

# 境界を含まない場合に包含と判定
interval_index.contains(pd.to_datetime('2023-02-01'), closed=False)

# 出力：False

pandas.IntervalIndex.containsメソッドは、区間インデックスと値の包含関係を判定するために使用されます。このメソッドは、データ分析や可視化など、さまざまな場面で役立ちます。

補足

• pandas.IntervalIndex.containsメソッドは、区間インデックスと値の比較にのみ使用できます。値同士の比較には使用できません。
• 区間インデックスと値の比較には、==、!=、<、<=、>、>=などの比較演算子も使用できます。

pandas.IntervalIndex.contains メソッドのサンプルコード

単一の値の包含判定

import pandas as pd

# 区間インデックスの作成
interval_index = pd.IntervalIndex.from_tuples([
    (pd.to_datetime('2023-01-01'), pd.to_datetime('2023-01-31')),
    (pd.to_datetime('2023-02-01'), pd.to_datetime('2023-02-28')),
    (pd.to_datetime('2023-03-01'), pd.to_datetime('2023-03-31')),
])

# 2023年2月15日が含まれているか判定
interval_index.contains(pd.to_datetime('2023-02-15'))

True

複数の値の包含判定

# 2023年1月15日と2023年3月15日が含まれているか判定
interval_index.contains([pd.to_datetime('2023-01-15'), pd.to_datetime('2023-03-15')])

出力例：

[False, True]

境界の包含関係を指定

# 境界を含まない場合に包含と判定
interval_index.contains(pd.to_datetime('2023-02-01'), closed=False)

出力例：

False

区間と値の比較

# 区間と値の比較
interval_index == pd.to_datetime('2023-02-15')

出力例：

[False  True False]

区間同士の比較

# 区間同士の比較
interval_index[0] == interval_index[1]

出力例：

False

区間インデックスの取得

# データフレームから区間インデックスを取得
df = pd.DataFrame({'date': pd.to_datetime(['2023-01-01', '2023-02-01', '2023-03-01'])})
df['date'] = pd.IntervalIndex.from_tuples([(d, d + pd.Timedelta(days=31)) for d in df['date']])

# 区間インデックスを取得
df.index

出力例：

IntervalIndex([(2023-01-01, 2023-01-31), (2023-02-01, 2023-02-28),
                (2023-03-01, 2023-03-31)],
               closed='right',
               dtype='datetime64[ns]')

区間インデックスの可視化

# 区間インデックスの可視化
df.plot()

出力例：

image: [無効な URL を削除しました]

補足

• 上記のサンプルコードは、あくまでも参考例です。
• 実際の利用シーンに合わせて、コードを修正して使用してください。

pandas.IntervalIndex.contains 以外の方法

比較演算子

以下の比較演算子を使用して、区間インデックスと値を比較できます。

• ==: 等号
• !=: 不等号
• <: 小なり
• <=: 小さか等しい
• >: 大なり
• >=: 大なり等しい

例：

import pandas as pd

# 区間インデックスの作成
interval_index = pd.IntervalIndex.from_tuples([
    (pd.to_datetime('2023-01-01'), pd.to_datetime('2023-01-31')),
    (pd.to_datetime('2023-02-01'), pd.to_datetime('2023-02-28')),
    (pd.to_datetime('2023-03-01'), pd.to_datetime('2023-03-31')),
])

# 2023年2月15日が含まれているか判定
interval_index == pd.to_datetime('2023-02-15')

出力例：

[False  True False]

isin メソッドを使用して、値が区間インデックスに含まれているかどうかを判定できます。

例：

# 2023年2月15日が含まれているか判定
interval_index.isin([pd.to_datetime('2023-02-15')])

出力例：

array([False,  True, False])

自作関数

上記のいずれの方法も適切ではない場合は、自作関数を作成して包含関係を判定することができます。

例：

def is_contained(interval_index, value):
  """
  区間インデックスと値の包含関係を判定する関数

  Args:
    interval_index: 区間インデックス
    value: 値

  Returns:
    包含関係判定結果
  """

  for interval in interval_index:
    if interval.left <= value <= interval.right:
      return True

  return False

# 2023年2月15日が含まれているか判定
is_contained(interval_index, pd.to_datetime('2023-02-15'))

出力例：

True

その他のライブラリ

pytz や dateutil などのライブラリを使用して、区間と値の包含関係を判定することもできます。

pandas.IntervalIndex.contains メソッド以外にも、区間インデックスと値の包含関係を判定する方法はいくつかあります。