[サンプル] イテレータとマイクロスレッド

2007/09/30 (Last updated:2007/10/02)

概要

ゲーム開発の分野を中心として、マイクロスレッド（microthread）あるいはコルーチン（coroutine）、ファイバー（fiber）などと呼ばれる概念が考えられています。

C# 2.0 の「イテレーター」構文を使うと、マイクロスレッドと似たようなことができます。

マイクロスレッドとは

狭い分野でしか使われてない言葉なので、定義も用語もあまりはっきりと固まっていないんですが、ここでの説明は数ある定義のうちの1つだと思ってください。

マイクロスレッドというものの背景には、アクションゲームやシューティングゲームの敵や弾の動作ロジックをどう書こうかという話があります。

シューティングゲームなどでは、時間をフレームと呼ばれる単位に区切って、 1フレームごとに敵や弾の位置を更新するという方式をとる場合が多いです。（一番多いのは、1フレーム＝ 30分の1秒か60分の1秒の固定時間フレーム。）一番簡単な実装方法は、毎フレーム呼び出される Update メソッドを定義する方法。

例えば、要点だけ抜き出して書くと、以下のような感じ。

class SimpleBullet : UpdatableObject
{
  double x, y;
  double vx, vy;

  /// <summary>
  /// 更新処理。
  /// 毎フレーム呼び出される。
  /// </summary>
  public void Update()
  {
    this.x += this.vx;
    this.y += this.vy;
  }
}

で、オブジェクトマネージャーみたいなクラスを別に作って、そこで1フレーム毎にこの Update メソッドを呼び出します。

この例は、等速直線運動をしているだけのシンプルな処理なので、これでも特に不満はありません。じゃあ次は、もう少し複雑な処理を考えてみましょう。例えば、以下のような動きを考えてみます。

最初の100フレームはその場に停滞。
次の100フレーム、等速直線運動。
最後に、向きを反転して、あとはずっと等速直線運動。

これを Update メソッドを使って書くと以下のようになります。

class ComplexBullet : UpdatableObject
{
  double x, y;
  double vx, vy;

  int state = 0;

  public void Update()
  {
    if (this.state < 100)
    {
    }
    else if (this.state < 200)
    {
      this.x += this.vx;
      this.y += this.vy;
    }
    else if (this.state == 200)
    {
      this.vx = - this.vx;
      this.vy = - this.vy;
    }
    else
    {
      this.x += this.vx;
      this.y += this.vy;
    }
    ++this.state;
  }
}

state 変数を使って、今、自分が何フレーム目の処理をしているかってのを自前で管理しながら処理をします。

これもまだずいぶんシンプルな例で、もっと複雑な処理をしようと思うと、もっと入り組んだ state 管理が必要になってきます。

で、これを、以下のように書けたら便利なんじゃないかなぁというのがマイクロスレッドの目的。（このコードは C# でコンパイル不可。あくまで概念説明用。）

class ComplexBullet : UpdatableObject
{
  double x, y;
  double vx, vy;

  public void MicroThread()
  {
    for (int i = 0; i < 100; ++i)
    {
      yield;
    }
    for (int i = 0; i < 100; ++i)
    {
      this.x += this.vx;
      this.y += this.vy;
      yield;
    }

    this.vx = - this.vx;
    this.vy = - this.vy;

    for (; ; )
    {
      this.x += this.vx;
      this.y += this.vy;
      yield;
    }
  }
}

yield が記述された行に到達するたびに1フレーム時間が進むようなイメージ。さっきの Update メソッドみたいに「今、自分は何フレーム目なんだろう」みたいなことを意識する必要はなくて、あくまでシーケンシャルな手続きを書く。

こういう処理、実行効率が悪くてもいいなら、スレッドを使えばできるんですね、一応。 yield の部分に System.Monitor.Wait とかを書いてスレッドの動作を止めて、 1フレームごとに System.Monitor.Pulse を読んでスレッドを再開するとかで。スレッドは、Wait とかスレッド切り替えのオーバーヘッドがかなり大きいので、この方法だと、Update を使う方と比べて非常に効率が悪いです。

で、同様のことを Update でできることはわかってるんだから、この MicroThread メソッドから Update メソッドに相当するものを自動生成する仕組みを考えれば、わざわざスレッドを使わなくても同様の処理ができるわけです。

ということで、「スレッドみたいなことができるけども、用途が限られてる代わりに処理が軽量なもの」という意味で、マイクロスレッド（microthread）とかファイバー（fiber: thread の糸に対して、fiber は繊維）と呼びます。

具体的に、どうやって“軽量スレッド”みたいなものを作るかというと、まあ、1つの方法が、今言ったような「MicroThread メソッドから Update メソッドのようなものを自動生成する」というという処理になります。この他にも、（普通は OS に任せるような）スレッド管理処理を自前で実装して、本当に軽量スレッドを作ってしまうような方法を考える人もいるようです。あと、動的言語なら、「yield のところでほんとに処理を一度止めて呼び出し元に戻る」というような実装方法もできるかも。

コルーチン

ここで、同じものに対して別の見方をしてみましょう。

先ほどの MicroThread メソッドを簡素化して（ここでする説明に必要な部分だけ抜き出して）再掲してみます。（とりあえず、100フレームだけ等速直線運動する。）

class SimpleBullet : UpdatableObject
{
  double x, y;
  double vx, vy;

  public void MicroThread()
  {
    for (int i = 0; i < 100; ++i)
    {
      this.x += this.vx;
      this.y += this.vy;
      yield;
    }
  }
}

対比のために、普通のメソッドも書いておきます。

  public void NormalMethod()
  {
    for (int i = 0; i < 100; ++i)
    {
      this.x += this.vx;
      this.y += this.vy;
    }
  }

普通のメソッドの場合、複数のオブジェクトに対して処理するなら、例えば、以下のような書き方をします。

SimpleBullet o1, o2, o3;

中略。o1～o3 を初期化。

o1.NormalMethod();
o2.NormalMethod();
o3.NormalMethod();

マイクロスレッドの場合、ここでは、オブジェクトマネージャのようなものを通して、 1フレームごとに Update が呼ばれるようなモデルを考えているので、以下のようになると思います。

UpdatableObjectManager manager;
SimpleBullet o1, o2, o3;

中略。初期化処理。

manager.Add(o1);
manager.Add(o2);
manager.Add(o3);

manager.Run();

処理の流れのイメージとしては、普通のメソッドの場合は、図1のように、メソッドの処理全部が終わってから呼び出し元に戻るような動作をします。

一方、マイクロスレッドの場合は、図2のように、 yield の行に到達するたびに、処理を中断して呼び出し元に戻ります。

普通のメソッドの中身の処理（ルーチン）と違って、いくつかの処理が同時にちょっとずつ進むので、マイクロスレッドのことをコルーチン（coroutine: co- は「共に」とかを意味する接頭語）と呼んだりもします。

C# でマイクロスレッド

何か概念的な話ばかりしてきましが、ようやく、じゃあどうやってマイクロスレッドみたいなものを実装するかという話に入ります。

改めて書くと、以下のようなコードから、

  public void MicroThread()
  {
    for (int i = 0; i < 100; ++i)
    {
      this.x += this.vx;
      this.y += this.vy;
      yield;
    }
  }

以下の Update メソッドのようなものを自動生成できればいいわけです。

  int i = 0;
  void Update()
  {
    if (this.i < 100)
    {
      this.x += this.vx;
      this.y += this.vy;
    }
    ++this.i;
  }

他にも方法はあるかと思いますが、 C# で実現するとするならこの方法がいいです。

こういう機能を言語が持っていない限りそう簡単に実現できるような処理じゃなかったりしますが、幸い、C# には「イテレーター」構文という似たようなことをする機能があるので、それを使って実現可能です。例えば以下のような感じ。

using System.Collections;

class SimpleBullet : UpdatableObject
{
  double x, y;
  double vx, vy;
  IEnumerator microthread;

  public SimpleBullet()
  {
    this.microthread = this.GetMicroThread();
  }

  IEnumerator GetMicroThread()
  {
    for (int i = 0; i < 100; ++i)
    {
      this.x += this.vx;
      this.y += this.vy;
      yield return null;
    }
  }

  void Update()
  {
    if (this.microthread != null)
    {
      if (!this.microthread.MoveNext())
      {
        this.microthread = null;
      }
    }
  }
}