# 機能設計書 91-Keyset\diff

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `HH\Lib\Keyset\diff` 関数の機能設計について記述する。この関数は、複数のTraversableから差分を取得し、最初のTraversableにのみ存在する要素をkeysetとして返す機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：
コレクション操作において、あるデータセットから別のデータセットに含まれる要素を除外する処理は、データの重複排除、フィルタリング、集合演算など多くの場面で必要とされる。本機能は、配列やコレクション間の差分を効率的に計算し、最初のコレクションにのみ存在するユニークな要素を抽出する。これにより、新規追加要素の特定、削除対象の検出、データベース同期処理などの業務ロジックを簡潔に実装できる。

**機能の利用シーン**：
- ユーザーリストから退会済みユーザーIDを除外する際
- 新規登録されたアイテムと既存アイテムの差分を検出する際
- キャッシュの無効化対象を特定する際
- 複数のタグセットから共通でないタグを抽出する際

**主要な処理内容**：
1. 最初のTraversableをkeysetに変換（まだkeysetでない場合）
2. 2番目以降のTraversableを走査し、共通する要素を最初のkeysetから削除
3. 差分計算後のkeysetを返却

**関連システム・外部連携**：
- 内部で`HH\Lib\C\is_empty`と`HH\Lib\C\contains_key`関数を使用
- arraykey制約により、int型とstring型のみを要素として受け付ける

**権限による制御**：
特になし。純粋な計算処理のため、権限による制御は行わない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 画面なし | - | 本プロジェクトはUIを持たないライブラリ |

## 機能種別

計算処理（集合演算）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $first | Traversable<Tv1> | Yes | 差分計算の基準となるコレクション | Tv1はarraykey制約 |
| $second | Traversable<Tv2> | Yes | 除外対象の要素を含むコレクション | Tv2はarraykey制約 |
| ...$rest | Container<Tv2> | No | 追加の除外対象コレクション（可変長引数） | Tv2はarraykey制約 |

### 入力データソース

関数呼び出し時の引数として渡されるTraversable/Containerインスタンス。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | keyset<Tv1> | $firstにのみ存在する要素のkeyset |

### 出力先

関数の戻り値として呼び出し元に返却。

## 処理フロー

### 処理シーケンス

```
1. 入力変換
   └─ $firstがkeysetでなければkeysetに変換
2. 早期リターンチェック
   └─ $firstが空の場合、空のkeysetを返却
3. $secondの走査
   └─ $secondの各要素について、$firstに含まれていれば削除
4. $restの走査
   └─ 各Containerについて、$firstの要素を削除
   └─ 途中で$firstが空になれば早期リターン
5. 結果返却
   └─ 残った$firstを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{$firstはkeyset?}
    B -->|No| C[$firstをkeysetに変換]
    B -->|Yes| D{$firstは空?}
    C --> D
    D -->|Yes| E[空のkeysetを返却]
    D -->|No| F[$secondの各要素を走査]
    F --> G{要素は$firstに存在?}
    G -->|Yes| H[$firstから要素を削除]
    G -->|No| I[次の要素へ]
    H --> I
    I --> J{$secondの走査完了?}
    J -->|No| F
    J -->|Yes| K[$restの各Containerを走査]
    K --> L{$firstは空?}
    L -->|Yes| E
    L -->|No| M[Container内の各要素を走査]
    M --> N{要素は$firstに存在?}
    N -->|Yes| O[$firstから要素を削除]
    N -->|No| P[次の要素へ]
    O --> P
    P --> Q{Container走査完了?}
    Q -->|No| M
    Q -->|Yes| R{$rest走査完了?}
    R -->|No| K
    R -->|Yes| S[$firstを返却]
    E --> T[終了]
    S --> T
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 厳密比較 | 要素の比較は厳密等価（===）で行う | 全ての比較時 |
| BR-02 | 型の厳密性 | int型の2とstring型の'2'は異なる要素として扱う | 全ての比較時 |
| BR-03 | 重複の自動排除 | keysetの特性により、結果に重複は含まれない | 常時 |

### 計算ロジック

差分計算は集合演算の差集合（A - B - C - ...）に相当する。
- 時間計算量: O(n + m) - nは$firstのサイズ、mは$second以降の合計サイズ
- 空間計算量: O(n) - nは$firstのサイズ

## データベース操作仕様

### 操作別データベース影響一覧

該当なし。本機能はインメモリでのコレクション操作のみを行う。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | TypeError | arraykeyでない型の要素を含むTraversableを渡した場合 | 入力データを確認し、int/string型のみを使用 |

### リトライ仕様

該当なし。純粋関数であり、同じ入力に対しては常に同じ結果を返す。

## トランザクション仕様

該当なし。インメモリ操作のみ。

## パフォーマンス要件

- 時間計算量: O(n + m)
- 空間計算量: O(n)
- 早期リターンの最適化により、$firstが空になった時点で処理を終了

## セキュリティ考慮事項

特になし。純粋なデータ変換処理であり、外部リソースへのアクセスは行わない。

## 備考

- 関数は純粋関数（pure function）として実装されており、副作用がない
- コンテキスト制約`[]`により、I/Oや状態変更を行わないことが型システムで保証されている

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

Hackのkeysetとarraykey制約の特性を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | (Hack言語仕様) | - | keysetは一意のarraykey（int/string）のみを格納する集合型 |

**読解のコツ**: Hackのkeysetはイミュータブルな集合型だが、内部的にはローカル変数として変更可能。`unset`操作でその場で要素削除が可能。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | select.php | `src/keyset/select.php` | diff関数の実装本体 |

**主要処理フロー**:
1. **23-27行目**: 関数シグネチャ - ジェネリクスTv1, Tv2とarraykey制約
2. **28-30行目**: $firstがkeysetでなければ変換
3. **31-33行目**: $firstが空なら早期リターン
4. **34-41行目**: $secondの要素を走査し$firstから削除
5. **42-55行目**: $restの各Containerについて同様の処理

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | introspect.php | `src/c/introspect.php` | C\is_empty、C\contains_keyの実装 |

**主要処理フロー**:
- **72-81行目**: C\contains_key - array_key_existsを使用したO(1)の存在確認
- **124-131行目**: C\is_empty - コンテナが空かどうかの判定

### プログラム呼び出し階層図

```
Keyset\diff($first, $second, ...$rest)
    │
    ├─ keyset($first)  [PHP/Hack組み込み: keyset変換]
    │
    ├─ C\is_empty($first)
    │      └─ ConstCollection::isEmpty() または !$container
    │
    ├─ C\contains_key($first, $value)
    │      └─ \array_key_exists($key, $container)
    │
    └─ unset($first[$value])  [要素削除]
```

### データフロー図

```
[入力]                     [処理]                         [出力]

$first (Traversable)  ──▶ keyset変換 ──▶┐
                                        │
$second (Traversable) ──▶ 要素走査 ───▶ 差分計算 ──▶ keyset<Tv1>
                                        │
$rest (Container...) ──▶ 要素走査 ────▶┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.php | `src/keyset/select.php` | ソース | diff関数の実装 |
| introspect.php | `src/c/introspect.php` | ソース | is_empty、contains_key関数 |
| KeysetSelectTest.php | `tests/keyset/KeysetSelectTest.php` | テスト | diff関数のユニットテスト |
