# 機能設計書 93-Keyset\filter

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：
データ処理において、特定の条件に合致する要素だけを抽出するフィルタリング処理は最も基本的かつ頻繁に使用される操作の一つである。本機能は、任意の条件（述語関数）に基づいてコレクションから要素を選択し、一意な値の集合として返す。これにより、検索条件に合致するデータの抽出、バリデーション済みデータの取得、条件付きデータ処理などを関数型のアプローチで実装できる。

**機能の利用シーン**：
- 有効なユーザーIDのみを抽出する際
- 特定の条件を満たす商品コードを取得する際
- 処理対象となるキーのみをフィルタリングする際
- 値がtruthyな要素のみを取得する際（デフォルト動作）

**主要な処理内容**：
1. 述語関数が指定されていない場合はデフォルトのboolval変換を使用
2. Traversableを走査し、各要素に述語関数を適用
3. 述語がtrueを返した要素をkeysetに追加
4. 結果のkeysetを返却

**関連システム・外部連携**：
- 内部で`HH\Lib\_Private\boolval`関数を使用（デフォルト述語として）
- null値のフィルタリングには`Keyset\filter_nulls`を使用することを推奨
- キーも使用する場合は`Keyset\filter_with_key`を使用

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

## 関連画面

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

## 機能種別

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | Traversable<Tv> | Yes | フィルタリング対象のコレクション | Tvはarraykey制約 |
| $value_predicate | ?(function(Tv)[_]: bool) | No | フィルタリング条件の述語関数 | nullの場合はbool変換 |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 述語関数のデフォルト設定
   └─ $value_predicateがnullの場合、boolvalをデフォルトに設定
2. 結果用keysetを初期化
3. Traversableを走査
   └─ 各要素に述語関数を適用
   └─ trueを返した場合、結果keysetに追加
4. 結果返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{$value_predicate is null?}
    B -->|Yes| C[$value_predicate = boolval]
    B -->|No| D[そのまま使用]
    C --> E[result = keyset[]]
    D --> E
    E --> F{traversable走査}
    F --> G[value = 現在の要素]
    G --> H{$value_predicate(value)?}
    H -->|Yes| I[result[] = value]
    H -->|No| J[次の要素へ]
    I --> J
    J --> F
    F -->|完了| K[resultを返却]
    K --> L[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | デフォルト述語 | 述語が指定されない場合、bool変換（boolval）を使用 | $value_predicate === null |
| BR-02 | 重複排除 | keysetの特性により、結果に重複は含まれない | 常時 |
| BR-03 | 順序非保証 | keysetは順序を保持するが、同一値の重複は排除される | 常時 |

### 計算ロジック

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

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- 述語関数のコンテキスト（capability）は関数全体に伝播する（`[ctx $value_predicate]`）
- null値を除外する場合は、より型安全な`Keyset\filter_nulls`の使用を推奨
- PHPのarray_filterに類似した機能だが、型安全性が向上している

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | (Hack言語仕様) | - | keysetは一意のarraykey（int/string）のみを格納する集合型 |
| 1-2 | private.php | `src/private.php` | boolval関数の実装 |

**読解のコツ**: Hackのコンテキスト制約`[ctx $value_predicate]`は、関数が引数として渡された関数のコンテキストを継承することを示す。

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

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

**主要処理フロー**:
1. **83-91行目**: ドキュメントコメント - 機能の説明
2. **92-95行目**: 関数シグネチャ - オプショナルな述語関数
3. **96行目**: デフォルト述語の設定（null合体演算子）
4. **97行目**: 空のkeyset初期化
5. **98-102行目**: foreachで走査、述語がtrueなら追加
6. **103行目**: 結果を返却

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

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

**主要処理フロー**:
- **49-51行目** (private.php): boolval - (bool)キャストで値を変換
- **106-123行目** (select.php): filter_nulls - null以外を返す
- **125-145行目** (select.php): filter_with_key - キーも使用する版

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

```
Keyset\filter($traversable, $value_predicate)
    │
    ├─ $value_predicate ?? boolval<>  [デフォルト述語設定]
    │
    └─ foreach ($traversable as $value)  [要素走査]
           │
           ├─ $value_predicate($value)  [述語適用]
           │
           └─ $result[] = $value  [keyset追加]
```

### データフロー図

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

$traversable ─────────▶ 走査 ──▶ 述語適用 ──▶ keyset<Tv>
                              │
$value_predicate ────────────┘
(or boolval)
```

### 関連ファイル一覧

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