- ジェネリックコレクション ページ一覧
Stack
データ構造としてのスタック(stack)には、二つの操作プッシュ(push)とポップ(pop)が定義されます。 プッシュはスタックの先頭に要素を追加する操作で、ポップはスタックの先頭から要素を取り出す操作です。 この二つの操作により後入れ先出し(LIFO: Last-In, First-Out)のデータ構造が実現されます。
例を挙げると、本を一冊ずつ上に積んでいく作業がプッシュ、積まれた本を一冊ずつ上から取っていく作業がポップに相当します。
.NETにおいて、スタックのデータ構造を持つコレクションクラスがSystem.Collections.Generic.Stackクラスです。
Stackクラスに要素を追加するプッシュの操作はPushメソッド、Stackから要素を取り出すポップの操作はPopメソッドで行います(§.プッシュ操作とポップ操作 (Push/Pop))。 Stackから要素をポップすると、取り出した要素はStackから削除されます。 Stackから要素を取り出さずに参照だけ行う場合はPeekメソッドを使います。 Stackに現在いくつの要素が含まれているかを知るにはCountプロパティを参照します。
ListクラスやDictionaryクラスとは異なり、Stackクラスでは要素が格納された順序が大きな意味を持ちます。 最初(または最後)に格納された要素のみに着目するため、インデックスを指定した要素へのアクセス(ランダムアクセス)はできません(§.インデックス付きの列挙操作)。 また、Stackに格納される要素は格納された順に並べられ、格納された後はその順序を並べ替えることはできません。
Listなどと同様、Stackは可変長のコレクションであるため任意の数の要素をプッシュできます。 プッシュの際、Stack内部の容量は必要に応じて自動的に拡充されます。 ポップの際に要素数が減っても、明示的に指示しない限りはStack内部で確保されている容量が減ることはありません。
JavaScriptなど他のスクリプト言語では、配列をスタックやキューのように扱うための操作が用意されているものもありますが、Stackクラスではスタックとしての操作しか提供されません。 つまり、Stackクラスに対してunshift/shift操作を行うようなメソッドは用意されていません。 そういった操作を行いたい場合はQueueクラスを使用します。
プッシュ操作とポップ操作 (Push/Pop)
Stackクラスでは、PushメソッドでStackに対して要素の追加(プッシュ操作)、PopメソッドでStackからの要素の取り出し(ポップ操作)を行います。
次の例では、3つの要素をStackにプッシュし、その後Stackが空になるまでポップしています。 スタックでは一番最後に入れた要素は一番始めに取り出される(Last-In, First-Out)という特性上、要素を入れた順番とは逆の順番で表示されている点に注目してください。
Stackでもforeachによる列挙操作を行うことができます。 Stackの内容をforeachで列挙すると、Pushしたのと逆順、つまりPopする場合と同様の順序で要素が列挙されます。
空のStackに対するPop
Stackが空のときにPopメソッドを呼び出すと、null
/Nothing
が返されるのではなく、例外InvalidOperationExceptionがスローされます。 このため、Popメソッドの戻り値からStackが空だったかどうかを判断することはできません。
Stackが空かどうかに関わらず、例外をスローせずにポップ操作を試行するメソッドとしてTryPopメソッドが用意されています。
このほか、PopメソッドでInvalidOperationExceptionを避けるには、Popメソッドを呼び出す前にCountプロパティを参照して、要素が1つ以上格納されているかチェックするようにします。
ポップ操作の試行 (TryPop)
Stackが空のときにPopメソッドを呼び出すと、例外InvalidOperationExceptionがスローされます。 一方、TryPopメソッドを使うと、Stackが空の場合でも例外をスローさせずにポップ操作を試行することができます。 TryPopメソッドは.NET Standard 2.1/.NET Core 2.0以降で使用できます。
TryPopメソッドは、成功した場合はポップした要素をoutパラメータで出力し、戻り値true
を返します。 失敗した場合、つまりStackが空だった場合は単に戻り値false
を返します。
ピーク操作 (Peek)
PopメソッドはStackの先頭にある要素を取り出して取得しますが、Peekメソッドを使うとStackの内容を変更せず(Stackから削除せず)に先頭にある要素を参照できます。
foreachなどによる列挙操作では、Stackの状態を変更せずにStackに格納されているすべての内容を参照することができます。
Popメソッドと同様に、Stackの内容が空の場合にPeekメソッドを呼び出すと、例外InvalidOperationExceptionがスローされます。
したがって、Peekメソッドの戻り値を見てStackが空かどうかを判断することはできません。 Stackが空であるかどうかを判断するにはPeekメソッドではなくCountプロパティを参照します。
ピーク操作の試行 (TryPeek)
TryPopメソッドと同様に、TryPeekメソッドを使うと、Stackが空の場合でも例外をスローさせずにピーク操作を試行することができます。 TryPeekメソッドは.NET Standard 2.1/.NET Core 2.0以降で使用できます。
要素数の取得 (Count)
Stackに現在格納されている要素の数を取得するには、Countプロパティを参照します。 Stackが空の状態、何も格納されていない状態の場合は、当然Countプロパティは0となります。
要素の有無の検証 (Contains)
Stackに指定した内容の要素が含まれているか調べるには、Containsメソッドを使います。
ただし、このメソッドではIEqualityComparerを指定できないため、Dictionaryのように大文字小文字の違いを無視して比較するといったことはできません。 そういった比較条件を指定した上で要素が含まれているかを調べるには、LINQの拡張メソッドContainsなどを使う必要があります。
文字列の比較オプション(StringComparer)については文字列と比較オプション・カルチャの並べ替え規則、IEqualityComparer<T>インターフェイスによる同値比較のカスタマイズについては等価性の定義と比較 §.IEqualityComparer, IEqualityComparer<T>を参照してください。
同一の要素の格納
Stackには同一の要素(値)を複数格納することができます。 同じ要素を複数回Pushした場合でもそれぞれ個別の要素として扱われます。
null
/Nothing
の格納
stringなどの参照型を格納するStackの場合はnull
/Nothing
を格納することもできます。
intなどの値型を格納するStackの場合、C#ではnull
を格納することはできません。 VBではNothing
を格納しようとすると、Nothing
そのものではなく、0
などその型のデフォルト値が格納されます。
値型の値を格納するStackで、値が空であることを表すためにnull
/Nothing
を格納したいといった場合には、ヌル許容型を用いることができます。
内容のクリア (Clear)
Clearメソッドを呼び出すことで、Stackの内容を空にすることができます。
TrimExcessメソッドを使うことで、Stack内部で確保されているバッファを最小化することができます。
容量の縮小 (TrimExcess)
Stackに対してそれ以上要素を追加や取り出しをする必要がなくなった場合には、TrimExcessメソッドを呼び出すことで、Stackが内部的に確保しているバッファを最小化することができ、不要な容量を減らすことができます。
TrimExcessメソッドはStack内の再割当てを行うことで使用するメモリを最小化します。 そのため、Stackにそれ以上変更を加えない(追加によって容量を再度拡張する必要がない)ことが明らかな場合などに用いるべきで、不必要に何度も呼び出すことは逆にパフォーマンスの劣化に繋がります。
なお、List.CapacityのようなプロパティはStackには用意されていないため、実際にStackが確保しているバッファの容量を知ることはできません。
容量とバッファを最小化に関しては、Listクラスでの解説ジェネリックコレクション(1) List §.容量を参照してください。
列挙操作
StackはIEnumerable<T>を実装しているためforeach文による列挙ができます。 foreach文による列挙では、Pushした順とは逆、つまりPopするときと同じ順で要素が列挙されます。 ポップ操作とは異なり、Stackを列挙するだけでは要素の削除は行われません。
インデックス付きの列挙操作
一方、Stackではインデクサがサポートされないのでfor文による列挙はできません。 for文でインデックスを用いた列挙を行うためには、Stackを配列に変換してから列挙するか、LINQの拡張メソッドSelectを使って次のようにします。
配列からの変換
配列からStackに変換するには、コンストラクタが使えます。 あらかじめ内容を持った状態のStackを作成したい場合も、コンストラクタに配列などを指定してインスタンスを作成します。 コンストラクタに配列を指定した場合、Stackの内容は配列の要素を先頭から一つずつPushした場合と同じになります。
配列への変換・コピー (ToArray・CopyTo)
Stackから配列へ変換する場合にはToArrayメソッドやCopyToメソッドが使えます。 ToArrayメソッドではStackの内容を配列に変換したものが得られ、CopyToメソッドではStackの内容を既存の配列にコピーします。 変換・コピーした後の配列の内容は、列挙操作を行った場合と同様にStackの内容を一つずつPopした場合と同じ順序になります。 当然、変換・コピーの前後でStackの内容は変化しません。
一部分の配列への変換
Stackの一部分のみを配列として取得するメソッドは用意されていません。 そのため、全部を配列に変換した後必要な部分だけを抜き出して使うか、次のようにLINQの拡張メソッドSkipおよびTakeを組み合わせて一部分のみを取得します。
LinkedListを使ったスタックの実装
Stackクラス以外にも、双方向連結リストのデータ構造を構成するためのクラスであるLinkedList<T>クラスを用いることでもスタックのデータ構造を実装することができます。 具体例についてはジェネリックコレクション(4) LinkedList §.スタックとしての使用で紹介しています。