# 機能設計書 92-Keyset\drop

## 概要

本ドキュメントは、Hack Standard Library (HSL) の `HH\Lib\Keyset\drop` 関数の機能設計について記述する。この関数は、Traversableの最初のn要素を除いた新しいkeysetを返す機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：
データ処理において、先頭の一定数の要素をスキップして残りの要素を取得する処理は、ページネーション、ヘッダー行のスキップ、バッチ処理の継続などの場面で頻繁に必要とされる。本機能は、コレクションの先頭から指定した数の要素を除外し、残りをkeysetとして返す。これにより、オフセットベースのデータ取得やページネーション処理を効率的に実装できる。

**機能の利用シーン**：
- ページネーションでオフセット以降のデータを取得する際
- CSVデータのヘッダー行をスキップする際
- バッチ処理で前回処理済み分をスキップする際
- ランキングの上位N件を除いた残りを取得する際

**主要な処理内容**：
1. 指定されたnが0以上であることを検証
2. Traversableを走査し、最初のn要素をスキップ
3. n+1番目以降の要素をkeysetに追加して返却

**関連システム・外部連携**：
- 対になる関数として`Keyset\take`（最初のn要素を取得）が存在
- arraykey制約により、int型とstring型のみを要素として受け付ける

**権限による制御**：
特になし。純粋な計算処理のため、権限による制御は行わない。

## 関連画面

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

## 機能種別

計算処理（コレクション操作）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | Traversable<Tv> | Yes | 操作対象のコレクション | Tvはarraykey制約 |
| $n | int | Yes | スキップする要素数 | 0以上であること |

### 入力データソース

関数呼び出し時の引数として渡されるTraversableインスタンスと整数値。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | keyset<Tv> | 最初のn要素を除いたkeyset |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. バリデーション
   └─ nが0未満の場合はInvariantException
2. 結果用keysetを初期化
3. カウンタを-1で初期化
4. Traversableを走査
   └─ カウンタをインクリメント
   └─ カウンタがn未満の場合はcontinue（スキップ）
   └─ n以上の場合は結果keysetに追加
5. 結果返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{n >= 0?}
    B -->|No| C[InvariantException]
    B -->|Yes| D[result = keyset[], ii = -1]
    D --> E{traversable走査}
    E --> F[ii++]
    F --> G{ii < n?}
    G -->|Yes| H[continue]
    G -->|No| I[result[] = value]
    H --> E
    I --> E
    E -->|完了| J[resultを返却]
    J --> K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 非負制約 | nは0以上でなければならない | 関数呼び出し時 |
| BR-02 | 重複排除 | keysetの特性により、結果に重複は含まれない | 常時 |
| BR-03 | 要素不足時の動作 | nがTraversableのサイズ以上の場合、空のkeysetを返す | n >= size |

### 計算ロジック

- 時間計算量: O(n) - nはTraversableのサイズ
- 空間計算量: O(n) - nはTraversableのサイズ

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

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

該当なし。本機能はインメモリでのコレクション操作のみを行う。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | InvariantException | nが負の値の場合 | 0以上の値を指定 |
| - | TypeError | arraykeyでない型の要素を含むTraversableを渡した場合 | int/string型のみ使用 |

### リトライ仕様

該当なし。純粋関数であり、同じ入力に対しては常に同じ結果を返す。

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

該当なし。インメモリ操作のみ。

## パフォーマンス要件

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

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

特になし。純粋なデータ変換処理であり、外部リソースへのアクセスは行わない。

## 備考

- `Keyset\take`と対になる関数で、逆の操作を行う
- 重複要素を含むTraversableの場合、スキップ後のkeysetは重複が排除されるため、元のサイズから単純にnを引いた数にはならない可能性がある

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | (Hack言語仕様) | - | keysetは一意のarraykey（int/string）のみを格納する集合型 |

**読解のコツ**: Hackのinvariant関数は条件が偽の場合にInvariantExceptionをスローするアサーション機能。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | select.php | `src/keyset/select.php` | drop関数の実装本体 |

**主要処理フロー**:
1. **66-69行目**: 関数シグネチャ - ジェネリクスTvとarraykey制約
2. **70行目**: invariantでn >= 0を検証
3. **71行目**: 空のkeyset初期化
4. **72行目**: カウンタii = -1で初期化
5. **73-79行目**: foreachで走査、n未満はcontinue、n以上は追加
6. **80行目**: 結果を返却

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | select.php | `src/keyset/select.php` | take関数（対になる関数）の実装 |

**主要処理フロー**:
- **208-226行目**: take関数 - 最初のn要素を取得

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

```
Keyset\drop($traversable, $n)
    │
    ├─ invariant($n >= 0, ...)  [バリデーション]
    │
    └─ foreach ($traversable as $value)  [要素走査]
           └─ $result[] = $value  [keyset追加]
```

### データフロー図

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

$traversable  ───────▶ 走査 ──▶ n要素スキップ ──▶ keyset<Tv>
                              │
$n (int) ─────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.php | `src/keyset/select.php` | ソース | drop関数の実装 |
| KeysetSelectTest.php | `tests/keyset/KeysetSelectTest.php` | テスト | drop関数のユニットテスト |
