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