# 機能設計書 140-mean

## 概要

本ドキュメントは、Hack Standard Library (HSL) の Math 名前空間における `mean` 関数の機能設計書である。この関数は、与えられた Container（コンテナ型コレクション）の数値要素の算術平均を計算して返す。

### 本機能の処理概要

**業務上の目的・背景**：
算術平均（arithmetic mean）は統計分析において最も基本的かつ頻繁に使用される統計量の一つである。売上の平均、テストスコアの平均、センサーデータの平均値など、様々なデータ分析場面で必要とされる。`Math\mean` 関数は、Hack 言語において型安全かつ数値的に安定したインターフェースで算術平均の計算を提供する。大きな数値に対してもオーバーフローを回避するアルゴリズムを採用している。

**機能の利用シーン**：
- データ分析における平均値の算出
- レポートや統計サマリーの生成
- パフォーマンスメトリクスの集計
- 品質管理における平均品質スコアの計算
- 機械学習における特徴量の正規化前処理

**主要な処理内容**：
1. Container<num> 型のコレクションを受け取る
2. コレクションの要素数をカウントする
3. 空の場合は null を返す
4. 各要素を要素数で割りながら合計することで、オーバーフローを回避しつつ平均を計算
5. 計算結果（float 型）を返す

**関連システム・外部連携**：
本機能は純粋な統計計算関数であり、外部システムとの連携はない。

**権限による制御**：
本機能は純粋関数（pure function）として実装されており、副作用がなく、権限による実行制御は不要である。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本プロジェクト（Hack Standard Library）はUIを持たないライブラリプロジェクトのため、画面機能マッピングは該当しない |

## 機能種別

計算処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $numbers | Container<num> | Yes | 平均を計算する数値のコンテナ | なし |

### 入力データソース

関数呼び出し時の引数として直接指定される。vec、Vector など Container を実装するコレクションが使用可能（Traversable ではなく Container のみ対応）。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (戻り値) | ?float | コレクション内要素の算術平均、または空の場合は null |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 引数 $numbers を受け取る
   └─ Container<num> 型のコレクション
2. 要素数をカウント
   └─ $count = (float)C\count($numbers)
3. 空コレクションの判定
   ├─ $count === 0.0 の場合
   └─ null を返す
4. 平均値変数を初期化
   └─ $mean = 0.0
5. コレクションを走査して累積計算
   └─ foreach ($numbers as $number)
       └─ $mean += $number / $count
6. 平均値を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B["$count = C\\count($numbers)"]
    B --> C{"$count === 0.0?"}
    C -->|Yes| D[null を返す]
    C -->|No| E["$mean = 0.0"]
    E --> F{$numbers に要素あり?}
    F -->|Yes| G[次の $number を取得]
    G --> H["$mean += $number / $count"]
    H --> F
    F -->|走査完了| I["$mean を返す"]
    D --> J[終了]
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 空コレクション | 空のコレクションに対しては null を返す | $numbers が空の場合 |
| BR-002 | 戻り値の型 | 入力型に関わらず常に float を返す | 常に適用 |
| BR-003 | 純粋関数 | 同じ入力に対して常に同じ出力を返す | 常に適用 |
| BR-004 | オーバーフロー回避 | 各要素を要素数で割ってから合計することでオーバーフローを回避 | 常に適用 |

### 計算ロジック

算術平均の計算式：
- mean = (x1 + x2 + ... + xn) / n
- 実装では: mean = x1/n + x2/n + ... + xn/n（オーバーフロー回避のため）

時間計算量: O(n) - n は要素数
空間計算量: O(1) - 追加のメモリ使用は定数

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

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

本機能はデータベース操作を行わない純粋な計算関数である。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | 本関数はエラーをスローしない | - |

### リトライ仕様

該当なし（エラーが発生しないため）

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

該当なし（データベース操作を行わないため）

## パフォーマンス要件

コレクションを一度だけ走査するため、時間計算量は O(n) である。要素数のカウントに `C\count` を使用しており、これは Container に対して O(1) で動作する。

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

純粋関数として実装されており、副作用がないため、セキュリティ上のリスクはない。

## 備考

- 中央値を求める場合は `Math\median` 関数を使用する
- 合計を求める場合は `Math\sum`（整数）または `Math\sum_float`（浮動小数点）を使用する
- Container<num> を要求するため、Traversable（Iterator など）は直接使用できない
- INT64_MAX のような大きな数値に対してもオーバーフローせずに計算可能

---

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

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

### 推奨読解順序

#### Step 1: mean 関数の実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | containers.php | `src/math/containers.php` | mean 関数の実装（58-75行目）を確認。オーバーフロー回避アルゴリズムを理解する |

**主要処理フロー**:
1. **58-64行目**: 関数のドキュメントコメント - sum, max, min への参照を含む
2. **65行目**: 関数シグネチャ `function mean(Container<num> $numbers)[]: ?float` - Container 型と nullable 戻り値
3. **66行目**: 要素数のカウント `$count = (float)C\count($numbers)`
4. **67-69行目**: 空コレクションの判定と null 返却
5. **70行目**: 平均値変数の初期化 `$mean = 0.0`
6. **71-73行目**: 各要素を要素数で割りながら合計（オーバーフロー回避）
7. **74行目**: 結果を返す

**読解のコツ**: 通常の平均計算（合計/要素数）ではなく、各要素を要素数で割ってから合計している。これは大きな数値のオーバーフローを回避するためのテクニック。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | containers.php | `src/math/containers.php` | median 関数（77-95行目）の実装を確認。中央値計算では mean を内部で使用 |
| 2-2 | containers.php | `src/math/containers.php` | sum 関数（141-154行目）と sum_float 関数（156-169行目）の実装を比較 |

#### Step 3: テストケースを確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | MathContainersTest.php | `tests/math/MathContainersTest.php` | provideTestMean メソッド（75-83行目）とtestMean メソッド（85-96行目）を確認 |

**主要処理フロー**:
- **77行目**: vec[1.0, 2.0, 3, 4] の平均が 2.5 であることを検証
- **78行目**: vec[1, 1, 2] の平均が 4/3 であることを検証
- **79行目**: vec[-1, 1] の平均が 0.0 であることを検証
- **80行目**: vec[INT64_MAX, INT64_MAX] の平均がオーバーフローせずに計算されることを検証
- **81行目**: 空の vec で null が返されることを検証

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

```
Math\mean($numbers)
    │
    ├─ C\count($numbers)
    │      └─ 要素数を取得
    │
    ├─ $count === 0.0 の判定
    │      └─ true の場合: null を返す
    │
    └─ foreach ($numbers as $number)
           │
           └─ $mean += $number / $count
                  └─ オーバーフロー回避の累積計算
```

### データフロー図

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

Container<num> ───▶ C\count() で要素数取得 ───▶ ?float 平均値
    $numbers              │                         または null
                          ▼
                   空チェック
                   ($count === 0.0)
                          │
                          ▼
                   foreach で走査
                   $mean += $number / $count
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| containers.php | `src/math/containers.php` | ソース | mean 関数の実装ファイル（コレクション操作関数群） |
| MathContainersTest.php | `tests/math/MathContainersTest.php` | テスト | mean 関数を含むコレクション関数のユニットテスト |
