WrappedStack


概要 - Abstract

このモジュール open.data.WrappedStack は、スタック型のデータ構造を提供します。

このモジュールでは、スタックのデータを保持するジェネリック構造体 WrappedStack と、それに対してデータを出し入れするジェネリック関数 push, pop などが提供されます。

なお、この open.data.WrappedStack では、要素を DataWrapper 構造体でラッピングして保持する実装になっています。
そのため WrappedStackでは、 open.data.Stack とは異なり、配列を要素として扱う事ができます。

反面、要素の出し入れの際に DataWrapper 構造体へのラッピング処理を伴うため、そのオーバーヘッドの分だけ、Stack よりも処理が重くなります。
従って、要素が配列でない場合には、WrappedStack よりも Stack の使用が推奨されます。


構造体 - Structs

宣言
- Declaration
struct WrappedStack<Type>
詳細
- Description
スタック構造体です。スタックのデータを保持します。

変数 - Variables

- なし - None -


関数 - Functions

宣言
- Declaration
void clear<Type>( WrappedStack<Type> &stack )
詳細
- Description
要素を全て削除します。
引数
- Arguments
stack : 対象のスタック構造体
宣言
- Declaration
int size<Type>( WrappedStack<Type> &stack )
詳細
- Description
使用中のサイズを返します。
引数
- Arguments
stack : 対象のスタック構造体
宣言
- Declaration
void push<Type>( WrappedStack<Type> &stack, Type value )
詳細
- Description
スタックに要素を追加します。
引数
- Arguments
stack : 対象のスタック構造体
value : 追加する要素
宣言
- Declaration
Type pop<Type>( WrappedStack<Type> &stack )
詳細
- Description
スタックから要素を取り出します。取り出した要素は、スタックから削除されます。
引数
- Arguments
stack : 対象のスタック構造体
戻り値
- Return
取り出した要素
宣言
- Declaration
Type peek<Type>( WrappedStack<Type> &stack )
詳細
- Description
スタックから要素を削除せずに取り出します。
引数
- Arguments
stack : 対象のスタック構造体
戻り値
- Return
取り出した要素
宣言
- Declaration
bool contains<Type>( WrappedStack<Type> &stack, Type element )
詳細
- Description
スタックが指定された要素を含んでいるか判定します。
引数
- Arguments
stack : 対象のスタック構造体
element : 含まれるか判定したい要素
宣言
- Declaration
void reverse<Type>( WrappedStack<Type> &stack )
詳細
- Description
スタックが保持する全要素の順序を反転させます。
引数
- Arguments
stack : 対象のスタック構造体
宣言
- Declaration
DataWrapper<Type>[] toDataWrapperArray<Type>( WrappedStack<Type> &stack )
詳細
- Description
スタックが保持する全要素を、DataWrapper配列に格納して返します。なお、順序は pop や peek で最初に得られる要素を格納するものが [ 0 ] になります。
引数
- Arguments
stack : 対象のスタック構造体
戻り値
- Return
スタックの全要素をまとめたDataWrapper配列