# 機能設計書 154-PseudoRandom\float

## 概要

本ドキュメントは、Hack Standard Library (HSL) における `PseudoRandom\float` 関数の機能設計を記載する。この関数は擬似ランダムな浮動小数点数を生成する機能を提供する。

### 本機能の処理概要

`PseudoRandom\float` は、[0.0, 1.0) の範囲内の擬似ランダムな浮動小数点数を生成する関数である。内部的には `PseudoRandom\int` を使用して 0 から `Math\INT53_MAX - 1` の範囲の乱数を生成し、それを `Math\INT53_MAX` で除算することで浮動小数点数に変換する。**重要：この関数は暗号用途には適さない。**

**業務上の目的・背景**：多くのアプリケーションでは、暗号学的な安全性は必要ないが、高速な乱数生成が必要な場面がある。ゲーム、シミュレーション、テスト、統計的サンプリング、UIアニメーションのランダム化などでは、擬似乱数で十分であり、むしろ暗号学的乱数よりも高速であることが望ましい場合がある。

**機能の利用シーン**：
- ゲームにおける確率イベントの判定
- モンテカルロシミュレーション（セキュリティ非依存）
- テストデータのランダム生成
- UIアニメーションのランダム化
- 統計的サンプリング処理

**主要な処理内容**：
1. `PseudoRandom\int` を呼び出して 0 から `Math\INT53_MAX - 1` の範囲の整数乱数を取得
2. 取得した整数を `Math\INT53_MAX` (9007199254740992) で除算
3. 結果を返却

**関連システム・外部連携**：Hack ランタイムの `_Private\Native\pseudorandom_int` を間接的に使用する。これは決定論的な擬似乱数生成器（PRNG）を使用する。

**権限による制御**：本機能は純粋関数として実装されており、特別な権限は必要としない。`[leak_safe]` コンテキストで実行可能。

## 関連画面

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

## 機能種別

計算処理（乱数生成）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | この関数は引数を取らない | - |

### 入力データソース

擬似乱数生成器（PRNG）の内部状態

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | float | [0.0, 1.0) の範囲内の擬似ランダム浮動小数点数。0.0以上1.0未満の値を返す |

### 出力先

関数の戻り値として呼び出し元に返却

## 処理フロー

### 処理シーケンス

```
1. PseudoRandom\int を呼び出し
   └─ 引数として $min=0, $max=Math\INT53_MAX-1 を指定
2. 取得した整数値を Math\INT53_MAX で除算
   └─ 整数 / INT53_MAX により [0.0, 1.0) の範囲にスケーリング
3. 結果を返却
   └─ float 型として返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[PseudoRandom\int 0, INT53_MAX-1 呼び出し]
    B --> C[整数乱数取得]
    C --> D[INT53_MAX で除算]
    D --> E[float として返却]
    E --> F[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-154-01 | 範囲制約 | 戻り値は必ず [0.0, 1.0) の範囲内となる | 常時 |
| BR-154-02 | 非暗号用途 | 暗号用途には使用してはならない | 常時 |
| BR-154-03 | 精度保証 | IEEE 754 倍精度浮動小数点の精度範囲内で一様分布を近似する | 常時 |

### 計算ロジック

```
result = (float)PseudoRandom\int(0, INT53_MAX - 1) / INT53_MAX
```

`SecureRandom\float` と同様のアルゴリズムだが、内部で使用する乱数源が異なる。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | 本機能はデータベース操作を行わない |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | この関数は例外を投げない | - |

### リトライ仕様

リトライ処理は不要。

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

本機能はトランザクションを使用しない純粋関数である。

## パフォーマンス要件

- 単一呼び出しのレイテンシ：ナノ秒〜マイクロ秒オーダー
- `SecureRandom\float` より高速（システムコールを伴わない）
- スループット：非常に高い

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

- **警告**：この関数は暗号用途に適さない
- 生成される値は予測可能な可能性がある
- PRNG の内部状態が露出した場合、将来の出力を予測される可能性がある
- トークン生成、パスワード、暗号鍵などには絶対に使用しないこと
- セキュリティが必要な場面では `SecureRandom\float` を使用すること

## 備考

- 暗号用途が必要な場合は `SecureRandom\float` を使用すること
- パフォーマンスが重要で、セキュリティが不要な場合に本関数を使用
- INT53_MAX を使用することで、`SecureRandom\float` と同等の精度を提供

---

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

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

### 推奨読解順序

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

本機能は単純な数値型のみを扱うため、特別なデータ構造は存在しない。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | constants.php | `src/math/constants.php` | INT53_MAX 定数の定義（19行目）を確認 |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pseudo.php | `src/random/pseudo.php` | PseudoRandom\float 関数の実装（21-23行目） |

**主要処理フロー**:
1. **21行目**: 関数宣言。`[leak_safe]` コンテキストで float を返す
2. **22行目**: `PseudoRandom\int(0, Math\INT53_MAX - 1)` で整数乱数を生成
3. **22行目**: 生成した整数を `Math\INT53_MAX` で除算

```hack
function float()[leak_safe]: float {
  return (float)namespace\int(0, Math\INT53_MAX - 1) / Math\INT53_MAX;
}
```

**読解のコツ**: `namespace\int` は同じ名前空間内の `int` 関数を呼び出している（`PseudoRandom\int`）。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | pseudo.php | `src/random/pseudo.php` | PseudoRandom\int 関数の実装（31-42行目） |

**主要処理フロー**:
- **35-40行目**: invariant による入力検証（$min <= $max）
- **41行目**: `_Private\Native\pseudorandom_int` を呼び出して整数を生成

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

```
PseudoRandom\float()
    │
    └─ PseudoRandom\int(0, INT53_MAX - 1)
           │
           └─ _Private\Native\pseudorandom_int($min, $max)
                  │
                  └─ [PRNG 内部状態]
```

### データフロー図

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

なし ───────────▶ PseudoRandom\int() ─────▶ 整数乱数 (0 ~ INT53_MAX-1)
                         │
                         ▼
                  INT53_MAX で除算
                         │
                         ▼
                     float 返却 ─────────▶ float [0.0, 1.0)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| pseudo.php | `src/random/pseudo.php` | ソース | PseudoRandom 名前空間の公開関数を定義 |
| constants.php | `src/math/constants.php` | ソース | INT53_MAX などの数学定数を定義 |
| PseudoRandomTest.php | `tests/random/PseudoRandomTest.php` | テスト | PseudoRandom 関数群のユニットテスト |
| RandomTestTrait.php | `tests/random/RandomTestTrait.php` | テスト | ランダム関数の共通テストトレイト |
