Pandas Interval.closed 属性のすべて: データ型、比較、包含、演算、データフレームでの使用

Pandas Interval.closed 属性の分かりやすい解説

closed 属性の概要

例:

from pandas import Interval

# 左端を含む、長さ5日の間隔
interval1 = Interval(left=0, right=5, closed='left')

# 両端を含まない、長さ5日の間隔
interval2 = Interval(left=0, right=5, closed='neither')

# 右端を含む、長さ5日の間隔
interval3 = Interval(left=0, right=5, closed='right')

print(interval1)
# Interval(0, 5, closed='left')

print(interval2)
# Interval(0, 5, closed='neither')

print(interval3)
# Interval(0, 5, closed='right')

closed 属性は、以下の操作に影響を与えます。

• 比較:

print(interval1 == interval2)
# False

print(interval2 == interval3)
# False

print(interval1 == Interval(left=0, right=5, closed='both'))
# True

• 包含:

print(0 in interval1)
# True

print(0 in interval2)
# False

print(5 in interval3)
# True

• 演算:

print(interval1 + interval3)
# Interval(0, 10, closed='left')

print(interval2 + interval3)
# Interval(0, 10, closed='neither')

どの値を使うべきか

closed 属性の値は、データの性質と分析目的に依存します。

• 期間を表す場合: 両端を含む closed='both' を使うのが一般的です。
• 瞬間を表す場合: 両端を含まない closed='neither' を使うのが一般的です。
• 開始/終了時刻が不明確な場合: 片方のみを含む closed='left' または closed='right' を使うことがあります。

まとめ

pandas.Interval.closed 属性は、間隔の閉じ方を定義します。値によって比較、包含、演算などの動作が変わるので、データの性質と分析目的に合わせて適切な値を選択することが重要です。

Pandas Interval.closed 属性を使ったサンプルコード

比較

from pandas import Interval

# 左端を含む、長さ5日の間隔
interval1 = Interval(left=0, right=5, closed='left')

# 両端を含まない、長さ5日の間隔
interval2 = Interval(left=0, right=5, closed='neither')

# 右端を含む、長さ5日の間隔
interval3 = Interval(left=0, right=5, closed='right')

# 比較
print(interval1 == interval2)  # False
print(interval2 == interval3)  # False
print(interval1 == Interval(left=0, right=5, closed='both'))  # True

包含

# 包含
print(0 in interval1)  # True
print(0 in interval2)  # False
print(5 in interval3)  # True

演算

# 演算
print(interval1 + interval3)  # Interval(0, 10, closed='left')
print(interval2 + interval3)  # Interval(0, 10, closed='neither')

データフレームでの使用

import pandas as pd

# データフレーム作成
df = pd.DataFrame({'timestamp': pd.to_datetime(['2023-01-01', '2023-01-02', '2023-01-03', '2023-01-04']),
                   'value': [10, 20, 30, 40]})

# 1日単位の間隔を作成
df['interval'] = df['timestamp'].apply(lambda x: Interval(left=x, right=x + pd.Timedelta(days=1), closed='left'))

# 特定の日付を含む行を抽出
print(df[df['interval'].contains(pd.to_datetime('2023-01-02'))])

#  timestamp  value                               interval
# 1 2023-01-02   20  2023-01-02 00:00:00 to 2023-01-03 00:00:00

その他

• closed 属性は、IntervalIndex や Grouper でも使用できます。
• closed 属性のデフォルト値は 'left' です。

比較演算子

from pandas import Interval

# 左端を含む、長さ5日の間隔
interval1 = Interval(left=0, right=5)

# 両端を含まない、長さ5日の間隔
interval2 = Interval(left=0, right=5, closed='neither')

# 比較演算子による表現
print(interval1.left <= 0 and interval1.right >= 5)  # True
print(interval2.left < 0 and interval2.right > 5)  # True

contains メソッド

# `contains` メソッドによる表現
print(0 in interval1)  # True
print(0 in interval2)  # False

自作関数

def is_closed_interval(interval):
  """
  間隔が閉区間かどうかを判定する関数

  Args:
    interval: pandas.Interval

  Returns:
    bool: True if the interval is closed, False otherwise
  """
  return interval.left <= interval.right

# 自作関数による表現
print(is_closed_interval(interval1))  # True
print(is_closed_interval(interval2))  # False

まとめ

pandas.Interval.closed 属性は、間隔の閉じ方を定義する便利な属性ですが、状況に応じて上記のような代替方法も検討してみてください。