# WrappedQueue

## 概要 - Abstract

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

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

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

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

## 目次 - Index

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

## 構造体 - Structs

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

## 変数 - Variables

- なし - None -

## 関数 - Functions

文法的定義 - Signature | void clear<Type>( WrappedQueue<Type> &queue )
関数名 - Name | clear<Type>
役割 - Role | 要素を全て削除します。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体
戻り値 - Return | (void型)

文法的定義 - Signature | int size<Type>( WrappedQueue<Type> &queue )
関数名 - Name | size<Type>
役割 - Role | 使用中のサイズを返します。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体
戻り値 - Return | (int型)

文法的定義 - Signature | void enqueue<Type>( WrappedQueue<Type> &queue, Type value )
関数名 - Name | enqueue<Type>
役割 - Role | キューに要素を追加します。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体 (Type型) value : 追加する要素
戻り値 - Return | (void型)

文法的定義 - Signature | Type dequeue<Type>( WrappedQueue<Type> &queue )
関数名 - Name | dequeue<Type>
役割 - Role | キューから要素を取り出します。取り出した要素は、キューから削除されます。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体
戻り値 - Return | (Type型) 取り出した要素

文法的定義 - Signature | Type peek<Type>( WrappedQueue<Type> &queue )
関数名 - Name | peek<Type>
役割 - Role | キューから要素を削除せずに取り出します。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体
戻り値 - Return | (Type型) 取り出した要素

文法的定義 - Signature | bool contains<Type>( WrappedQueue<Type> &queue, Type element )
関数名 - Name | contains<Type>
役割 - Role | キューが指定された要素を含んでいるか判定します。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体 含まれるか判定したい要素 :
戻り値 - Return | (bool型)

文法的定義 - Signature | void reverse<Type>( WrappedQueue<Type> &queue )
関数名 - Name | reverse<Type>
役割 - Role | キューが保持する全要素の順序を反転させます。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体
戻り値 - Return | (void型)

文法的定義 - Signature | DataWrapper<Type>[ ] toDataWrapperArray<Type>( WrappedQueue<Type> &queue )
関数名 - Name | toDataWrapperArray<Type>
役割 - Role | キューが保持する全要素を、DataWrapper配列に変換して返します。
引数 - Arguments | (WrappedQueue<Type>型) queue : 対象のキュー構造体
戻り値 - Return | (DataWrapper<Type>[]型) スタックの全要素をまとめたDataWrapper配列