Queue


概要 - Abstract

このライブラリ data.Queue は、キュー型のデータ構造を提供します。

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

なお、この data.Queue では、配列を要素として扱う事はできません。配列を要素にしたい場合は、data.WrappedQueue を使用して下さい。


目次 - Index

struct Queue
キュー構造体です。キューのデータを保持します。
void clear( Queue &queue )
要素を全て削除します。
int size( Queue &queue )
使用中のサイズを返します。
void enqueue( Queue &queue, Type value )
キューに要素を追加します。
Type dequeue( Queue &queue )
キューから要素を取り出します。取り出した要素は、キューから削除されます。
Type peek( Queue &queue )
キューから要素を削除せずに取り出します。
bool contains( Queue &queue, Type element )
キューが指定された要素を含んでいるか判定します。
void reverse( Queue &queue )
キューが保持する全要素の順序を反転させます。
Type[ ] toArray( Queue &queue )
キューが保持する全要素を、1次元の配列に変換して返します。

構造体 - Structs

文法的定義
- Signature
struct Queue<Type>
変数名
- Name
Queue
役割
- Role
キュー構造体です。キューのデータを保持します。

変数 - Variables

- なし - None -


関数 - Functions

文法的定義
- Signature
void clear<Type>( Queue<Type> &queue )
関数名
- Name
clear
役割
- Role
要素を全て削除します。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
戻り値
- Return
(void型)
文法的定義
- Signature
int size<Type>( Queue<Type> &queue )
関数名
- Name
size
役割
- Role
使用中のサイズを返します。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
戻り値
- Return
(int型)
文法的定義
- Signature
void enqueue<Type>( Queue<Type> &queue, Type value )
関数名
- Name
enqueue
役割
- Role
キューに要素を追加します。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
(Type型) value : 追加する要素
戻り値
- Return
(void型)
文法的定義
- Signature
Type dequeue<Type>( Queue<Type> &queue )
関数名
- Name
dequeue
役割
- Role
キューから要素を取り出します。取り出した要素は、キューから削除されます。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
戻り値
- Return
(Type型) 取り出した要素
文法的定義
- Signature
Type peek<Type>( Queue<Type> &queue )
関数名
- Name
peek
役割
- Role
キューから要素を削除せずに取り出します。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
戻り値
- Return
(Type型) 取り出した要素
文法的定義
- Signature
bool contains<Type>( Queue<Type> &queue, Type element )
関数名
- Name
contains
役割
- Role
キューが指定された要素を含んでいるか判定します。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
含まれるか判定したい要素 :
戻り値
- Return
(bool型)
文法的定義
- Signature
void reverse<Type>( Queue<Type> &queue )
関数名
- Name
reverse
役割
- Role
キューが保持する全要素の順序を反転させます。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
戻り値
- Return
(void型)
文法的定義
- Signature
Type[ ] toArray<Type>( Queue<Type> &queue )
関数名
- Name
toArray
役割
- Role
キューが保持する全要素を、1次元の配列に変換して返します。
引数
- Arguments
(Queue型) queue : 対象のキュー構造体
戻り値
- Return
(Type[]型) スタックの全要素をまとめた1次元配列