[yield]:Gushwell's C# Dev Notes

2010年11月23日

コンソールで処理中であることを示す文字を表示

元ネタいろいろ備忘録日記 - コンソールで処理中であることを示す文字を表示

おもしろそうだったので、僕もやってみました。

「指定した複数の値を繰り返す」で示したRepeat拡張メソッドを使って、gsf_zero1 さんが書いたコードを書き換えています。

以下に示すコードのProgressメソッドが、処理中であることを示すメソッドです。
gsf_zero1 さんは、ラムダ式としていましたが、これをメソッドにしています。

このメソッドの中で、Repeatメソッドを使い、コンソールに表示する文字を繰り返し取得しています。
僕のコードでは、'.' 'o' 'O' '@' 'O' 'o' という6文字を繰り返して取り出し、コンソールに表示しています。
別の文字を表示したいなら、文字列 ".oO@Oo" の部分を"|/-" など別のものに置き換えるだけです。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace RunningSample {
    class Program {

static volatile bool _stop;

static void Main(string[] args) {
            Console.WriteLine("処理開始.....");

_stop = false;
            var task = Task.Factory.StartNew(Progress);

// 時間がかかる処理をシミュレート.
            Thread.Sleep(TimeSpan.FromSeconds(10.0));

// タスクを停止.
            _stop = true;
            task.Wait();

Console.WriteLine("終了");
        }

static void Progress() {
            int left = Console.CursorLeft;
            int top = Console.CursorTop;

string chars = ".oO@Oo";
            foreach (var c in chars.Repeat()) {
                if (_stop) {
                    break;
                }
                Console.SetCursorPosition(left, top);
                Console.Write(c);
                Thread.Sleep(TimeSpan.FromSeconds(0.4));
            }
            Console.SetCursorPosition(left, top);
            Console.Write("");
        }        
    }

static class EnumerableExtentions {
        public static IEnumerable<T> Repeat<T>(this IEnumerable<T> items) {
            if (items.Any()) {
                while (true) {
                    foreach (var item in items) {
                        yield return item;
                    }
                }
            }
        }
    }
}

Posted by gushwell at 23:10 │Comments(0) │TrackBack(0)

2010年01月23日

再帰メソッドで、yield returnしたい

再帰メソッドの戻り値を IEnumerable<T>にする場合についてまとめてみました。
順列を列挙するプログラムを例に説明します。
まず、以下のコードを見てください。

class Program {
        static void Main(string[] args) {
            Permutation permutation = new Permutation();
            permutation.Enumerate(new[] { 1, 2, 3 });
            Console.ReadLine();
        }
    }

class Permutation {
        private void Print<T>(IEnumerable<T> nums) {
            foreach (var x in nums)
                Console.Write("{0} ", x);
            Console.WriteLine();
        }

public void Enumerate<T>(IEnumerable<T> nums) {
            _GetPermutations<T>(new List<T>(), nums.ToList());
        }

private void _GetPermutations<T>(IEnumerable<T> perm, IEnumerable<T> nums) {
            if (nums.Count() == 0) {
                Print(perm);
                return;
            } else {
                foreach (var n in nums) {
                    _GetPermutations<T>(perm.Concat(new T[] { n }),
                                        nums.Where(x => x.Equals(n) == false)
                    );
                }
            }
        }
    }

このコードの問題点は、_GetPermutations というメソッドの中で、Printメソッドを呼び出している点です。
これだと、順列を求めるコードと、求めた順列を使って処理をするコードを明確に分離することができません。
Permutationクラスは、いろんな場面で使える構造になっていないわけです。問題が異なれば、Printメソッドの部分を書き直さなくてはなりません。

これを解決する方法のひとつが、イベントやdelegateを使う方法です。
順列が求まるたびに、イベントを発行すれば、Permutationクラスの利用者が Permutationクラスに手を入れることなく、自由に独自の処理を書くことができます。

ただ、この方法にも欠点があります。
例えば、GUIのあるプログラムで、次へボタンを押すたびに、順列をひとつずつ表示することを考えて見ましょう。こういった要求には、イベント発行する方法は上手く対応することができません。

Permutationクラスの利用する側で、Next メソッドなどを使い、ひとつずつ取り出せれば良いですよね。
それには、Enumerate メソッドの戻り値を、IEnumerable<T>にするのが良さそうです。

以下に、戻り値を、IEnumerable<T> にしたPermutationクラスを示します。

注目すべき点は、再帰メソッドを呼び出して、返ってきた戻り値の扱いです（★印）。
return result とは書けません。
foreachで、一つ一つ要素を取り出し、yield return しています。こうすることで、再帰メソッドで、戻り値をIEnumerable<T>にすることができます。

全ての結果を Listなどに溜め込む方法でも、Enumerateメソッドの戻り値をIEnumerable<T>に出来ますが（この場合は、下請けメソッドの_GetPermutationsの戻り値は、IEnumerable<T>にはなりません）、全てを列挙し終わらないと、Enumerateメソッドから制御を戻せませんので、順列の元となる要素数が多い場合には、最初のひとつを取り出すのにも多くの時間を要してしまい好ましくありません。

では、これを使う側のコードを示します。
まずはforeachで取り出すコード

次に、IEnumerator<T>.MoveNext, IEnumerator<T>.Currentを使うコード

ボタンをクリックするごとに、次の順列を取り出し、labelに表示しています。