# 機能設計書 68-Vec\unique_by

## 概要

本ドキュメントは、Hack Standard Library（HSL）の`Vec\unique_by`関数の機能設計を記載する。この関数は、スカラー関数を使用して要素のユニーク性を判定し、重複を除去した新しいvecを返す。

### 本機能の処理概要

**業務上の目的・背景**：
オブジェクトや複合データ構造など、直接arraykey型として比較できない要素の重複除去が必要な場面がある。例えば、ユーザーオブジェクトをIDで重複除去、商品を商品コードで重複除去、イベントをタイムスタンプで重複除去などに使用される。この関数は、任意の型の要素に対してスカラー関数で同一性を判定し、重複を除去する。

**機能の利用シーン**：
- オブジェクトの特定プロパティによる重複除去
- 複合キーによるユニーク化
- 正規化された文字列での重複判定（大文字小文字無視など）
- ハッシュ値による重複検出
- カスタムロジックでの同一性判定

**主要な処理内容**：
1. スカラー関数を使用して各要素からarraykeyを生成
2. Dict\from_valuesを使用して、スカラーキーをキーとするdictを構築
3. 同じスカラーキーを持つ要素は後のものが優先される
4. dictの値をvecに変換して返却

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

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

## 関連画面

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

## 機能種別

計算処理 / データ変換

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | Traversable<Tv> | Yes | 重複を除去する対象のコレクション | なし |
| $scalar_func | (function(Tv)[_]: Ts as arraykey) | Yes | 各要素からユニーク性判定用のスカラーキーを生成する関数 | なし |

### 入力データソース

プログラムコードからの直接呼び出し。任意の型の要素を持つvec、keyset、Set、Vectorなど、Traversableを実装する型を受け付ける。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | vec<Tv> | スカラー関数の結果が一意の要素のみを含むvec。重複スカラーキーの場合は後の要素が保持される |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. Dict\from_valuesを使用してdict構築
   └─ Dict\from_values($traversable, $scalar_func)
   └─ スカラーキー → 元の値 のマッピングを作成
   └─ 同じスカラーキーは後の値で上書き

2. dictの値をvecに変換
   └─ vec(Dict\from_values(...))

3. 結果vecを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Dict\from_values実行]
    B --> C[スカラーキーで重複除去]
    C --> D[後の値が優先で保持]
    D --> E[vec変換]
    E --> F[結果vecを返却]
    F --> G[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 後の要素優先 | 同じスカラーキーを持つ要素のうち、後に出現したものが保持される | 重複時 |
| BR-02 | スカラー型制約 | スカラー関数の戻り値はarraykey型（int または string）でなければならない | 常時 |
| BR-03 | 元の値保持 | 結果には変換前の元の値が含まれる（スカラー値ではない） | 常時 |

### 計算ロジック

スカラー関数適用: element → scalar_func(element) → arraykeyキー
重複判定: キーが同じ要素は1つのみ保持（後のもの）

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

- 時間計算量: O(n * s)、nは入力コレクションのサイズ、sはスカラー関数の計算量
- 空間計算量: O(n)、最悪の場合すべての要素がユニーク

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

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

## 備考

- arraykey要素の重複除去には単純な`Vec\unique`を使用可能
- 最初の出現を保持したい場合は、事前に配列を逆順にする等の対応が必要
- スカラー関数は各要素に対して1回のみ呼び出される（効率的）

---

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

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

### 推奨読解順序

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

Dict\from_valuesの動作とスカラー関数の役割を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | select.php | `src/vec/select.php` | unique_by関数の定義場所と型シグネチャ |

**読解のコツ**: `Dict\from_values`は、コレクションの各要素を値とし、スカラー関数の結果をキーとするdictを作成する。同じキーの場合は後の値で上書きされる。

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

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

**主要処理フロー**:
1. **293-296行目**: 関数シグネチャ - Traversableとスカラー関数を受け取る
2. **297行目**: Dict\from_valuesでスカラーキー→値のdictを構築
3. **297行目**: vecに変換して返却

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | - | Dict\from_values | スカラーキーをキーとするdict構築 |
| 3-2 | select.php | `src/vec/select.php` | unique関数（278-280行目）との比較 |

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

```
Vec\unique_by()
    │
    ├─ Dict\from_values()
    │      └─ スカラーキー→値のdict構築
    │      └─ 同じキーは後の値で上書き
    │
    └─ vec() (組み込み)
           └─ dictの値をvecに変換
```

### データフロー図

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

Traversable<Tv>     ───▶  scalar_func適用  ───────────▶
$scalar_func        ───▶                                   vec<Tv>
                              │                           (ユニーク)
                              ▼
                         Dict\from_values
                         {key: value}
                              │
                              ▼
                         vec変換（値のみ）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.php | `src/vec/select.php` | ソース | unique_by関数の実装 |
| VecSelectTest.php | `tests/vec/VecSelectTest.php` | テスト | unique_byのユニットテスト（552-595行目） |
