# 機能設計書 61-Vec\filter_with_key

## 概要

本ドキュメントは、Hack Standard Library（HSL）の`Vec\filter_with_key`関数の機能設計を記載する。この関数は、KeyedTraversable（キー付きトラバース可能オブジェクト）に対して、キーと値の両方を受け取る述語関数を適用し、条件を満たす値のみを含む新しいvecを返す。

### 本機能の処理概要

**業務上の目的・背景**：
コレクション操作において、要素の値だけでなくインデックスや連想キーに基づいたフィルタリングが必要な場面は多い。例えば、偶数インデックスの要素のみを抽出したり、特定のキー範囲の要素を選択したりする場合に、この関数が有用である。通常の`Vec\filter`関数は値のみを述語に渡すが、`filter_with_key`はキーも渡すことで、より柔軟なフィルタリングを可能にする。

**機能の利用シーン**：
- 配列のインデックスに基づくフィルタリング（例：偶数インデックスのみ抽出）
- 辞書型データの特定キーに関連する値のみを抽出
- ページネーション処理での特定範囲の要素抽出
- ログデータの特定タイムスタンプ（キー）に基づくフィルタリング

**主要な処理内容**：
1. KeyedTraversableを受け取り、foreachでキーと値のペアを反復処理
2. 各キー・値ペアに対して述語関数を適用
3. 述語関数がtrueを返した場合のみ、値を結果vecに追加
4. 新しいvecを返却（キーは保持されず、値のみが連続インデックスで格納）

**関連システム・外部連携**：
外部システムとの連携はない。純粋な関数型ユーティリティとして動作する。

**権限による制御**：
権限による制御は存在しない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本ライブラリはUIを持たないため該当なし |

## 機能種別

計算処理 / データ変換

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | KeyedTraversable<Tk, Tv> | Yes | フィルタリング対象のキー付きコレクション | なし（空コレクションも許容） |
| $predicate | (function(Tk, Tv)[_]: bool) | Yes | キーと値を受け取り、要素を含めるかどうかを判定する述語関数 | なし |

### 入力データソース

プログラムコードからの直接呼び出し。vec、dict、Map、Vectorなど、KeyedTraversableを実装する任意のコレクション型を受け付ける。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | vec<Tv> | 述語関数がtrueを返した要素の値のみを含むvec。元のキーは保持されない |

### 出力先

呼び出し元への戻り値として返却。

## 処理フロー

### 処理シーケンス

```
1. 空の結果vec（$result）を初期化
   └─ $result = vec[]

2. 入力のKeyedTraversableをforeachで反復
   └─ foreach ($traversable as $key => $value)

3. 各要素に対して述語関数を適用
   └─ $predicate($key, $value)の評価

4. 述語がtrueの場合、値を結果vecに追加
   └─ $result[] = $value

5. 反復完了後、結果vecを返却
   └─ return $result
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[結果vec初期化]
    B --> C{traversableに次の要素があるか}
    C -->|Yes| D[キーと値を取得]
    D --> E{predicate(key, value) == true?}
    E -->|Yes| F[値を結果vecに追加]
    E -->|No| C
    F --> C
    C -->|No| G[結果vecを返却]
    G --> H[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 値のみ保持 | フィルタリング後のvecには元のキーは含まれず、値のみが連続した整数インデックスで格納される | 常時 |
| BR-02 | 順序保持 | 元のコレクションの走査順序が結果vecでも保持される | 常時 |
| BR-03 | 述語必須 | Vec\filterと異なり、述語関数は必須パラメータである | 常時 |

### 計算ロジック

述語関数の適用は各要素に対して1回ずつ行われ、結果はbool値として評価される。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベース操作なし |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 型エラー | 述語関数がbool以外を返した場合 | 型チェッカーが静的に検出 |

### リトライ仕様

リトライは不要（純粋関数であり、同じ入力に対して常に同じ結果を返す）。

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

トランザクション管理は不要（メモリ内処理のみ）。

## パフォーマンス要件

- 時間計算量: O(n * p)、nは入力コレクションのサイズ、pは述語関数の計算量
- 空間計算量: O(n)、最悪の場合すべての要素が条件を満たす

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

- 純粋関数であり、外部リソースへのアクセスは行わない
- 述語関数に渡されるデータの機密性に応じた取り扱いが必要

## 備考

- `Vec\filter`と異なり、デフォルトの述語は存在しない（述語関数は必須）
- 非同期版として`Vec\filter_with_key_async`は現時点では提供されていない

---

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

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

### 推奨読解順序

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

Hack言語のKeyedTraversableインターフェースとvec型の基本を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | select.php | `src/vec/select.php` | Vec名前空間のフィルタリング関連関数群の定義場所 |

**読解のコツ**: Hackの`KeyedTraversable<Tk, Tv>`は、キーと値のペアで反復可能なコレクションを表すジェネリックインターフェース。vec、dict、Map、Vectorなど多くの型がこれを実装している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | select.php | `src/vec/select.php` | filter_with_key関数の実装（148-159行目） |

**主要処理フロー**:
1. **148-151行目**: 関数シグネチャ - KeyedTraversableと述語関数を受け取る
2. **152行目**: 空の結果vec初期化
3. **153-157行目**: foreachループでキー・値ペアを反復し、述語判定
4. **158行目**: 結果vecを返却

#### Step 3: 関連するフィルタリング関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | select.php | `src/vec/select.php` | filter関数（108-120行目）との比較 |
| 3-2 | select.php | `src/vec/select.php` | filter_nulls関数（129-137行目）との比較 |

**主要処理フロー**:
- **108-120行目**: filter関数は値のみを述語に渡す。デフォルト述語としてboolval変換をサポート
- **129-137行目**: filter_nullsはnull値を除外する特化版

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

```
Vec\filter_with_key()
    │
    ├─ (ユーザー提供の述語関数)
    │      └─ キーと値を受け取りboolを返す
    │
    └─ 結果vec構築
           └─ 条件を満たす値のみを追加
```

### データフロー図

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

KeyedTraversable    ───▶  foreach反復処理  ───────────▶   vec<Tv>
  <Tk, Tv>                      │
                                ▼
                         述語関数適用
                         predicate(key, value)
                                │
                                ▼
                         true: 値を結果に追加
                         false: スキップ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.php | `src/vec/select.php` | ソース | filter_with_key関数の実装 |
| private.php | `src/private.php` | ソース | boolval等のプライベートユーティリティ（filter関数で使用） |
| VecSelectTest.php | `tests/vec/VecSelectTest.php` | テスト | filter_with_keyのユニットテスト（219-259行目） |
