WrappedStack ライブラリ
- 目次 -
概要
このライブラリ data.WrappedStack は、スタック型のデータ構造を提供します。
このモジュールでは、スタックのデータを保持するジェネリック構造体 WrappedStack と、それに対してデータを出し入れするジェネリック関数 push, pop などが提供されます。
なお、この data.WrappedStack では、要素を DataWrapper 構造体でラッピングして保持する実装になっています。
そのため WrappedStackでは、 data.Stack とは異なり、配列を要素として扱う事ができます。
反面、要素の出し入れの際に DataWrapper 構造体へのラッピング処理を伴うため、そのオーバーヘッドの分だけ、Stack よりも処理が重くなります。
従って、要素が配列でない場合には、WrappedStack よりも Stack の使用が推奨されます。
目次
- struct WrappedStack<Type>
- スタック構造体です。スタックのデータを保持します。
- void clear<Type>( WrappedStack<Type> &stack )
- 要素を全て削除します。
- int size<Type>( WrappedStack<Type> &stack )
- 使用中のサイズを返します。
- void push<Type>( WrappedStack<Type> &stack, Type value )
- スタックに要素を追加します。
- Type pop<Type>( WrappedStack<Type> &stack )
- スタックから要素を取り出します。取り出した要素は、スタックから削除されます。
- Type peek<Type>( WrappedStack<Type> &stack )
- スタックから要素を削除せずに取り出します。
- bool contains<Type>( WrappedStack<Type> &stack, Type element )
- スタックが指定された要素を含んでいるか判定します。
- void reverse<Type>( WrappedStack<Type> &stack )
- スタックが保持する全要素の順序を反転させます。
- DataWrapper<Type>[ ] toDataWrapperArray<Type>( WrappedStack<Type> &stack )
- スタックが保持する全要素を、DataWrapper配列に格納して返します。なお、順序は pop や peek で最初に得られる要素を格納するものが [ 0 ] になります。
構造体
|
構造体名
|
WrappedStack<Type>
|
|
宣言形式
|
struct WrappedStack<Type>
|
|
説明
|
スタック構造体です。スタックのデータを保持します。
|
変数
- なし -
関数
|
関数名
|
clear<Type>
|
|
宣言形式
|
void clear<Type>( WrappedStack<Type> &stack )
|
|
説明
|
要素を全て削除します。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体
|
|
戻り値
|
(void型)
|
|
関数名
|
size<Type>
|
|
宣言形式
|
int size<Type>( WrappedStack<Type> &stack )
|
|
説明
|
使用中のサイズを返します。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体
|
|
戻り値
|
(int型)
|
|
関数名
|
push<Type>
|
|
宣言形式
|
void push<Type>( WrappedStack<Type> &stack, Type value )
|
|
説明
|
スタックに要素を追加します。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体 (Type型) value : 追加する要素
|
|
戻り値
|
(void型)
|
|
関数名
|
pop<Type>
|
|
宣言形式
|
Type pop<Type>( WrappedStack<Type> &stack )
|
|
説明
|
スタックから要素を取り出します。取り出した要素は、スタックから削除されます。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体
|
|
戻り値
|
(Type型) 取り出した要素
|
|
関数名
|
peek<Type>
|
|
宣言形式
|
Type peek<Type>( WrappedStack<Type> &stack )
|
|
説明
|
スタックから要素を削除せずに取り出します。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体
|
|
戻り値
|
(Type型) 取り出した要素
|
|
関数名
|
contains<Type>
|
|
宣言形式
|
bool contains<Type>( WrappedStack<Type> &stack, Type element )
|
|
説明
|
スタックが指定された要素を含んでいるか判定します。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体 (Type型) element : 含まれるか判定したい要素
|
|
戻り値
|
(bool型)
|
|
関数名
|
reverse<Type>
|
|
宣言形式
|
void reverse<Type>( WrappedStack<Type> &stack )
|
|
説明
|
スタックが保持する全要素の順序を反転させます。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体
|
|
戻り値
|
(void型)
|
|
関数名
|
toDataWrapperArray<Type>
|
|
宣言形式
|
DataWrapper<Type>[ ] toDataWrapperArray<Type>( WrappedStack<Type> &stack )
|
|
説明
|
スタックが保持する全要素を、DataWrapper配列に格納して返します。なお、順序は pop や peek で最初に得られる要素を格納するものが [ 0 ] になります。
|
|
引数
|
(WrappedStack<Type>型) stack : 対象のスタック構造体
|
|
戻り値
|
(DataWrapper<Type>[]型) スタックの全要素をまとめたDataWrapper配列
|