# 機能設計書 65-desc

## 概要

本ドキュメントは、dplyrパッケージの`desc`関数の機能設計について記述する。`desc`は降順ソート用にベクトルを変換する関数である。

### 本機能の処理概要

`desc`関数は、ベクトルを降順でソートされるように変換する。これは`arrange()`関数内で列を降順にソートするために使用される。内部的には`-xtfrm(x)`を計算し、ソート順序を反転させる。

**業務上の目的・背景**：データの並び替えにおいて、昇順だけでなく降順で並び替えたい場合が非常に多い。例えば、売上の大きい順、日付の新しい順などのソートが必要となる。`desc`関数は`arrange()`と組み合わせて、直感的な記法で降順ソートを可能にする。

**機能の利用シーン**：
- `arrange()`内で列を降順にソートする場合
- 最大値から順に並べたい場合
- 日付の新しい順に並べたい場合
- 因子（factor）を逆順に並べたい場合

**主要な処理内容**：
1. 入力ベクトル`x`を受け取る
2. `obj_check_vector(x)`でベクトルであることを確認
3. `xtfrm(x)`でソート用の数値インデックスを取得
4. 符号を反転（`-`）して降順にする
5. 変換後のベクトルを返す

**関連システム・外部連携**：vctrsパッケージの`obj_check_vector`関数に依存している。

**権限による制御**：特に権限による制御は行われない。

## 関連画面

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

## 機能種別

計算処理 / ソート補助

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| x | vector | Yes | 変換対象のベクトル | ベクトル型であること |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | numeric | 降順ソート用に変換された数値ベクトル |

### 出力先

関数の戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. 引数の検証
   └─ obj_check_vector(x): ベクトル型であることを確認

2. ソートインデックスの取得
   └─ xtfrm(x): ソート用の数値インデックスを計算

3. 符号の反転
   └─ -xtfrm(x): 符号を反転して降順にする

4. 結果の返却
   └─ 変換後の数値ベクトルを返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[obj_check_vector x]
    B --> C{ベクトル?}
    C -->|Yes| D[xtfrm x]
    C -->|No| E[エラー]
    D --> F[符号反転 -]
    F --> G[結果返却]
    G --> H[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-65-01 | ベクトル検証 | 入力はベクトル型である必要がある | 常時 |
| BR-65-02 | ソート反転 | xtfrm()の結果を符号反転して降順にする | 常時 |
| BR-65-03 | 汎用性 | 数値、文字列、因子、日付など様々な型に対応 | 常時 |

### 計算ロジック

```
desc(x) は以下と同等:
  -xtfrm(x)

xtfrm()関数:
  - ベクトルを数値インデックスに変換
  - order()やsort()が内部で使用するのと同じ

例:
  desc(1:10)                    # -1, -2, -3, ..., -10
  desc(factor(letters))         # 因子を逆順にする
  desc(as.Date("1910/1/1"))     # 日付を逆順にする
```

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

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

該当なし（本関数はデータベース操作を行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 型エラー | ベクトル以外が渡された場合（例: 関数） | ベクトルに変換する |

### リトライ仕様

該当なし

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

該当なし（本関数はトランザクション処理を行わない）

## パフォーマンス要件

`xtfrm()`はベクトル化された演算であり、大規模データでも効率的に動作する。

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

特になし

## 備考

- `arrange(desc(x))`で列xを降順にソートできる
- 複数列でのソートでは、各列ごとに`desc()`を指定可能
- SQLの`ORDER BY column DESC`に相当する機能を提供

---

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

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

### 推奨読解順序

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

本関数は非常にシンプルで、特別なデータ構造を持たない。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | desc.R | `R/desc.R` | 関数シグネチャ（16行目） |

**読解のコツ**: `xtfrm()`はRの基本関数で、オブジェクトを順序付け可能な整数ベクトルに変換する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | desc.R | `R/desc.R` | `desc`関数本体（16-19行目） |

**主要処理フロー**:
1. **17行目**: `obj_check_vector(x)` - ベクトル型の検証
2. **18行目**: `-xtfrm(x)` - ソートインデックスの符号反転

#### Step 3: ドキュメントと使用例を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | desc.R | `R/desc.R` | ドキュメント（1-15行目） |
| 3-2 | test-desc.R | `tests/testthat/test-desc.R` | テストケース |

**主要ポイント**:
- **9-10行目**: 基本的な使用例
- **12-13行目**: 日付での使用例
- **15行目**: arrange()との組み合わせ例

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

```
desc(x)
    │
    ├─ obj_check_vector(x)    [vctrs]
    │      └─ ベクトル型検証
    │
    └─ -xtfrm(x)              [base R]
           └─ ソート用数値への変換と符号反転
```

### データフロー図

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

  x ──────▶ obj_check_vector ──▶ xtfrm(x) ──▶ -（符号反転）──▶ 数値ベクトル
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| desc.R | `R/desc.R` | ソース | desc関数の実装 |
| test-desc.R | `tests/testthat/test-desc.R` | テスト | descのユニットテスト |
| arrange.R | `R/arrange.R` | ソース | descの主な使用先 |
