# 機能設計書 95-Keyset\filter_with_key

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `HH\Lib\Keyset\filter_with_key` 関数の機能設計について記述する。この関数は、キーと値の両方を使用する述語関数がtrueを返す要素のみを含む新しいkeysetを返す機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：
コレクションのフィルタリング処理において、値だけでなくキー（インデックスやキー名）も条件判定に使用したい場合がある。本機能は、KeyedTraversableの各要素に対してキーと値の両方を述語関数に渡し、条件に合致する要素のみをkeysetとして返す。これにより、位置ベースのフィルタリング（偶数番目の要素のみ）やキーと値の複合条件によるフィルタリングが可能になる。

**機能の利用シーン**：
- 偶数インデックスの要素のみを抽出する際
- キー名が特定のパターンに合致する要素を取得する際
- キーと値の組み合わせで条件判定が必要な際
- 辞書形式データの条件付きフィルタリング

**主要な処理内容**：
1. KeyedTraversableを走査
2. 各要素に対してキーと値を述語関数に渡す
3. 述語がtrueを返した場合、値をkeysetに追加
4. 結果のkeysetを返却

**関連システム・外部連携**：
- `Keyset\filter`の拡張版として位置づけられる
- KeyedTraversableインターフェースを実装したコレクションに対応

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

## 関連画面

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

## 機能種別

計算処理（フィルタリング）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | KeyedTraversable<Tk, Tv> | Yes | フィルタリング対象のコレクション | Tvはarraykey制約 |
| $predicate | (function(Tk, Tv)[_]: bool) | Yes | キーと値を受け取る述語関数 | - |

### 入力データソース

関数呼び出し時の引数として渡されるKeyedTraversableインスタンスと述語関数。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | keyset<Tv> | 述語がtrueを返した要素の値のkeyset |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 結果用keysetを初期化
2. KeyedTraversableを走査
   └─ 各要素のキーと値を取得
   └─ 述語関数にキーと値を渡す
   └─ trueを返した場合、値を結果keysetに追加
3. 結果返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[result = keyset[]]
    B --> C{KeyedTraversable走査}
    C --> D[key, value = 現在の要素]
    D --> E{$predicate(key, value)?}
    E -->|Yes| F[result[] = value]
    E -->|No| G[次の要素へ]
    F --> G
    G --> C
    C -->|完了| H[resultを返却]
    H --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 必須述語 | 述語関数は必須パラメータである | 関数呼び出し時 |
| BR-02 | 値の収集 | 結果にはキーではなく値が収集される | 常時 |
| BR-03 | 重複排除 | keysetの特性により、結果に重複は含まれない | 常時 |

### 計算ロジック

- 時間計算量: O(n * p) - nはTraversableのサイズ、pは述語の計算量
- 空間計算量: O(n)

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | TypeError | arraykeyでない型の値を含むTraversableを渡した場合 | int/string型のみ使用 |
| - | (述語内例外) | 述語関数内で例外がスローされた場合 | 述語関数の実装を確認 |

### リトライ仕様

該当なし。純粋関数であり、同じ入力に対しては常に同じ結果を返す（述語が純粋な場合）。

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

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

## パフォーマンス要件

- 時間計算量: O(n * p)
- 空間計算量: O(n)

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

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

## 備考

- `Keyset\filter`と異なり、述語関数は必須パラメータ
- 述語関数はキーと値の両方を引数として受け取る
- 結果のkeysetには値のみが含まれる（キーは含まれない）

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | (Hack言語仕様) | - | KeyedTraversableはキーと値のペアを持つコレクションインターフェース |

**読解のコツ**: KeyedTraversableはforeachで`$key => $value`として走査可能なインターフェース。dict、vec、Map、Vectorなどが実装している。

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

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

**主要処理フロー**:
1. **125-132行目**: ドキュメントコメント - 機能の説明
2. **133-137行目**: 関数シグネチャ - Tk（キー型）とTv（値型）のジェネリクス
3. **138行目**: 空のkeyset初期化
4. **139-143行目**: foreachで走査、述語にキーと値を渡す
5. **144行目**: 結果を返却

#### Step 3: 関連関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | select.php | `src/keyset/select.php` | filter関数との比較 |

**主要処理フロー**:
- **92-104行目**: filter関数 - 値のみを使用するフィルタリング

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

```
Keyset\filter_with_key($traversable, $predicate)
    │
    └─ foreach ($traversable as $key => $value)  [要素走査]
           │
           ├─ $predicate($key, $value)  [述語適用]
           │
           └─ $result[] = $value  [keyset追加]
```

### データフロー図

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

KeyedTraversable<Tk, Tv> ───▶ 走査 ──▶ 述語適用 ──▶ keyset<Tv>
                                    │       (key, value)
$predicate ─────────────────────────┘
```

### 関連ファイル一覧

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