Simplestar Game

:::::::::::020話　クラス・テンプレート:::::::::::

お久しぶりです，星姫です！
今回はC++言語の「これがあるからC++だ！」っていう機能を触ります．
最初はタイトルの「クラス・テンプレートとは何ぞや？」から始めて
最終的に「テンプレートって便利かも！」と納得していただける内容になってます。（…たぶん）

さてさて、シンプルスター先生が社会人になって初めてのレッスンです。
フレッシュに行きましょう、フレッシュに（笑）

では本題に入ります．
前回は、クラスに演算子関数を追加できることを示しました。
クラスについては使い慣れてきたころ？（構造体に関数を持たせることができるモノという理解でOK）
そこに新しく「テンプレート」っていうキーワードが入ります、テンプレートについてまず説明します。

intやdoubleなど、そのほか構造体やクラスといったデータのことを「型」って呼んだりします。
これら無数にある型を一緒くたに扱うとき（そんなこと出来るのか？）、その不定の型
（仮の型）をテンプレートパラメータと呼びます。
使われ方は、関数の引数や戻り値の型としてテンプレートパラメータが書かれます。…とか言われてもわかんないよね。
そこで、書式は以下の通りなので参考に書いてみてください。

main.cpp

/**************************************************************************//** @file main.cpp @brief テンプレートの書式と使用例 @author ☆-HIME @date 2010-04-18 @par [説明] ≪STG 第20話≫ ソースコード @note Copyright (C) 2010 SIMPLESTAR GAME. *//***************************************************************************/ #include <iostream> using namespace std; /**********************************************************************//** @brief テンプレートパラメータをコンソール出力する関数 @param[in] tmpdt テンプレートパラメータ *//***********************************************************************/ template <typename T> void Display(T tmpdt) { cout << "tmpdt = " << tmpdt << endl; return; } /**********************************************************************//** @brief エントリポイント @param[in] argc コマンドライン引数の数 @param[in] argv コマンドライン引数文字列配列のポインタ @return 正常終了時0を返す *//***********************************************************************/ int main(int argc, char *argv[]) { // 様々なデータ型で出力できるかテスト Display<char>( 'A' ); Display<int>( 'A' ); // int型で出力されるので65になる Display<int>( 10 ); Display<float>( 3.14f ); Display<double>( 2.71828 ); return 0; }

このソースプログラムのコンソール出力結果は以下の通りです。

ここで示したのが「関数・テンプレート」です。要は関数の引数の型がが'T'というテンプレートパラメータとなってます。
前にちょいとtemplate と書くだけで'T'をテンプレートパラメータと認識してくれるんです。便利です。
あれ！( 'A' );が65！？
( 'A' );が65で出力される理由を調べると「ASCII文字コード」のキーワードにたどりつくと思います。

「ASCII文字コード」

ところで、これ( 'A' );なんか顔文字みたいですね。

関数テンプレートである程度機能を確かめたのなら、関数ではなくクラスで書いてみましょう。
ここからが本題、以下に例を示します。

main.cpp

/**************************************************************************//** @file main.cpp @brief テンプレートの書式と使用例 @author ☆-HIME @date 2010-04-18 @par [説明] ≪STG 第20話≫ ソースコード @note Copyright (C) 2010 SIMPLESTAR GAME. *//***************************************************************************/ #include <iostream> using namespace std; /**********************************************************************//** @class ClassTemplate @brief テンプレートをテストするクラス @par [説明] ≪STG 第20話≫ テンプレートをテストするクラス *//***********************************************************************/ template <typename T> class ClassTemplate { private: T m_data; /*!< テンプレート型のデータ */ public: explicit ClassTemplate(const T& data); //!< コンストラクタ virtual ~ClassTemplate(); //!< デストラクタ void Display() const; //!< テンプレート型のデータの出力 }; /**********************************************************************//** @brief コンストラクタ @param[in] data プロパティに設定するデータ *//***********************************************************************/ template <typename T> ClassTemplate<T>::ClassTemplate(const T& data) : m_data(data) { } /**********************************************************************//** @brief デストラクタ *//***********************************************************************/ template <typename T> ClassTemplate<T>::~ClassTemplate() { } /**********************************************************************//** @brief テンプレート型のデータの出力を行う関数 *//***********************************************************************/ template <typename T> void ClassTemplate<T>::Display() const { cout << "m_data = " << m_data << endl; return; } /**********************************************************************//** @brief エントリポイント @param[in] argc コマンドライン引数の数 @param[in] argv コマンドライン引数文字列配列のポインタ @return 正常終了時0を返す *//***********************************************************************/ int main(int argc, char *argv[]) { // 様々なデータ型で出力できるかテスト ClassTemplate<char> clsChar('A'); ClassTemplate<int> clsCharToInt('A'); ClassTemplate<int> clsInt(10); ClassTemplate<float> clsFloat(3.14f); ClassTemplate<double> clsDouble(2.71828); // 出力テスト clsChar.Display(); clsCharToInt.Display(); // int型で出力されるので65になる clsInt.Display(); clsFloat.Display(); clsDouble.Display(); return 0; }

このソースプログラムのコンソール出力結果は以下の通りです。

こんな感じで、様々なデータ型を扱えるクラス「クラス・テンプレート」が実装できます。
どんな型のデータでも処理できるクラス、これはとっても便利です！

さてSTL（標準テンプレートライブラリ）って単語をご存知ですか？
今回はその便利さ、使い勝手の良さを知ってもらおうと思います
ということで、最後はlist（リスト）の使用例をのせて終わりにしたいと思います。

listTest.cpp

/**************************************************************************//** @file listTest.cpp @brief リストを使ってみようのコード @author ☆-HIME @date 2010-04-29 @par [説明] ≪STG 第20話≫ ソースコード @note Copyright ©, 2010 SIMPLE STAR GAME *//***************************************************************************/ //------------------------------------------------------------------------ // File Dependencies //------------------------------------------------------------------------ #include <iostream> #include <list> //------------------------------------------------------------------------ // namespace Dependencies //------------------------------------------------------------------------ using namespace std; void DisplayList(const list<int>& obj); // リストの中身をコンソール出力します /**********************************************************************//** @brief エントリポイント @param[in] コマンドライン引数の数 @param[in] コマンドライン引数配列へのポインタ @return アプリケーション終了ステート *//***********************************************************************/ int main(int argc, char *argv[]) { list<int> myList; // ここで整数型のリストオブジェクトを宣言します // 10回乱数をプッシュします。（プッシュ…整数データを配列の末尾から突っ込むイメージ？） for(int i=0;i<10;++i) { myList.push_back(rand()%20); } cout << "データを入れた時："; DisplayList(myList); // ソートします（わかるかな？昇順にデータを並べ替えることです） myList.sort(); cout << "ソートを行った後："; DisplayList(myList); return 0; } /**********************************************************************//** @brief 引数のリストオブジェクトの中身を表示する関数 @param[in] リストオブジェクト（const参照） *//***********************************************************************/ void DisplayList(const list<int>& obj ) { // イテレータっていうのだけど、そいつを介してリストの中身にアクセスします list<int>::const_iterator iter; // とりあえず中身を見てみましょう for(iter = obj.begin();iter != obj.end();++iter) { cout << " " << *iter ; } cout << endl; return; }

このソースプログラムのコンソール出力結果は以下の通りです。

listというキーワードに関連して他にもvectorとか聞きますね。
プログラム言語を覚えたてのころ、配列の操作に戸惑うはず！
そんな悩みを一挙解決してくれるのがSTL
STLを使えるようになってみてはいかが？
使い方に迷ったら、以下のリンク先で調べると良いです。

「cplusplus.com」

STLにも9つ種類があり、それぞれが沢山の機能を持っていますので全て覚えてる人はそうはいません。
書式も独特だったりするので、まずは使い方をここで調べるといいですね。

今回習ったクラステンプレートとリストの作りは似ています。というか、多分同じように作られています。
クラステンプレート・演算子関数を駆使すれば作れます。
最近になって初めて作ったのですが、これがまた面白かった。
興味ある方は、ぜひ作ってみましょう。
次はプログラム作成時に役立つツールを紹介したいと思います。

2010/04/18 初記．
2010/04/29 追記．
2010/06/12 追加。