ジェネレータによって返される値について

Question

ジェネレータにつきまして、お聞きしたいことがあります。

<?php
function gen_one_to_three() {
    for ($i = 1; $i <= 3; $i++) {
        // yield を繰り返す間、$i の値が維持されることに注目しましょう
        yield $i;
    }
}

$generator = gen_one_to_three();
foreach ($generator as $value) {
    echo "$value\n";
}
?>

上記の「$generator = gen_one_to_three();」ここの部分についてなのですが、「$generator」は「gen_one_to_three();」が処理された結果が入っていると思うのですが、returnでしたら、返り値が返ると思うのですが、returnはしていない為、何が代入されているかが分からないです...
var_dumpしてみましたら「object(Generator)#1 (0) { }」このように表示されたのですが、これも良く分かりません...
上記の点につきまして、混乱してしまっている部分もあるため、どなたかご教示頂けましたら幸いです。
よろしくお願いします。

Answer 1

マニュアルから抜粋したのなら、マニュアルを読めばよいです。
yieldがキモです。

余談
php においてジェネレータ関数を使用するのは非常に限定的です。
・巨大なファイルの読み込み
・外部サービスの使用
等

今必要でないのであれば、混乱するし理解に時間がかかるので後回しにしたほうが良いです。
困ったときには自然と必要になりますが、(php を使用する上では)困るまで忘れて良いです仕組みです。

追記
コレで分かれば飛ばさなくてもイイよｗ

<?php 
function gen_one_to_three() {
    echo '1回目の呼び出し'.PHP_EOL;
    yield 1;
    echo '2回目の呼び出し'.PHP_EOL;
    yield 2;
    echo '3回目の呼び出し'.PHP_EOL;
    yield 3;
}

$generator = gen_one_to_three();
foreach ($generator as $value) {
    echo 'gen_one_to_three()を呼び出し'.PHP_EOL;
    echo "$value".PHP_EOL;
}

Comments

[newyee]

ご回答ありがとうございます。
PHPを学習している際に、関数の章でジェネレータが出てきたのですが、理解しておかなければ、この先困るかなと思っていたのですが、そうでないのなら、ここの部分は飛ばして先へ学習を進めようかなと思います！

[退会済みユーザー]

一応、フォローのつもりの追記をしました。
ただ、今はやっぱりわからないと思います。

[newyee]

ありがとうございます。
papinianusさんのご回答も併せて、yieldに関して、大分理解することができました。

Answer 2

PHPのジェネレータ構文の内部実装が実際のところどうなのかは分かりませんが、generatorの概念は次のようなクラスが背後にあると考えるのが理解しやすいと思います。

<?php
class gen_one_to_three implements Iterator {
    private $start;
    private $limit;
    private $cur;
    
    public function __construct() {
      $this->start = 1;
      $this->limit = 3;
      $this->cur = 1;
    }
    function rewind()
    {
        $this->cur = $this->start;
    }

    function current()
    {
        return $this->cur;
    }

    function key()
    {
        return ($this->cur) - 1;
    }

    function next()
    {
        if($this->cur > $this->limit) { return FALSE; }
        return $this->cur++;
    }

    function valid()
    {
        return $this->key() >= 0 && $this->key() < $this->limit;
    }
}
$generator = new gen_one_to_three();
foreach ($generator as $value) {
    echo "$value\n";
}

Comments

[newyee]

ご回答ありがとうございます。
ご回答いただきました部分で、まだ勉強不足な為、理解できていない部分も多々あるため、取り敢えずは勉強を進めてみまして、再度頂いたご回答見直させて頂ければと思っております。
自分としましては、どうも「yield」の部分が理解できていないのですが、「gen_one_to_three」関数が実行された時点で、「yield」が実行されていますが、何か、配列のような形で「$i」が格納されているのかとかそういったことはあるのでしょうか...?

[papinianus]

> 「gen_one_to_three」関数が実行された時点で、「yield」が実行されていますが
質問文のコードで話させてください。
```
function gen_one_to_three() {
for ($i = 1; $i <= 3; $i++) {
// yield を繰り返す間、$i の値が維持されることに注目しましょう
yield $i;
}
}
```
のことを言っているなら(タイプA)、gen_one_to_threeもyieldも実行していません。宣言だけですから。

```
$generator = gen_one_to_three();
```
のことを言っているなら(タイプB)、gen_one_to_threeは実行されたと言えますが、yieldは実行していません。

タイプBにおいて、`gen_one_to_three()`という(ジェネレータ形式の)関数を実行することは、「このあといつyieldをされても大丈夫になるための準備をした」にすぎません。
(もしご存知なら、関数を返す関数に似ています)

yieldが実行されるのは、ジェネレータにforeachが「値を取り出せ！」という(人間が意識しない、裏側の)命令を出したときです。

> 何か、配列のような形で「$i」が格納されているのかとかそういったことはあるのでしょうか...?
答えとしては、そういったことはあるかもしれないし、ないかもしれない、です。
<この質問はgeneratorの本質から外れています。↓は無視したほうがいいくらいです>
配列だとしたら、[1,2,3]ですよね？$iは1または2または3です。かたち(型<カタ>)がちがいます。
質問のパターンであれば、内部的な実装で、[1,2,3]を配列で持つことは可能ですが、例えば、質問のコードでyieldのところで、mtrandなどを使ったり、
`while(true) yield $i++;`とした(無限に続く)ものは配列にはできません。
なので、配列っぽい動作、配列っぽい実装を想定して、そのとおりになるかどうかは局面による、としか言えません。

---
回答の後出しになりますが、generatorはある種(ある種とは、foreachにかけられる、種類と理解してください)のクラスを簡単に作るための便利構文です。

[newyee]

大変ご丁寧に教えてくださり、ありがとうございます。
うまく、お伝えできずにすみませんでした。自分の理解できない部分は、「タイプB」の部分でした。
「$generator = gen_one_to_three();」ここの部分におきましては、yieldは実行されていなかったんですね。すみません。一点だけ、分からない部分があるのですが「$generator = gen_one_to_three()」ここの部分の、$generatorには何が格納されているのでしょうか...?
foreach内で、foreach ($generator as $value)このようにし、一つずつ値を取り出すよう命令が可能であれば、foreach (gen_one_to_three() as $value)このようなことも可能なのではないのかなと、もしくは記述的に不可能であっても内部的にはこのようなことが行われているのではないかなと思うのですが、いかがでしょうか...?

[papinianus]

> $generatorには何が格納されているのでしょうか...?
foreachできるようになったオブジェクトです。gen_one_to_threeの定義にある内部の処理をもった、インスタンスです。
--
この説明が適切か悩ましいのですが、$generator2 = gen_one_to_three();とすることができる、またこれは$generatorとは独立に動く、ことは理解できますでしょうか？
<?php
function gen_one_to_three() {
for ($i = 1; $i <= 3; $i++) {
// yield を繰り返す間、$i の値が維持されることに注目しましょう
yield $i;
}
}
$generator = gen_one_to_three();
$generator2 = gen_one_to_three();
foreach($generator as $value) {
if($value == 2) break;
echo "$value\n";
}
// 再実行不可のエラーが出る
/*
foreach($generator as $value) {
if($value == 2) break;
echo "$value\n";
}
*/
// こっちは動く
foreach($generator2 as $value) {
echo "$value\n";
}
```
$generatorには、最初に書いたロジックをもった、しかし内部状態はまっさらな、インスタンスが入っています

> foreach (gen_one_to_three() as $value)このようなことも可能
可能ですね。個人的にこういう感じでジェネレータ関数をforeachにつっこむことは良くやります。
ただ、こう書いたところで、関数を評価すると、foreach(object(generator) as $value)になって、
foreachとかasの作用で`->next()`が呼ばれ、そのとき`yield`の部分が実行されることにはかわりないです。

[newyee]

ご返信ありがとうございます。
>またこれは$generatorとは独立に動く、ことは理解できますでしょうか？
すみません。勉強不足でまだ、その辺りに関しましても理解があやふやな部分があるのですが、クラスを、newしてインスタンス化した場合は、別インスタンスが作られる、というのは知っているのですが、関数を複数の変数に代入した場合も別物として扱われる=独立したインスタンスとして扱うことができるということでしょうか...?
何度もお聞きして申し訳ないです...

[papinianus]

var_dumpで確認した結果をはりつけていらっしゃるじゃないですか？
> object(Generator)
ですよね？
つまり、generator形式の関数は、関数といいつつ、newしたときのようにインスタンスができます。(カッコの中に書いてあるとおり)Generatorクラスのインスタンスです。

なので、newじゃないのにnewしたみたいな、newじゃないのにインスタンスが返ってくるのが便利なところで、そうじゃなきゃ私の回答のようにクラスを作り込まないといけないのです。

> 何度もお聞きして申し訳ないです...
分かったフリをしない、その姿勢は素晴しいと思います。謝ることでは全然ないです。テトラちゃんです。

[newyee]

ありがとうございます。
ご説明くださったおかげで、引っかかっていた部分が紐解けました。ご丁寧な説明で、ご質問させて頂いたことだけでなく、Generatorに関する知識が深まりました。何度もご親切に、ありがとうございました。