Stack ライブラリ
- 目次 -
概要 - Abstract
このライブラリ data.Stack は、スタック型のデータ構造を提供します。
このモジュールでは、スタックのデータを保持するジェネリック構造体 Stack と、それに対してデータを出し入れするジェネリック関数push, pop などが提供されます。
なお、この data.Stack では、配列を要素として扱う事はできません。配列を要素にしたい場合は、data.WrappedStack を使用して下さい。
目次 - Index
- struct Stack<Type>
- スタック構造体です。スタックのデータを保持します。
- void clear<Type>( Stack<Type> &stack )
- 要素を全て削除します。
- int size<Type>( Stack<Type> &stack )
- 使用中のサイズを返します。
- void push<Type>( Stack<Type> &stack, Type value )
- スタックに要素を追加します。
- Type pop<Type>( Stack<Type> &stack )
- スタックから要素を取り出します。取り出した要素は、スタックから削除されます。
- Type peek<Type>( Stack<Type> &stack )
- スタックから要素を削除せずに取り出します。
- bool contains<Type>( Stack<Type> &stack, Type element )
- スタックが指定された要素を含んでいるか判定します。
- void reverse<Type>( Stack<Type> &stack )
- スタックが保持する全要素の順序を反転させます。
- Type[ ] toArray<Type>( Stack<Type> &stack )
- スタックが保持する全要素を、1次元の配列に変換して返します。なお、順序は pop や peek で最初に得られる要素が [ 0 ] になります。
構造体 - Structs
文法的定義 - Signature |
struct Stack<Type> |
構造体名 - Name |
Stack<Type> |
役割 - Role |
スタック構造体です。スタックのデータを保持します。 |
変数 - Variables
- なし - None -
関数 - Functions
文法的定義 - Signature |
void clear<Type>( Stack<Type> &stack ) |
関数名 - Name |
clear<Type> |
役割 - Role |
要素を全て削除します。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 |
戻り値 - Return |
(void型) |
文法的定義 - Signature |
int size<Type>( Stack<Type> &stack ) |
関数名 - Name |
size<Type> |
役割 - Role |
使用中のサイズを返します。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 |
戻り値 - Return |
(int型) |
文法的定義 - Signature |
void push<Type>( Stack<Type> &stack, Type value ) |
関数名 - Name |
push<Type> |
役割 - Role |
スタックに要素を追加します。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 (Type型) value : 追加する要素 |
戻り値 - Return |
(void型) |
文法的定義 - Signature |
Type pop<Type>( Stack<Type> &stack ) |
関数名 - Name |
pop<Type> |
役割 - Role |
スタックから要素を取り出します。取り出した要素は、スタックから削除されます。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 |
戻り値 - Return |
(Type型) 取り出した要素 |
文法的定義 - Signature |
Type peek<Type>( Stack<Type> &stack ) |
関数名 - Name |
peek<Type> |
役割 - Role |
スタックから要素を削除せずに取り出します。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 |
戻り値 - Return |
(Type型) 取り出した要素 |
文法的定義 - Signature |
bool contains<Type>( Stack<Type> &stack, Type element ) |
関数名 - Name |
contains<Type> |
役割 - Role |
スタックが指定された要素を含んでいるか判定します。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 (Type型) element : 含まれるか判定したい要素 |
戻り値 - Return |
(bool型) |
文法的定義 - Signature |
void reverse<Type>( Stack<Type> &stack ) |
関数名 - Name |
reverse<Type> |
役割 - Role |
スタックが保持する全要素の順序を反転させます。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 |
戻り値 - Return |
(void型) |
文法的定義 - Signature |
Type[ ] toArray<Type>( Stack<Type> &stack ) |
関数名 - Name |
toArray<Type> |
役割 - Role |
スタックが保持する全要素を、1次元の配列に変換して返します。なお、順序は pop や peek で最初に得られる要素が [ 0 ] になります。 |
引数 - Arguments |
(Stack<Type>型) stack : 対象のスタック構造体 |
戻り値 - Return |
(Type[]型) スタックの全要素をまとめた1次元配列 |