# 機能設計書 66-Vec\take

## 概要

本ドキュメントは、Hack Standard Library（HSL）の`Vec\take`関数の機能設計を記載する。この関数は、Traversableから先頭のn要素を取得し、新しいvecとして返す。

### 本機能の処理概要

**業務上の目的・背景**：
コレクションの先頭部分のみを取得する操作は、データ処理において頻繁に必要となる。例えば、「最新の10件を表示」「トップ5のランキング」「最初の数件のプレビュー」などの場面で使用される。この関数は、遅延評価をサポートするため、イテレータからの効率的な先頭要素取得が可能である。

**機能の利用シーン**：
- ランキングのトップN件取得
- 最新データの上位N件表示
- プレビュー用の最初の数件抽出
- ページネーションの最初のページ
- ストリームからの限定的なデータ取得

**主要な処理内容**：
1. nが0の場合は空のvecを即座に返却
2. nが正の値であることを検証
3. Traversableをforeachで反復し、n要素まで結果vecに追加
4. n要素に達したらループを終了

**関連システム・外部連携**：
外部システムとの連携はない。純粋な関数型ユーティリティとして動作する。

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

## 関連画面

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

## 機能種別

計算処理 / データ抽出

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| $traversable | Traversable<Tv> | Yes | 先頭要素を取得する対象のコレクション | なし |
| $n | int | Yes | 取得する要素数 | 非負の整数でなければならない |

### 入力データソース

プログラムコードからの直接呼び出し。vec、keyset、Set、Vector、イテレータなど、Traversableを実装する任意の型を受け付ける。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | vec<Tv> | 先頭n要素を含むvec。コレクションがn要素未満の場合はすべての要素を返す |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. nが0の場合、空のvecを返却
   └─ if ($n === 0) return vec[]

2. nが正の値であることを検証
   └─ invariant($n > 0, ...)

3. 空の結果vecを初期化
   └─ $result = vec[]

4. Traversableをforeachで反復
   └─ foreach ($traversable as $value)
   └─ $result[] = $value
   └─ カウンタがnに達したらbreak

5. 結果vecを返却
   └─ return $result
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{n === 0?}
    B -->|Yes| C[空vecを返却]
    B -->|No| D{n > 0?}
    D -->|No| E[InvariantException]
    D -->|Yes| F[結果vec初期化]
    F --> G[カウンタ初期化 ii=0]
    G --> H{traversableに次の要素があるか}
    H -->|Yes| I[要素を結果に追加]
    I --> J[カウンタ++]
    J --> K{ii === n?}
    K -->|Yes| L[ループ終了]
    K -->|No| H
    H -->|No| L
    L --> M[結果vecを返却]
    M --> N[終了]
    C --> N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 順序保持 | 元のコレクションの走査順序が結果vecでも保持される | 常時 |
| BR-02 | サイズ制限 | コレクションがn要素未満の場合、すべての要素を返す | n > コレクションサイズ |
| BR-03 | 早期終了 | n要素取得後はループを終了する（効率化） | 常時 |
| BR-04 | 遅延評価対応 | イテレータからの取得時、必要な要素のみを消費する | イテレータ入力時 |

### 計算ロジック

結果のサイズ = min(n, コレクションのサイズ)

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベース操作なし |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | InvariantException | nが負の値の場合 | 非負の値を指定する |

### リトライ仕様

リトライは不要（純粋関数であり、同じ入力に対して常に同じ結果を返す）。

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

トランザクション管理は不要（メモリ内処理のみ）。

## パフォーマンス要件

- 時間計算量: O(n)、nは取得する要素数
- 空間計算量: O(n)、nは取得する要素数

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

- 純粋関数であり、外部リソースへのアクセスは行わない
- 大きなnを指定してもコレクションサイズを超えて処理されることはない

## 備考

- `Vec\drop`は先頭n要素をスキップする逆操作
- `Vec\slice($container, 0, $n)`と等価だが、Traversableにも対応可能
- イテレータを入力した場合、取得した要素分だけイテレータが消費される

---

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

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

### 推奨読解順序

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

Traversableインターフェースと早期終了の概念を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | select.php | `src/vec/select.php` | take関数の定義場所と型シグネチャ |

**読解のコツ**: `Traversable<Tv>`は反復可能な任意のコレクションを表す。イテレータも含まれるため、遅延評価が可能であり、必要な要素のみを処理できる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | select.php | `src/vec/select.php` | take関数の実装（251-266行目） |

**主要処理フロー**:
1. **251行目**: 関数シグネチャ - Traversableと要素数nを受け取る
2. **252-254行目**: n=0の早期リターン
3. **255行目**: nが正の値であることを検証
4. **256-264行目**: foreachでn要素まで取得し、breakで終了
5. **265行目**: 結果vecを返却

#### Step 3: 関連関数との比較

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | select.php | `src/vec/select.php` | drop関数（83-95行目）との比較 |
| 3-2 | select.php | `src/vec/select.php` | slice関数（231-240行目）との比較 |

**主要処理フロー**:
- **drop (83-95行目)**: 先頭n要素をスキップし、残りを返す（takeの逆操作）
- **slice (231-240行目)**: オフセットと長さを指定して部分取得（より一般的な操作）

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

```
Vec\take()
    │
    └─ foreach反復
           ├─ 要素を結果vecに追加
           └─ n要素でbreak
```

### データフロー図

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

Traversable<Tv>     ───▶  foreach反復処理  ───────────▶   vec<Tv>
$n                  ───▶                                 (先頭n要素)
                              │
                              ▼
                         カウンタ管理
                              │
                              ▼
                         n要素でbreak
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| select.php | `src/vec/select.php` | ソース | take関数の実装 |
| VecSelectTest.php | `tests/vec/VecSelectTest.php` | テスト | takeのユニットテスト（482-527行目） |
