# 機能設計書 64-near

## 概要

本ドキュメントは、dplyrパッケージの`near`関数の機能設計について記述する。`near`は2つの数値ベクトルが許容誤差内で近似しているかを判定する関数である。

### 本機能の処理概要

`near`関数は、2つの数値ベクトルの各要素を比較し、その差が指定された許容誤差（tolerance）以内であればTRUEを返す。これは浮動小数点数の比較において`==`演算子を使用する代わりに使用すべき関数である。

**業務上の目的・背景**：浮動小数点数の計算では、計算機の内部表現の制約により、数学的に等しいはずの値が厳密には等しくならないことがある。例えば`sqrt(2)^2 == 2`はFALSEを返す。このような問題を回避するため、許容誤差を考慮した比較が必要となる。`near`関数はこの一般的な問題に対する安全な解決策を提供する。

**機能の利用シーン**：
- 浮動小数点数の等価性判定が必要な場合
- 数値計算結果の検証時
- `filter()`内で数値の近似一致をフィルタリングする場合
- 単体テストでの数値比較時

**主要な処理内容**：
1. 2つの数値ベクトル`x`と`y`を受け取る
2. 許容誤差`tol`を設定（デフォルトは機械イプシロンの平方根）
3. `|x - y| < tol`を計算して論理ベクトルを返す

**関連システム・外部連携**：特になし。基本的なR演算のみを使用。

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

## 関連画面

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

## 機能種別

計算処理 / 比較演算 / バリデーション

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| x | numeric | Yes | 比較対象の数値ベクトル | 数値型であること |
| y | numeric | Yes | 比較対象の数値ベクトル | 数値型であること |
| tol | numeric | No | 許容誤差（デフォルト: `.Machine$double.eps^0.5`） | 正の数値であること |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | logical | 各要素の差が許容誤差以内かの論理ベクトル |

### 出力先

関数の戻り値として返却

## 処理フロー

### 処理シーケンス

```
1. 引数の受け取り
   └─ x, y: 数値ベクトル
   └─ tol: 許容誤差（デフォルト: .Machine$double.eps^0.5）

2. 差の計算
   └─ x - y: 要素ごとの差を計算

3. 絶対値の計算
   └─ abs(x - y): 差の絶対値を計算

4. 許容誤差との比較
   └─ abs(x - y) < tol: 許容誤差未満かを判定

5. 結果の返却
   └─ 論理ベクトルを返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[x, y, tol受け取り]
    B --> C[x - y 計算]
    C --> D[abs差の絶対値]
    D --> E{abs < tol?}
    E -->|Yes| F[TRUE]
    E -->|No| G[FALSE]
    F --> H[結果返却]
    G --> H
    H --> I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-64-01 | 許容誤差比較 | `abs(x - y) < tol`で近似判定 | 常時 |
| BR-64-02 | デフォルト許容誤差 | `.Machine$double.eps^0.5`（約1.49e-8） | tol未指定時 |
| BR-64-03 | 要素ごと比較 | ベクトルの各要素を個別に比較 | 常時 |

### 計算ロジック

```
near(x, y, tol) は以下と同等:
  abs(x - y) < tol

デフォルトのtol:
  .Machine$double.eps^0.5 ≈ 1.490116e-08

例:
  sqrt(2)^2 == 2       # FALSE（浮動小数点誤差のため）
  near(sqrt(2)^2, 2)   # TRUE（許容誤差内）
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 型エラー | 数値以外が渡された場合 | 数値に変換する |

### リトライ仕様

該当なし

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

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

## パフォーマンス要件

基本的なベクトル演算のみを使用しており、非常に効率的に動作する。

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

特になし

## 備考

- 浮動小数点数の比較では`==`ではなく`near()`を使用することを推奨
- `filter()`のドキュメントでも`near()`の使用が推奨されている
- テスト関数`testthat::expect_equal()`も同様の許容誤差比較を内部で使用

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: `tol`のデフォルト値`.Machine$double.eps^0.5`は機械イプシロン（倍精度浮動小数点数で表現可能な最小の差）の平方根である。

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

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

**主要処理フロー**:
1. **14行目**: `abs(x - y) < tol` - 唯一の処理行

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

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

**主要ポイント**:
- **11-12行目**: 使用例（sqrt(2)^2とnearの比較）
- **test-near.R 1-3行目**: 基本的なテストケース

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

```
near(x, y, tol)
    │
    ├─ x - y          [base R]
    │
    ├─ abs()          [base R]
    │
    └─ < tol          [base R]
```

### データフロー図

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

  x ─────┐
         │
         ├──▶ x - y ──▶ abs() ──▶ < tol ──▶ 論理ベクトル
         │
  y ─────┘

tol ─────────────────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| near.R | `R/near.R` | ソース | near関数の実装 |
| test-near.R | `tests/testthat/test-near.R` | テスト | nearのユニットテスト |
| filter.R | `R/filter.R` | ソース | nearへの言及（ドキュメント） |
