# 機能設計書 125-floor

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `Math\floor` 関数に関する機能設計書である。この関数は、数値の切り捨て（床関数）を計算し、指定された値以下の最大の整数値をfloat型で返す。

### 本機能の処理概要

**業務上の目的・背景**：切り捨て演算は、配列インデックスの計算、座標の離散化、経過時間の秒数換算など、多くの業務処理で必要とされる基本的な数学演算である。`Math\floor`関数は、PHPの`floor`関数をラップし、Hackの型システムと統合された型安全な実装を提供する。

**機能の利用シーン**：配列インデックスの計算（中央値の位置など）、連続値から離散値への変換、経過秒数・分数の計算、価格の端数切り捨て、ファイルサイズを単位で割った際の整数部分取得など。

**主要な処理内容**：
1. 入力値（intまたはfloat）をPHPのfloor関数に渡す
2. floor関数が計算した結果（切り捨て値）をfloatとして返却

**関連システム・外部連携**：本機能はHSLライブラリ内部で完結し、外部システムとの連携はない。

**権限による制御**：本機能に権限による制御は存在しない。

## 関連画面

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

## 機能種別

計算処理 / 数学関数

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $value | num | Yes | 切り捨て対象の数値（intまたはfloat） | なし |

### 入力データソース

呼び出し元から直接渡される数値パラメータ。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | float | 切り捨てられた値（$value以下の最大の整数値） |

### 出力先

戻り値として呼び出し元に返却。

## 処理フロー

### 処理シーケンス

```
1. PHPのfloor関数を呼び出し
   └─ \floor($value) を実行
2. 結果をfloatとして返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[PHPのfloor関数を呼び出し]
    B --> C[切り捨て値をfloatで返却]
    C --> D[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 切り捨て定義 | 戻り値は$value以下の最大の整数値である | 常に適用 |
| BR-002 | 整数入力 | 整数が入力された場合、同じ値がfloatとして返される | $valueがintの場合 |
| BR-003 | 負数の切り捨て | 負の数の切り捨ては0から離れる値となる（例: -3.5 → -4.0） | $value < 0の場合 |

### 計算ロジック

```
floor(x) = ⌊x⌋ = 最大の整数 n where n <= x

例:
floor(3.5) = 3.0
floor(4.0) = 4.0
floor(-3.5) = -4.0
floor(-3.0) = -3.0
floor(0.0) = 0.0
```

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

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライは不要。純粋な計算関数である。

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

本機能はトランザクション制御を行わない。

## パフォーマンス要件

- 時間計算量: O(1)
- 空間計算量: O(1)

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

特になし。純粋な数学計算関数である。

## 備考

- 切り上げの場合は `Math\ceil()` を使用
- 四捨五入の場合は `Math\round()` を使用
- 整数除算の商（切り捨て）を取得する場合は `Math\int_div()` を使用
- capability context: `[]`（純粋関数）

---

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

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

### 推奨読解順序

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

Hackのnum型（intとfloatのユニオン型）を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | compute.php | `src/math/compute.php` | num型の入力とfloat型の出力 |

**読解のコツ**: num型はintとfloatの両方を受け入れるユニオン型であり、floor関数は常にfloatを返す。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | compute.php | `src/math/compute.php` | floor関数の定義（174-184行目） |

**主要処理フロー**:
1. **174-181行目**: ドキュメントコメント - ceil関数とint_div関数への参照
2. **182行目**: 関数シグネチャ - `num $value`を受け取り`float`を返す
3. **183行目**: PHPのfloor関数を呼び出して結果を返す

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

```
Math\floor($value)
    │
    └─ \floor($value)
```

### データフロー図

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

num型数値  ───▶  PHP\floor()  ───▶  float型数値
(int/float)                         (切り捨て値)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| compute.php | `src/math/compute.php` | ソース | floor関数の実装 |
| MathComputeTest.php | `tests/math/MathComputeTest.php` | テスト | floor関数のユニットテスト |
