# 機能設計書 47-coalesce

## 概要

本ドキュメントは、dplyrパッケージの`coalesce()`関数の機能設計について記述する。`coalesce()`は複数のベクトルから最初の非欠損値を取得する関数であり、SQLのCOALESCE関数に相当する。

### 本機能の処理概要

`coalesce()`は、複数のベクトルを受け取り、各位置について最初の非欠損値（`NA`でない値）を返す関数である。これはSQLの`COALESCE`関数と同じ動作であり、欠損値を別の値で埋めるために広く使用される。入力ベクトルは共通型にキャストされ、共通サイズにリサイクルされる。

**業務上の目的・背景**：データ分析において、欠損値（`NA`）を処理する必要がある場面は非常に多い。欠損値を単一の代替値で置換する場合や、複数のデータソースから最初に有効な値を取得する場合に`coalesce()`は非常に有用である。例えば、主データソースに欠損がある場合にバックアップデータソースから値を取得するといったユースケースに適している。

**機能の利用シーン**：
- 欠損値を特定の値（例：0）で置換する
- 複数のデータソースから最初の有効な値を取得する
- データの統合時に優先順位に基づいて値を選択する
- デフォルト値の設定

**主要な処理内容**：
1. 入力ベクトルを共通型にキャストする
2. 入力ベクトルを共通サイズにリサイクルする
3. 各位置について、最初の非欠損値を選択する
4. 結果ベクトルを返す

**関連システム・外部連携**：vctrsパッケージの`vec_case_when()`を内部で使用する。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 該当なし | - | 本プロジェクトはRライブラリであり、ユーザーインターフェース画面は存在しない |

## 機能種別

計算処理 / データ変換 / 欠損値処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ... | any | Yes | 合体させるベクトル（dynamic-dots） | 少なくとも1つの非NULLベクトルが必要 |
| .ptype | any | No | 出力型を指定するプロトタイプ | 有効な型であること |
| .size | integer | No | 出力サイズを指定 | リサイクル可能なサイズであること |

### 入力データソース

関数の引数として直接渡されるベクトル

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | any | 入力ベクトルの共通型と共通サイズを持つベクトル |

### 出力先

呼び出し元に返される。

## 処理フロー

### 処理シーケンス

```
1. 入力の検証
   └─ ...が空でないことを確認
   └─ 少なくとも1つの非NULLベクトルがあることを確認
   └─ すべての要素がベクトルであることを確認
2. 型とサイズの決定
   └─ vec_ptype_common()で共通型を決定
   └─ vec_cast_common()で共通型にキャスト
   └─ vec_size_common()で共通サイズを決定
3. case_when形式への変換
   └─ convert_from_coalesce_to_case_when()で変換
   └─ 最後の要素が非欠損の場合はdefaultとして使用（最適化）
4. vec_case_when()の呼び出し
   └─ conditions = !vec_detect_missing(value)
   └─ 最初の非欠損値を選択
5. 結果ベクトルを返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始: coalesce呼び出し] --> B{...が空か?}
    B -->|Yes| C[エラー: ... can't be empty]
    B -->|No| D{非NULLベクトルがあるか?}
    D -->|No| E[エラー: must contain at least 1 non-NULL value]
    D -->|Yes| F[共通型にキャスト]
    F --> G[共通サイズを決定]
    G --> H[case_when形式に変換]
    H --> I{最後の要素が非欠損か?}
    I -->|Yes| J[defaultとして使用]
    I -->|No| K[すべてをvaluesに含める]
    J --> L[vec_case_when を呼び出し]
    K --> L
    L --> M[各位置で最初の非欠損値を選択]
    M --> N[結果ベクトルを返す]
    C --> O[終了]
    E --> O
    N --> O
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-47-01 | 型共通化 | すべての入力ベクトルは共通型にキャストされる | 常に適用 |
| BR-47-02 | サイズリサイクル | すべての入力ベクトルは共通サイズにリサイクルされる | 常に適用 |
| BR-47-03 | 順次評価 | 最初の非欠損値が使用される（左から右の順） | 常に適用 |
| BR-47-04 | NULL無視 | ...内のNULLは無視される | 常に適用 |
| BR-47-05 | リスト内NULL | リスト内のNULLは欠損値として扱われる | リストを処理する場合 |

### 計算ロジック

```
for each i in 1:size:
    for each j in 1:n_vectors:
        if !is.na(vectors[j][i]):
            result[i] = vectors[j][i]
            break
    if no non-missing value found:
        result[i] = NA
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | 本関数はインメモリ操作のみでデータベース操作を行わない |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 引数エラー | ...が空の場合 | 少なくとも1つのベクトルを渡す |
| - | 引数エラー | すべてがNULLの場合 | 非NULLベクトルを含める |
| - | 型エラー | 共通型がない場合 | 互換性のある型を使用する |
| - | サイズエラー | リサイクルが不可能な場合 | 適切なサイズのベクトルを使用する |

### リトライ仕様

リトライは不要（即座にエラーを返す）

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

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

## パフォーマンス要件

- 最後の要素が非欠損の場合はdefaultとして使用する最適化を適用
- vctrsの効率的な実装を活用すること

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

特になし

## 備考

- `coalesce(x, 0)`は`replace_values(x, NA ~ 0)`と同等
- 単一値の置換には`replace_values()`も使用可能
- リスト内の`NULL`は欠損値として扱われる

---

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

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

### 推奨読解順序

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

`coalesce()`は内部で`vec_case_when()`を使用して効率的に実装されている。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | coalesce.R | `R/coalesce.R` | `coalesce()`関数の全体構造を理解する |

**読解のコツ**: `coalesce()`は`case_when()`形式に変換されて処理される。最適化として、最後の要素が非欠損の場合はdefaultとして使用される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | coalesce.R | `R/coalesce.R` | 69-111行目の`coalesce()`関数定義 |

**主要処理フロー**:
1. **70行目**: `list2(...)`で入力をリスト化
2. **72-77行目**: 入力の検証（空チェック、非NULLチェック）
3. **82-92行目**: 型とサイズの検証・設定
4. **96行目**: `convert_from_coalesce_to_case_when()`で変換
5. **100-102行目**: `!vec_detect_missing()`で条件を生成
6. **104-110行目**: `vec_case_when()`を呼び出し

#### Step 3: 変換ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | coalesce.R | `R/coalesce.R` | 135-186行目の`convert_from_coalesce_to_case_when()`関数 |

**読解のコツ**: この関数は最適化のために、最後の要素が非欠損の場合はdefaultとして分離する。これにより、リサイクルとmissing検出のコストを削減できる。

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

```
coalesce(..., .ptype, .size)
    │
    ├─ list2(...) [入力をリスト化]
    │
    ├─ list_check_all_vectors() [ベクトル検証]
    │
    ├─ vec_ptype_common() [共通型決定]
    │
    ├─ vec_cast_common() [共通型にキャスト]
    │
    ├─ vec_size_common() [共通サイズ決定]
    │
    ├─ convert_from_coalesce_to_case_when()
    │      ├─ NULLを削除
    │      └─ 最後の要素をdefaultに昇格（可能な場合）
    │
    ├─ map(!vec_detect_missing) [条件生成]
    │
    └─ vec_case_when()
           └─ 最初の非欠損値を選択
```

### データフロー図

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

...ベクトル        ───▶  list2()でリスト化           ───▶  argsリスト

argsリスト         ───▶  vec_cast_common()で         ───▶  共通型args
                         共通型にキャスト

共通型args         ───▶  convert_from_coalesce...()  ───▶  values + default
                         で変換

values             ───▶  !vec_detect_missing()で     ───▶  conditions
                         条件生成

conditions +       ───▶  vec_case_when()で           ───▶  結果ベクトル
  values + default       最初の非欠損値を選択
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| coalesce.R | `R/coalesce.R` | ソース | `coalesce()`関数の実装 |
| na-if.R | `R/na-if.R` | ソース | `na_if()`関数（逆操作） |
| recode-values.R | `R/recode-values.R` | ソース | `replace_values()`関数（NA置換の代替） |
