§1 Stack

System.Collections.Generic.Stackクラスは、後入れ先出し(LIFO: Last-In, First-Out)のデータ構造を持つスタックを提供するコレクションクラスです。

§1.1 基本的な操作

スタックでは二つの操作プッシュポップが定義されます。 プッシュはスタックの先頭に要素を追加する操作で、ポップはスタックの先頭から要素を取り出す操作です。 この二つの操作により後入れ先出しのデータ構造が実現されます。 本を一冊ずつ上に積んでいく作業がプッシュ、積まれた本を一冊ずつ上から取っていく作業がポップに相当するとイメージするとよいと思います。

Stackクラスに要素を追加するプッシュの操作はPushメソッド、Stackから要素を取り出すポップの操作はPopメソッドで行います。 Stackから要素をポップすると、取り出した要素はStackから削除されます。

スタック

ListクラスDictionaryクラスとは異なり、Stackクラスでは要素が格納された順序が大きな意味を持ちます。 Stackに格納される要素は格納された順に並べられ、格納された後はその順序を並べ替えることはできません。 また、最初(または最後)に格納された要素のみに着目するため、インデックスを指定した要素へのアクセス(ランダムアクセス)はできません。

Stackに現在いくつの要素が含まれているかを知るにはCountプロパティを参照します。 Listなどと同様、Stackは可変長のコレクションであるため任意の数の要素をプッシュできます。 プッシュの際、Stack内部の容量は必要に応じて自動的に拡充されます。 ポップの際に要素数が減っても、Stack内部で確保されている容量が減ることはありません。


次の例では、5つの要素をStackにプッシュし、その後Stackが空になるまでポップしています。 スタックでは一番最後に入れた要素は一番始めに取り出される(Last-In, First-Out)という特性上、要素を入れた順番とは逆の順番で表示されている点に注目してください。

Stackクラスと要素のPush・Pop
using System;
using System.Collections.Generic;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    // Stackに要素をPush
    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");
    s.Push("Dave");
    s.Push("Eve");

    // Stackが空になるまで内容をPop
    while (0 < s.Count) {
      string e = s.Pop();

      Console.WriteLine(e);
    }
  }
}
実行結果
Eve
Dave
Charlie
Bob
Alice

§1.2 ピーク操作 (Peek)

PopメソッドはStackの先頭にある要素を取り出して取得しますが、Peekメソッドを使うとStackの内容を変更せず(Stackから削除せず)に先頭にある要素を参照できます。

Stackの内容が空の場合にPopメソッドやPeekメソッドを呼び出すと、null/Nothingが返されるのではなく例外InvalidOperationExceptionがスローされます。 従って、戻り値を見てStackが空になったかどうかを判断することはできません。 Stackが空であるかどうかを判断するにはPeekメソッドではなくCountプロパティを使います。

Peekによる要素の参照とPopによる取り出し
using System;
using System.Collections.Generic;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    // Stackに要素をPush
    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");

    // Stackの先頭にある要素をPeek
    Console.WriteLine("Peek: {0}", s.Peek());

    // Stackから要素を5つPop (Stackの要素数は3なので、途中で例外がスローされる)
    for (int i = 0; i < 5; i++) {
      Console.WriteLine("Pop: {0}", s.Pop());
    }
  }
}
実行結果
Peek: Charlie
Pop: Charlie
Pop: Bob
Pop: Alice

Unhandled Exception:
ハンドルされていない例外: System.InvalidOperationException: Stack が空です。
   場所 System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource)
   場所 System.Collections.Generic.Stack`1.Pop()
   場所 Sample.Main()

foreachなどによる列挙操作では、Stackの状態を変更せずにStackに格納されているすべての内容を参照することができます。

§1.3 要素の有無 (Contains)

Stackに指定した内容の要素が含まれているか調べるには、Containsメソッドを使います。 ただし、このメソッドではIEqualityComparerを指定できないため、Dictionaryのように大文字小文字の違いを無視して比較するといったことはできません。 そういった比較条件を指定した上で要素が含まれているかを調べるには、LINQの拡張メソッドContainsなどを使う必要があります。

Stack.ContainsメソッドとLINQのContains拡張メソッドによる要素の有無の検証
using System;
using System.Collections.Generic;
using System.Linq;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    // Stackに要素をPush
    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");

    // Stackに"CHARLIE"が含まれているか
    Console.WriteLine(s.Contains("CHARLIE"));

    // Stackに"CHARLIE"が含まれているか
    // (LINQのContainsメソッドを使い、大文字小文字の違いを無視して調べる)
    Console.WriteLine(s.Contains("CHARLIE", StringComparer.OrdinalIgnoreCase));
  }
}
実行結果
False
True

§1.4 同一の要素・nullの格納

Stackには同一の要素を複数格納することができます。 また、stringなどの参照型の場合はnull/Nothingを格納することもできます。

using System;
using System.Collections.Generic;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    s.Push("Alice");
    s.Push("Bob");
    s.Push(null); // nullをPush
    s.Push("Alice"); // 同一の要素をPush

    // Stackが空になるまで内容をPop
    while (0 < s.Count) {
      string e = s.Pop();

      Console.WriteLine(e ?? "(null)");
    }
  }
}
実行結果
Alice
(null)
Bob
Alice

intなどの値型のStackではnullを格納することはできません。 値型のStackで、値が空であることを表すためにnullを格納したいといった場合には、ヌル許容型を用いることができます。



§1.5 内容のクリア (Clear)

Stackの内容を空にするには、Clearメソッドを使います。 また、TrimExcessメソッドを呼び出すと、Stackが内部的に確保しているバッファを最小化することができます。 Clearメソッドで空にした後TrimExcessメソッドを呼び出すと、Stack内のバッファを初期状態に戻すことができます。 なお、List.CapacityのようなプロパティはStackには用意されていないため、実際にStackが保持しているバッファの容量を知ることはできません。

Stackの内容のクリア
using System;
using System.Collections.Generic;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");

    Console.WriteLine("Count = {0}", s.Count);

    // Stackの内容をクリア
    s.Clear();

    Console.WriteLine("Count = {0}", s.Count);

    // Stackが確保しているバッファを縮小
    s.TrimExcess();
  }
}
実行結果
Count = 3
Count = 0

TrimExcessメソッドはStack内の再割当てを行うことで使用するメモリを最小化します。 そのため、Stackにそれ以上変更を加えない(追加によって容量を再度拡張する必要がない)ことが明らかな場合などに用いるべきで、不必要に何度も呼び出すことはパフォーマンスの劣化に繋がります。

容量とバッファを最小化に関しては、Listクラスでの解説ジェネリックコレクション(1) List §.容量を参照してください。

§1.6 列挙操作

StackはIEnumerable<T>を実装しているためforeach文による列挙ができるようになっていますが、インデクサはサポートされないのでfor文による列挙はできません。 foreach文による列挙を行う場合は、Pushした順とは逆Popするときと同じ順で列挙されます。 Stackを列挙しても当然Pop操作とは異なり要素の削除は行われません。

foreachによるStackの内容の列挙
using System;
using System.Collections.Generic;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");
    s.Push("Dave");
    s.Push("Eve");

    // foreachでStackの内容を列挙
    foreach (string e in s) {
      Console.WriteLine(e);
    }

    Console.WriteLine("Count: {0}", s.Count);
  }
}
実行結果
Eve
Dave
Charlie
Bob
Alice
Count: 5

for文でインデックスを用いた列挙を行うためには、Stackを配列に変換することができます。

一方で、単にインデックス付きでの列挙を行えればよいのであれば、LINQの拡張メソッドSelectを使って次のようにすることもできます。

LINQのSelect拡張メソッドを使ってStackに対してインデックス付きの列挙を行う
using System;
using System.Collections.Generic;
using System.Linq;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");
    s.Push("Dave");
    s.Push("Eve");

    // Selectメソッドを使ってStackの要素をインデックス付きで列挙する
    foreach (var pair in s.Select((e, i) => new {Element = e, Index = i})) {
      Console.WriteLine("{0} => {1}", pair.Index, pair.Element);
    }
  }
}
実行結果
0 => Eve
1 => Dave
2 => Charlie
3 => Bob
4 => Alice

§1.7 配列からの変換

配列からStackに変換するには、コンストラクタが使えます。 あらかじめ内容を持った状態のStackを作成したい場合も、コンストラクタに配列などを指定してインスタンスを作成します。 コンストラクタに配列を指定した場合、Stackの内容は配列の要素を先頭から一つずつPushした場合と同じになります。

配列の内容をStackの初期内容としてインスタンスを作成する
using System;
using System.Collections.Generic;

class Sample {
  static void Main()
  {
    string[] arr = new string[] {"Alice", "Bob", "Charlie", "Dave", "Eve"};
    Stack<string> s = new Stack<string>(arr); // 配列からStackを作成

    while (0 < s.Count) {
      Console.WriteLine(s.Pop());
    }
  }
}
実行結果
Eve
Dave
Charlie
Bob
Alice

§1.8 配列への変換・コピー (ToArray・CopyTo)

Stackから配列へ変換する場合にはToArrayメソッドCopyToメソッドが使えます。 ToArrayメソッドではStackの内容を配列に変換したものが得られ、CopyToメソッドではStackの内容を既存の配列にコピーします。 変換・コピーした後の配列の内容は、列挙操作を行った場合と同様にStackの内容を一つずつPopした場合と同じ順序になります。 当然、変換・コピーの前後でStackの内容は変化しません。

ToArrayメソッドでStackを配列に変換する・CopyToメソッドでStackの内容を配列にコピーする
using System;
using System.Collections.Generic;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");
    s.Push("Dave");
    s.Push("Eve");

    // 配列に変換
    Console.WriteLine("[ToArray]");

    string[] arr1 = s.ToArray();

    for (int i = 0; i < arr1.Length; i++) {
      Console.WriteLine("arr1[{0}] => {1}", i, arr1[i]);
    }

    // 配列にコピー
    Console.WriteLine("[CopyTo]");

    string[] arr2 = new string[s.Count];

    s.CopyTo(arr2, 0);

    for (int i = 0; i < arr2.Length; i++) {
      Console.WriteLine("arr2[{0}] => {1}", i, arr2[i]);
    }
  }
}
実行結果
[ToArray]
arr1[0] => Eve
arr1[1] => Dave
arr1[2] => Charlie
arr1[3] => Bob
arr1[4] => Alice
[CopyTo]
arr2[0] => Eve
arr2[1] => Dave
arr2[2] => Charlie
arr2[3] => Bob
arr2[4] => Alice

§1.8.1 一部分の配列への変換

Stackの一部分のみを配列として取得するメソッドは用意されていません。 そのため、全部を配列に変換した後必要な部分だけを抜き出して使うか、次のようにLINQの拡張メソッドSkipおよびTakeを組み合わせて一部分のみを取得します。

LINQの拡張メソッドSkip・Takeを使ってStackの一部分を配列に変換する
using System;
using System.Collections.Generic;
using System.Linq;

class Sample {
  static void Main()
  {
    Stack<string> s = new Stack<string>();

    s.Push("Alice");
    s.Push("Bob");
    s.Push("Charlie");
    s.Push("Dave");
    s.Push("Eve");

    // Stackの1番目から3つ分を配列に変換
    // (Stackから要素1つ分をSkip、そこから要素3つをTake、その結果をToArray)
    string[] arr = s.Skip(1).Take(3).ToArray();

    for (int i = 0; i < arr.Length; i++) {
      Console.WriteLine("arr[{0}] => {1}", i, arr[i]);
    }
  }
}
実行結果
arr[0] => Dave
arr[1] => Charlie
arr[2] => Bob

§2 LinkedListを使ったスタックの実装

Stackクラス以外にも、双方向連結リストのデータ構造を構成するためのクラスであるLinkedList<T>クラスを用いることでもスタックのデータ構造を実装することができます。 具体例についてはジェネリックコレクション(4) LinkedList §.スタックとしての使用で紹介しています。