# 機能設計書 98-Keyset\take

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：
データ処理において、先頭から一定数の要素のみを取得する処理は、プレビュー表示、ページネーションの最初のページ、Top-Nの抽出などで頻繁に必要とされる。本機能は、コレクションの先頭から指定した数の要素を取得し、keysetとして返す。ただし、keysetの特性上、重複要素は自動的に排除されるため、結果のサイズは指定したn以下になる可能性がある。

**機能の利用シーン**：
- ランキングの上位N件を取得する際
- 検索結果のプレビュー表示
- バッチ処理で一度に処理する件数を制限する際
- ページネーションの最初のページを取得する際

**主要な処理内容**：
1. 指定されたnが正の値であることを検証
2. Traversableを走査し、最初のn要素をkeysetに追加
3. n要素に達するか、Traversableが終了したら処理終了
4. 結果のkeysetを返却

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

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

## 関連画面

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

## 機能種別

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | keyset<Tv> | 最初のn要素を含むkeyset（重複により少なくなる可能性あり） |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 早期リターンチェック
   └─ n === 0の場合、空のkeysetを返却
2. バリデーション
   └─ nが0以下の場合はInvariantException（n === 0は既にチェック済み）
3. 結果用keysetを初期化
4. カウンタを0で初期化
5. Traversableを走査
   └─ 要素をkeysetに追加
   └─ カウンタをインクリメント
   └─ カウンタがnに達したらbreak
6. 結果返却
```

### フローチャート

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

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 正数制約 | nは0以上でなければならない | 関数呼び出し時 |
| BR-02 | ゼロの特別扱い | n === 0の場合は早期に空のkeysetを返す | n === 0 |
| BR-03 | 重複による縮小 | keysetの特性により、結果はn未満になる可能性がある | 重複要素あり時 |

### 計算ロジック

- 時間計算量: O(n) - nは引数で指定した要素数
- 空間計算量: O(n) - nは引数で指定した要素数

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

- 時間計算量: O(n)
- 空間計算量: O(n)
- n === 0の場合は即座に空のkeysetを返す最適化

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

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

## 備考

- `Keyset\drop`と対になる関数で、逆の操作を行う
- 重複要素を含むTraversableの場合、keysetは重複を排除するため、結果がn未満になる可能性がある
- イテレータを入力とした場合、消費された要素は再取得できない点に注意

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | (Hack言語仕様) | - | keysetは一意のarraykeyのみを格納するため、同一値の追加は無視される |

**読解のコツ**: Hackのinvariant関数は条件が偽の場合にInvariantExceptionをスローするアサーション機能。n === 0は先にチェックされているため、invariantではn > 0を検証。

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

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

**主要処理フロー**:
1. **196-206行目**: ドキュメントコメント - 機能と注意点の説明
2. **207-211行目**: 関数シグネチャ
3. **212-214行目**: n === 0の早期リターン
4. **215行目**: invariantでn > 0を検証
5. **216行目**: 空のkeyset初期化
6. **217行目**: カウンタii = 0で初期化
7. **218-224行目**: foreachで走査、n要素でbreak
8. **225行目**: 結果を返却

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

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

**主要処理フロー**:
- **66-81行目**: drop関数 - 最初のn要素をスキップ

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

```
Keyset\take($traversable, $n)
    │
    ├─ $n === 0 チェック  [早期リターン]
    │
    ├─ invariant($n > 0, ...)  [バリデーション]
    │
    └─ foreach ($traversable as $value)  [要素走査]
           │
           ├─ $result[] = $value  [keyset追加]
           │
           └─ break when $ii === $n  [n要素で終了]
```

### データフロー図

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

$traversable  ───────▶ 走査 ──▶ 最初のn要素取得 ──▶ keyset<Tv>
                              │
$n (int) ─────────────────────┘
```

### 関連ファイル一覧

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