Qt のコンテナクラスについて

# はじめに
[@luyikei](https://twitter.com/luyikei) です。 Qt が大好きな人間です。最近あまりやってないのですが... 
[Qt Advent Calendar 2014](http://qiita.com/advent-calendar/2014/qt) も最終日ですね。少し寂しくなりますね。今日はクリスマスです。皆さん楽しんでいますか？！今日は Qt のコンテナクラスについての記事を書きます。元々は競技プログラミングを Qt でやる記事を書こうと思いましたが考えてみると多くの部分が Qt のコンテナクラスによって改善されると思ったのでコンテナクラスに特化した記事にしました。多分少しやっている皆さんならば既知の事項が多いと思いますがよろしくおねがいします。

多くの部分は [Container Classes](http://doc.qt.io/qt-5/containers.html) の参考です。興味があればそちらも参照してください。

# コンテナクラス
Qt のコンテナクラスは多くが C++ の STL のものを発展させたものです。例えば、 STL の [ vector\<T\> ](https://www.sgi.com/tech/stl/Vector.html) は Qt の [QVector\<T\>](http://doc.qt.io/qt-5/qvector.html) に相当します。では何故、 Qt で独自に再設計する必要があるのでしょうか。それはとてもシンプルで公式ドキュメントにあるように

> These container classes are designed to be lighter, safer, and easier to use than the STL containers. If you are unfamiliar with the STL, or prefer to do things the "Qt way", you can use these classes instead of the STL classes.

いいことずくめですね！やはり Qt でプログラミングするならば多くの場合は Qt のコンテナクラスを使用するべきだと思います。では早速一つずつ見て行きましょう。

今回は Qt のコンテナクラスの楽しさを実感してもらいたいため、[QVector\<T\>](http://doc.qt.io/qt-5/qvector.html) を例に説明します。他のクラスについて詳しくは [Container Classes](http://doc.qt.io/qt-5/containers.html) を参照してください。

## QVector\<T\> を例に

これは名称の通りベクトル型で値の組を保存するクラスですね。STL の [ vector\<T\> ](https://www.sgi.com/tech/stl/Vector.html) は多くの場合は動的配列として使われると思います。例えば STL の [ vector\<T\> ](https://www.sgi.com/tech/stl/Vector.html) はこのように使われます。

```cpp:vector.cpp
vector<int> v;
v.push_back(1); // 1 を追加
cout << v[0] << endl; //表示

v.push_back(2);
v.push_back(3);
// すべて表示(添字)
for (int i=0; i < v.size(); ++i){
    cout << v[i] << endl;
}

// すべて表示(イテレーター)
for (vector<int>::iterator it = v.begin(); it != v.end(); ++it){
    cout << *it << endl;
}

```

びみょ～ですね。[QVector\<T\>](http://doc.qt.io/qt-5/qvector.html) を使うと


```cpp:qvector.cpp
QVector<int> v;
v.append(1); // 1 を追加 append のほうが Qt っぽい push_back も勿論使える。
cout << v[0] << endl; //表示

v << 2 << 3; // 演算子のオーバーロードをしているため追加が楽に行える。2, 3 を追加している。
```

追加だけでも見栄えば全く違います。 

### for ループだけをとっても

for ループで全要素にアクセスするときも

```cpp:qvector.cpp
// すべて表示(添字)
for (int i=0; i < v.size(); ++i){
    cout << v.at(i) << endl; // at() 使うとディープコピーが行われないため、高速。ただし Read-Only
}

// すべて表示(Java-Style イテレーター)
QVectorIterator<int> it(v);
while (it.hasNext())
    cout << it.next() << endl; // Java-Style なので注意！

// すべて表示(STL-Style イテレーター)
for (QVector<int>::iterator it = v.begin(); it != v.end(); ++it){
    cout << *it << endl; // 従来の方式でも
}
```

Java-Style のイテレーターの方が個人的には見やすいと思います。しかし [QVectorIterator](http://doc.qt.io/qt-5/qvectoriterator.html) は const イテレーターで Read-Only なので値の変更可能なイテレーターを使用したい場合は [QMutableVectorIterator\<T\>](http://doc.qt.io/qt-5/qmutablevectoriterator.html) を使用してください。そして値を変更する場合は [setValue(const T & value) ](http://doc.qt.io/qt-5/qmutablevectoriterator.html#setValue) 関数を使用してください。
実は Qt で foreach **マクロ**が定義されているためもっと見やすい書き方ができます。

```cpp:qvector.cpp
foreach (const int &i, v)
{
  cout << i << endl;
}
```

しかしマクロで定義されているので注意してください。(例えば QPair\<int, int\> のようにデータ型にカンマが入っている場合。詳しくは [The foreach Keyword](http://doc.qt.io/qt-5/containers.html#the-foreach-keyword) を参照してください。)
また、 C++11 で似たような機能が実装されているので

```cpp:qvector.cpp
// C++11 Only!
for (const int &i : v){
    cout << i << endl;
}
```

これに限らず、 C++11 を使用する際、新たなテクニックが幾つか使えるで、興味がある方は [C++0x in Qt](http://blog.qt.digia.com/blog/2011/05/26/cpp0x-in-qt/) を参照してください。
また、C++11 形式の for はディープコピーが行われないが、 Qt のマクロの foreach はディープコピーが行われるという相違点もあります。for ループでは要素が追加や削除が行われた時の挙動が予測できないわけです。これも上記のリンクで解説されています。

### ユニークな関数たち

では、STL の vector には定義されていない関数を紹介します。QVector は vector であるにもかかわらず、先頭に追加する関数があります。

```cpp:qvector.cpp
v.push_back(1); // 1 を先頭に追加 (STL っぽい書き方)
v.prepend(1); // 2 を先頭に追加 (Qt っぽい書き方)
```

連結リストで実装されてないため、先頭に追加する処理はデータ量が多ければ多いほど重くなります。(全データをずらしているため)。先頭に追加する場合は時間計算量は O(N) ですが、[QList\<T\>](http://doc.qt.io/qt-5/qlist.html) は O(1) です。多くの機能が [QList\<T\>](http://doc.qt.io/qt-5/qlist.html) にも実装されているため、差異がデータ構造以外にほぼなくなっているので、使用するときはそういったことを考慮するべきだと思います。

任意のインディックスの要素の削除も簡単にできます。

```cpp:qvector.cpp
v.remove(1); // 2番目の要素を削除
```

これを STL で再現するとこうなります

```cpp:vector.cpp
v.erase(v.begin() + 1); // イテレーターで削除
```

また任意の値の要素を全て削除できます。

```cpp:qvector.cpp
v << 1 << 1 << 2 << 3;
v.removeAll(1); // 1 を全て削除
```

これを STL で再現するとこうなります

```cpp:vector.cpp
v.push_back(1);
v.push_back(1);
v.push_back(2);
v.push_back(3);
v.erase(remove(v.begin(), v.end(), 1), v.end()); // イテレーターで削除
```

これらの関数は全て [QList\<T\>](http://doc.qt.io/qt-5/qlist.html) との互換性のために実装されたものであるため、こういった処理を沢山行う場合は [QList\<T\>](http://doc.qt.io/qt-5/qlist.html) を使用したほうがいいと思います。

値の検索も容易に行えます。(戻り値はインディックス。また、単に存在の確認なら [contains(const T & value)](http://doc.qt.io/qt-5/qvector.html#contains) が便利です。)

```cpp:qvector.cpp
v << 1 << 1 << 2 << 3;

cout << v.indexOf(1) << endl; // 出力: 0
cout << v.indexOf(2) << endl; // 出力: 2
cout << v.indexOf(3) << endl; // 出力: 3

cout << v.indexOf(4) << endl; // 出力: -1
```

これを STL で再現するとこうなります

```cpp:vector.cpp
v.push_back(1);
v.push_back(1);
v.push_back(2);
v.push_back(3);

vector<int>::iterator it = find(v.begin(), v.end(), 1); // 1を検索

if ( it == v.end() ){
    cout << -1 << endl;
} else {
    cout << static_cast<int>(it - v.begin()) << endl;
}
```

とんでもないですね！ Qt の有り難みを感じます。

また、 QVector は [fromStdVector(const std::vector<T> & vector)](http://doc.qt.io/qt-5/qvector.html#fromStdVector) によて STL の vector から変換できますし、 [toStdVector()](http://doc.qt.io/qt-5/qvector.html#toStdVector) で逆もできます。

# おわりに

書いていて思ったのは、やはり Qt は日本語の情報が少ないということです。しかも情報が全体的に古いという二重苦に悩まされています。
一方で Qt の公式ドキュメントは非常によく整理されています。英語がわかる人、抵抗がない人はほとんど英語のドキュメントを読んで開発しなさっていると思います。

しかし、やはり初心者にとって日本語の情報が少ないというのは Qt の大きな障壁になると思いますし、私もそうでした。なので、こういった [Qt Advent Calendar 2014](http://qiita.com/advent-calendar/2014/qt) と言った情報を積極的に発信する機会が設けてもらって本当に良かったと思います。この [Qt Advent Calendar 2014](http://qiita.com/advent-calendar/2014/qt) を作成してくださった[@task_jp](https://twitter.com/task_jp) さん、投稿してくださった皆さん、本当にありがとうございました。