としおの読書生活

田舎に住む社会人の読書記録を綴ります。 主に小説や新書の内容紹介と感想を書きます。 読書の他にもワイン、紅茶、パソコン関係などの趣味を詰め込んだブログにしたいです。

カテゴリ: C++

3753817_s

C++の実行時間を計測するときにWindowsだとどうしたらいいのか迷うことが多かったので、精度別の実行時間の計測方法をまとめていきます。



clock(10ミリ秒程度)


clockはC言語でも使用できる標準形の関数で、プログラム実行開始からの経過時間をミリ秒単位で返します。

精度は処理系に依存しますが、Windowsでは10ミリ秒程度です。

C言語の標準ライブラリに含まれる関数なのでWindows以外でも使える点が嬉しいです。

以下は、実行時間計測のサンプルプログラムです。

#include <iostream>
#include <vector>
#include <time.h>

using namespace std;

int main(void){    
    clock_t start = clock();

    // 計測対象(今回はvectorに1000000個要素を追加する)
    vector<inttestVec;
    for (int i=0i<1000000; ++i){
        testVec.push_back(i);
    }
    clock_t end = clock();

    cout << end-start << endl;


    return 0;
}



timeGetTime(1ミリ秒)


timeGetTimeはWin32 APIで用意されている関数で、システム起動開始からの経過時間をミリ秒単位で返します。

精度は1ミリ秒程度です。

timeGetTimeを使用するためには、windows.hのインクルードと、winmm.libのリンクが必要です。

以下は、実行時間計測のサンプルプログラムです。

#include <iostream>
#include <vector>
#include <windows.h>

using namespace std;

int main(void){    
    DWORD start = timeGetTime();

    // 計測対象(今回はvectorに1000000個要素を追加する)
    vector<inttestVec;
    for (int i=0i<1000000; ++i){
        testVec.push_back(i);
    }
    DWORD end = timeGetTime();

    cout << end-start << endl;


    return 0;
}






QueryPerformanceCounter(マイクロ秒)


こちらもtimeGetTimeと同様にWin32 APIで用意されている関数です。

精度は環境に依存しますが、マイクロ秒~10ナノ秒程度で、Windowsで使える時間計測の方法で最も精度が高いです。

しかし、実行時間の計測開始前にQueryPerformanceFrequency関数でカウントアップする周波数を取得するなど少し他のAPIに比べて手間がかかるという欠点もあります。

以下は、実行時間計測のサンプルプログラムです。

#include <iostream>
#include <vector>
#include <windows.h>

using namespace std;

int main(void){    
    LARGE_INTEGER frequency;
    QueryPerformanceFrequency(&frequency);

    LARGE_INTEGER start;
    QueryPerformanceCounter(&start);

    // 計測対象(今回はvectorに1000000個要素を追加する)
    vector<inttestVec;
    for (int i=0i<1000000; ++i){
        testVec.push_back(i);
    }
    
    LARGE_INTEGER end;
    QueryPerformanceCounter(&end);

    cout << (double)(end.QuadPart - start.QuadPart) / frequency.QuadPart << endl

    return 0;
}



まとめ


今回はWindows環境でC++の実行時間を計測する方法をまとめました。

Linuxと違ってナノ秒単位で正確に計測することはできませんが、QueryPerformanceCounterを使えばかなり正確に実行時間が計測できることが分かりました。

他にも良い計測方法があればコメントで教えていただけますと幸いです。



3753817_s


C++でvectorに対してループを行う方法が色々あります。

今回は、どの書き方が一番効率が良いのかが気になったので調べてみました。




カウンタ方式


カウンタ変数を用意して、データにアクセスする方式。

今回時間の計測は、windows APIのQueryPerformanceCounterを使用して計測します。

「計測対象」とコメントで書かれている部分のループが実行時間の計測対象になります。
カウンタ方式以外では計測対象以外の部分のコードは省略します。

#include <iostream>
#include <vector>
#include <windows.h>

#define LOOPNUM 1000000
using namespace std;

int main(void){
    vector<inttestVec;
    for(int i=0i<LOOPNUM; ++i){
        testVec.push_back(i);
    }

    LARGE_INTEGER frequency;
    QueryPerformanceFrequency(&frequency);

    LARGE_INTEGER start;
    QueryPerformanceCounter(&start);

    // 計測対象
    for(int i=0i<testVec.size(); ++i){
        int a = testVec[i];
    }

    LARGE_INTEGER end;
    QueryPerformanceCounter(&end);

    DWORD end_tm = timeGetTime();
    std::cout << (double)(end.QuadPart - start.QuadPart) / frequency.QuadPart * 1000000 << std::endl

    return 0;
}



イテレータ方式


C++のコンテナクラスのイテレータを使用してデータにアクセスする方式。

for(auto itr=testVec.begin(); itr!=testVec.end(); ++itr){
    int a = *itr;
};



範囲ベース方式


範囲ベース方式は、C++ 11で追加されたコンテナオブジェクトの範囲分ループを行うという方式。

for(intvec : testVec){
    int a = vec;
}



for_each


for_eachは範囲内の全てのイテレータに特定の関数を適用させるときに使用する方法。

void substitute(int x){
    int a = x;
}

for_each(testVec.begin(), testVec.end(), substitute);






実行時間計測結果


今回は、最適化なしと最適化ありでそれぞれ10回ずつ計測して、平均値を実行時間とします。

vectorのサイズは1000000、実行時間の単位はμs(マイクロ秒)です。

実行時間(μs)
カウンタ方式2400.42
イテレータ方式7285.76
範囲ベース方式5402.42
for_each66284.8


最適化なしだとカウンタ方式が最速ということになりました。

余談になりますが、最適化オプション最高(-Ofast オプション)でコンパイルして、実行してみたところ全ての実行時間が0.1μs未満になり正確に計測できませんでした。

最適化オプション込みで実行時間を比較するにはどうすればよかったのだろうか…。



まとめ


今回はvectorのループの実行時間を計測していきました。

最適化オプションなしでの計測になってしまいましたが、Debug環境ではカウンタ方式が最速みたいです。

正直イテレータとかの方が早いのかなと思っていたので意外な結果になりました。



3753817_s


本記事では、デザインパターンの名著である結城浩さんの『Javaで学ぶデザインパターン入門』を参考にFactory Method(ファクトリ・メソッド)をC++で実装していきます。




Factory Methodとは


Factory Methodとは、Template Methodをインスタンス生成の場面に適用したものです。

Factoryは、工場という意味です。

要するにFactory Methodとは、インスタンスを生成するための工場のようなデザインパターンだと思ってください。






Factory Methodの登場人物


Factory Methodは以下のようなクラス構成になっています。


factoryMethod


Product


Factory Methodで生成されるインスタンスが持つべきAPIを定義する抽象クラスです。

APIの具体的な実装は、ConcreateProductでクラスで行います。


Creator


Productを生成する抽象クラスです。

Crateorクラスは、Createメソッドで実際に生成する、ConcreteProductについては何も知りませんが、インスタンスを生成するメソッドを作ることでこの問題を解決しています。


ConcreteProduct


ConcreteProductは実際に生成される具体的な製品の役です。


ConcreteCreator


ConcreteCreatorは実際にConcreteProductを生成する役です。



C++による実装


今回は、IDカードを製造する工場というイメージでプログラムをFactory Methodを使用して実装していきます。

クラス構成は以下の通りです。


factoryMethodSample



Productクラス


Productクラスは抽象クラスとして実装していきます。


ヘッダファイル

#ifndef PRODUCT_H
#define PRODUCT_H

class Product{
public:
    virtual void use()=0;
};
#endif // PRODUCT_H



Factoryクラス


createメソッドでは、インスタンスを生成するcreateProductMethodを呼び出し、生成したインスタンスをregisterProductで登録するという処理を行います。

createメソッド以外の具体的な実装は子クラスで行います。今回の場合は、IDCardFactoryクラスが子クラスにあたります。

createMethodは継承先でオーバーライドされないようにfinalを使って宣言します。

ヘッダファイル

#ifndef FACTORY_H
#define FACTORY_H

#include <iostream>

class Product;

class Factory{
public:
    virtual Product* create(std::string ownerfinal;
    virtual Product* createProduct(std::string owner)=0;
    virtual void registerProduct(Product* product)=0;
};
#endif // FACTORY_H


ソースファイル

#include "Factory.h"
#include "Product.h"

Product* Factory::create(std::string owner){
    Productp = createProduct(owner);
    registerProduct(p);
    return p;
}






IDCardクラス


IDCardクラスはProductクラスを継承して作る、具体的な製品のクラスです。

今回は、useメソッドでカードを使い、getOwnerメソッドでカードの持ち主の名前を返します。

ヘッダファイル

#ifndef IDCARD_H
#define IDCARD_H

#include <iostream>
#include "Product.h"

class IDCard : public Product{
public:
    IDCard(std::string owner);
    ~IDCard();
    void use() final;
    std::string getOwner();
    
private:
    std::string m_owner;
};
#endif // IDCARD_H


ソースファイル

#include <iostream>
#include "IDCard.h"

IDCard::IDCard(std::string owner)
m_owner(owner)
{
    std::cout << owner << "のカードを作ります。" << std::endl;
};

IDCard::~IDCard(){};

void IDCard::use(){
    std::cout << m_owner << "のカードを使います。" << std::endl;
}

std::string IDCard::getOwner(){
    return m_owner;
}



IDCardFactoryクラス


IDCardFactoryクラスではcreateProductメソッドの具体的な実装を行っています。

このメソッドではIDCardのインスタンスを生成します。

また、registerOwnerでは生成したインスタンスを登録します。

ヘッダファイル

#ifndef IDCARDFACTORY_H
#define IDCARDFACTORY_H

#include <iostream>
#include <list>
#include "Factory.h"

class Product;

class IDCardFactory : public Factory{
public:
    IDCardFactory();
    ~IDCardFactory();
    Product* createProduct(std::string owner);
    void registerProduct(Product* product);
    std::list<std::stringgetOwners();
    
private:
    std::list<std::stringm_owners;
};
#endif // IDCARD_H


ソースファイル

#include "IDCardFactory.h"
#include "Product.h"
#include "IDCard.h"

IDCardFactory::IDCardFactory(){};

IDCardFactory::~IDCardFactory(){};

Product* IDCardFactory::createProduct(std::string owner){
    return new IDCard(owner);
}

void IDCardFactory::registerProduct(Product* product){
    m_owners.push_back(dynamic_cast<IDCard*>(product)->getOwner());
}

std::list<std::stringIDCardFactory::getOwners(){
    return m_owners;
}



main関数


今まで作成してきたクラスを実際に使っていきます。

ソースファイル

#include "Factory.h"
#include "Product.h"
#include "IDCardFactory.h"
#include "IDCard.h"

int main(void){
    Factory *factory = new IDCardFactory();
    Product *card1 = factory->create("としお");
    Product *card2 = factory->create("ひろし");
    Product *card3 = factory->create("花子");
    card1->use();
    card2->use();
    card3->use();

    return 0;
}


実行結果

としおのカードを作ります。
ひろしのカードを作ります。
花子のカードを作ります。  
としおのカードを使います。
ひろしのカードを使います。
花子のカードを使います。




まとめ


今回は、Template Methodを応用したFactory MethodはTemplate Methodを実装していきました。

似たようなクラスを複数個生成するときなどに便利なデザインパターンでした。

有効に活用できる場面を分析すれば、とても役にたつのでぜひ使ってみてください。









3753817_s

本記事では、デザインパターンの名著である結城浩さんの『Javaで学ぶデザインパターン入門』を参考にテンプレートメソッド(Template Method)をC++で実装していきます。




テンプレートメソッドとは


テンプレートメソッドとは、テンプレートの機能を持つメソッドが親クラスで定義されており、そのメソッドの中の中小メソッドを子クラスで実装する方法です。

例えばRPGの戦闘をテンプレートメソッドを使って実装するとします。

ここでは戦闘は以下の流れで行うとします。
  1. 移動
  2. 攻撃
移動と攻撃の方法はRPGでいう戦士や魔法使いの役職で変わるとします。

そこで、親クラスで先ほどの戦闘の流れを呼ぶためのテンプレートメソッドと移動と攻撃の抽象メソッドを定義します。

そして、子クラスとして戦士クラスや魔法使いクラスを用意して、移動や攻撃の具体的な実装を行っていきます。


このようにスーパークラスで処理の枠組みを定め、サブクラスでその具体的な内容を定めるデザインパターンをテンプレートメソッドパターン(Template Method)と呼びます。



テンプレートメソッドの登場人物


テンプレートメソッドパターンは以下のようなクラス構成になっています。


テンプレートメソッド



AbstractClass(抽象クラス)


AbstractClass役はテンプレートメソッドを実装します。

また、テンプレートメソッドの他にテンプレートメソッドで使用している抽象メソッドも宣言します。

これらの抽象メソッドの具体的な実装は子クラスであるConcreateClassによって行われます。


ConcreateClass(具象クラス)


AbstractClassで宣言された抽象メソッドを具体的に実装する役です。

ここで実装したメソッドがAbstractClassのテンプレートメソッドにより、呼び出されます。





C++による実装


今回は、文字列や文字を5回表示するといったプログラムをテンプレートメソッドパターンを使用して実装していきます。

クラス構成は以下の通りです。


テンプレートメソッド_sample


AbstractDisplayクラス


今回のサンプルプログラムではAbstractDisplayクラスがテンプレートクラスにあたります。

具体的な実装は、displayメソッドだけ行います。

displayメソッドは、「open → printを5回呼ぶ → close」という流れのメソッドになります。

■ヘッダファイル

#ifndef ABSTRACT_DISPLAY_H
#define ABSTRACT_DISPLAY_H

class AbstractDisplay{
public:
    virtual ~AbstractDisplay(){};
    virtual void open()=0;
    virtual void print()=0;
    virtual void close()=0;
    virtual void display() final;
};
#endif // ABSTRACT_DISPLAY_H


■ソースファイル

#include "AbstractDisplay.h"

void AbstractDisplay::display(){
    open();

    for(int i=0i<5; ++i){
        print();
    }

    close();
}



CharDisplayクラス


CharDisplayクラスの各メソッドは以下のような処理を行います。

メソッド名処理
open文字列"<<"を表示する
printコンストラクタで与えられていた文字を表示する
close文字列">>"を表示する


コンストラクタで'H'という文字列が与えられた場合、AbstractDisplayクラスで定義したdisplayメソッドを呼び出すと、

<<HHHHH>>

のように出力されます。


■ヘッダファイル

#ifndef CHAR_DISPLAY_H
#define CHAR_DISPLAY_H

#include "AbstractDisplay.h"

class CharDisplay : public AbstractDisplay{
public:
    CharDisplay(char ch);
    virtual ~CharDisplay();
    void open() override;
    void print() override;
    void close() override;

private:
    char m_ch;
};
#endif // CHAR_DISPLAY_H


■ソースファイル

#include <iostream>
#include "CharDisplay.h"

CharDisplay::CharDisplay(char ch) : m_ch(ch){}

CharDisplay::~CharDisplay(){};

void CharDisplay::open(){
    std::cout << "<<";
}

void CharDisplay::print(){
    std::cout << m_ch;
}
 
void CharDisplay::close(){
    std::cout << ">>" << std::endl;



StringDisplayクラス


StringDisplayクラスの各メソッドは以下のような処理を行います。

メソッド名処理
open文字列"+-----+"を表示する
printコンストラクタで与えられていた文字列を"|"と"|"ではさんで表示する
close文字列"+-----+"を表示する


コンストラクタで'Hello'という文字列が与えられた場合、AbstractDisplayクラスで定義したdisplayメソッドを呼び出すと、

+-----+
|Hello|
|Hello|
|Hello|
|Hello|
|Hello|
+-----+

のように出力されます。


■ヘッダファイル

#ifndef STRING_DISPLAY_H
#define STRING_DISPLAY_H

#include <iostream>
#include "AbstractDisplay.h"

class StringDisplay : public AbstractDisplay{
public:    
    StringDisplay(std::string string);
    virtual ~StringDisplay();
    void open() override;
    void print() override;
    void close() override;

private:
    std::string m_string;
};
#endif // STRING_DISPLAY_H


■ソースファイル

#include <iostream>
#include "StringDisplay.h"

StringDisplay::StringDisplay(std::string string) : m_string(string){}

StringDisplay::~StringDisplay(){};

void StringDisplay::open(){
    std::cout << "+";
    for(int i=0im_string.length(); ++i){
        std::cout << "-";
    }
    std::cout << "+" << std::endl;
}

void StringDisplay::print(){
    std::cout << "|" << m_string << "|" << std::endl;
}

void StringDisplay::close(){
    std::cout << "+";
    for(int i=0im_string.length(); ++i){
        std::cout << "-";
    }
    std::cout << "+" << std::endl;



main関数


今まで作成してきたクラスを実際に使っていきます。


■ソースファイル

#include "AbstractDisplay.h"
#include "CharDisplay.h"
#include "StringDisplay.h"

int main(void){
    AbstractDisplay *d1 = new CharDisplay('H');
    AbstractDisplay *d2 = new StringDisplay("Hello, world.");

    d1->display();
    d2->display();

    delete d1;
    delete d2;

    return 0;
}


■出力結果

<<HHHHH>>
+-------------+
|Hello, world.|
|Hello, world.|
|Hello, world.|
|Hello, world.|
|Hello, world.|
+-------------+





まとめ


テンプレートメソッドパターンでは、テンプレートメソッドでアルゴリズムが定義されているため、子クラス側ではアルゴリズムの流れを気にせずに実装することができました。

テンプレートメソッドでアルゴリズムが共通化されているため、仮にアルゴリズムが間違えていたとしてもテンプレートメソッドクラスだけを修正すればよいので、効率的にプログラムを修正することができます。

プログラムで不具合を少なくするためには、同じ処理を何度も書かないということが大切ですので、せひテンプレートメソッドを使用してプログラムの共通化を行っていきましょう。






3753817_s


本記事では、デザインパターンの名著である結城浩さんの『Javaで学ぶデザインパターン入門』を参考にアダプターパターン(Adapter)をC++で実装してみました。



アダプターパターン(Adapter)とは


アダプターパターンとは、「すでに提供されているもの」と「必要なもの」の間にある「ずれ」を埋めて再利用するためのデザインパターンです。

提供されたAPIなどを手直しするために使われます。

アダプターパターンには、以下の2種類の実装方法があります。

  • クラスによるAdapterパターン(継承を使ったもの)
  • インスタンスによるAdapterパターン(委譲を使ったもの)



クラスによるAdapterパターン(継承を使ったもの)


継承を使ったアダプターパターンは以下のようなクラス図になります。


アダプターパターン_継承



継承のAdapterパターンは、Adaptee役のメソッドがほぼそのまま使えそうなときに使われます。


Target(対象)


今必要となっているメソッドを定める役で、インタフェースとなっています。

C++では、二重継承を非推奨としているため、継承を使ったアダプターパターンでは、Targetは省略されることが多いです。


Client(依頼者)


Target役(省略する際はAdapter役)のメソッドを使って仕事をする役です。

main関数のようなAPIを呼び出すやつだと思ってもらえば大丈夫です。


Adaptee(適合される側)


すでに用意しているメソッドをもっている役です。要するに使いたいAPIを持っているクラスのことですね。

Target役が使いたいAPIがAdaptee役ですでに実装していたら、Adapter役は必要ないんですけどね…。


Adapter


Adapterパターンの主役です。Adaptee役のメソッドを使用して、Targetが求めているメソッドを作り出すやくですね。



インスタンスによるAdapterパターン(委譲を使ったもの)


委譲を使ったアダプターパターンは以下のようなクラス図になります。


アダプターパターン_委譲


委譲を使ったAdapterパターンは、Adaptee役のメソッドを呼び出す前に手を加えたいことが多い場合に有効です。

Adaptee役のメソッドをそのまま呼び出したい場合は、メソッドを再定義する必要があり、コード量が増えるというデメリットもあります。

C++では多重継承(インタフェースと親クラスの同時継承)が推奨されていないこともあり、委譲を使ったAdapterパターンのほうがよくつかわれるような気がします。



C++で継承をつかったアダプターパターンを実装


今回は、与えられた文字列を

(Hello)
*Hello*

のように表示する簡単なものをAdapterパターンを使用して実装していきます。

クラス構成は以下の通りです。


アダプターパターン_サンプル1



二重継承をしないようにTargetクラスを省略した実装にしています。


Bannerクラス


Bannerクラスは、事前に用意されていたAPIクラスだと思ってください。

■ヘッダファイル

#ifndef BANNER_H
#define BANNER_H

#include <iostream>

class Banner{
public:
    Banner(std::string string);
    
    virtual ~Banner();

    void showWithParen();

    void showWithAster();

private:
    std::string m_string;
};
#endif // BANNER_H


■ソースファイル

#include "Banner.h"

Banner::Banner(std::string string)
m_string(string
{

}

Banner::~Banner(){}

void Banner::showWithParen(){
    std::cout << "(" << m_string << ")" << std::endl;
}

void Banner::showWithAster(){
    std::cout << "*" << m_string << "*" << std::endl;
}



PrintBannerクラス


PrintBannerクラスがアダプターの役目を果たします。

今回はm単純な実装のためBannerクラスのAPIをそのまま呼び出すだけになります。

■ヘッダファイル

#ifndef PRINTBANNER_H
#define PRINTBANNER_H

#include "Banner.h"

class PrintBanner : public Banner{
public:
    PrintBanner(std::string string);

    ~PrintBanner();

    void printWeak();
    
    void printStrong();

};
#endif // PRINTBANNER_H


■ソースファイル

#include "PrintBanner.h"

PrintBanner::PrintBanner(std::string string)
Banner(string)
{

}

PrintBanner::~PrintBanner(){}

void PrintBanner::printWeak(){
    showWithParen();
}

void PrintBanner::printStrong(){
    showWithAster();
}



main関数


ここまで作ってきたAdapter役のPrintBannerクラスを使って、"Adapter Sample"という文字列を括弧付きと*ではさんで表示します。

■ソースファイル

#include "PrintBanner.h"

int main(void){
    PrintBanner printBanner("Adapter Sample");
    
    printBanner.printWeak();
    printBanner.printStrong();

    return 0;
}


■実行結果

(Adapter Sample)
*Adapter Sample*






C++で委譲をつかったアダプターパターンを実装


委譲を使ったアダプターパターンのサンプルプログラムのクラス構成は以下の通りです。


アダプターパターン_サンプル2


Bannerクラス


■ヘッダファイル

#ifndef BANNER_H
#define BANNER_H

#include <iostream>

class Banner{
public:
    Banner(std::string string);
    
    virtual ~Banner();

    void showWithParen();

    void showWithAster();

private:
    std::string m_string;
};
#endif // BANNER_H


■ソースファイル

#include "Banner.h"

Banner::Banner(std::string string)
m_string(string
{

}

Banner::~Banner(){}

void Banner::showWithParen(){
    std::cout << "(" << m_string << ")" << std::endl;
}

void Banner::showWithAster(){
    std::cout << "*" << m_string << "*" << std::endl;
}



Printクラス


JavaでいうインタフェースはC++では抽象クラスとして実装していきます。

■ヘッダファイル

#ifndef PRINT_H
#define PRINT_H

class Print{
protected:
    virtual ~Print(){};

    virtual void printWeak()=0;
    
    virtual void printStrong()=0;
};
#endif // PRINT_H



PrintBannerクラス


■ヘッダファイル

#ifndef PRINTBANNER_H
#define PRINTBANNER_H

#include <iostream>
#include "Print.h"

class Banner;

class PrintBanner : public Print{
public:
    PrintBanner(std::string string);

    virtual ~PrintBanner();

    void printWeak() override;
    
    void printStrong() override;

private:
    Banner *m_Banner;

};
#endif // PRINTBANNER_H



■ソースファイル

#include "PrintBanner.h"
#include "Banner.h"
#include "Print.h"

PrintBanner::PrintBanner(std::string string)
{
    m_Banner = new Banner(string);
}

PrintBanner::~PrintBanner(){
    delete m_Banner;
}

void PrintBanner::printWeak(){
    m_Banner->showWithParen();
}

void PrintBanner::printStrong(){
    m_Banner->showWithAster();
}



main関数


■ソースファイル

#include "PrintBanner.h"

int main(void){
    PrintBanner printBanner("Adapter Sample");
    
    printBanner.printWeak();
    printBanner.printStrong();

    return 0;
}


■実行結果

(Adapter Sample)
*Adapter Sample*




まとめ


個人開発ではなく、会社などで集団で開発する場合は、いきなりAPIの使用が変更することが多々あります。

いきなりの変更でも困らないようにアダプターパターンを使って、修正箇所ができる限り少なくなるようなプログラムを作っていきましょう。







↑このページのトップヘ