2018年10月13日土曜日

[MQL4] CArrayObj::Search() が想定外のインデックスを返してくることがある

MQL4 で可変長配列を使用する方法 に書いたのですが、Sort() 済みの CArrayObj から Search() でインデックスを取得しても正しいインデックスを返さない場合があるので注意が必要です。

具体的な例を以下に挙げます。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
#property strict
 
#include <Object.mqh>
#include <Arrays/ArrayObj.mqh>
 
class Item : public CObject {
private:
    const int m_serial;
    const int m_value;
 
public:
    Item(int serial, int value) : m_serial(serial), m_value(value) {
    }
 
    virtual ~Item() {
    }
 
    int GetSerial() const {
        return m_serial;
    }
 
    int GetValue() const {
        return m_value;
    }
 
    // value を比較するので、返り値が 0 になることがある
    virtual int Compare(const CObject *node, const int mode=0) const {
        int diff = this.GetValue() - dynamic_cast<const item*="">(node).GetValue();
        return (diff == 0) ? 0 : (diff > 0) ? 1 : -1;
    }
};
 
CArrayObj m_item_array;
 
void OnStart()
{
    for (int i = 0; i < 10; i++) {
        m_item_array.Add(new Item(i, 0)); // value は全部 0
    }   
 
    // 途中に挿入
    Item* item_10 = new Item(10, 0); // value は 0
    m_item_array.Insert(item_10, 3);
 
    // Sort した後、Search すれば item_10 の場所がわかるはず
    m_item_array.Sort();
    int index = m_item_array.Search(item_10);
 
    Item* item = m_item_array.At(index);
    printf("index: %d, serial: %d, value: %d", index, item.GetSerial(), item.GetValue());
 
    // 結果
    //
    // index: 5, serial: 1, value: 0
    //
    // ↑serial は 10 になって欲しいのに、1になってる
}

Search() の結果は Compare() が 0 になるようなオブジェクト

直感的には Search() の結果は同じオブジェクトであって欲しいものです。

しかし、CArrayObj はそのように実装されていません。 Compare() が 0 になるものは同じとみなされます。

これは Quick Sort を使って高速化するためです。 ある意味、しかたのない実装ですが、気をつけて使用しないと重大なバグにつながります。

Compare() の実装と挿入するオブジェクトに注意

今回のケースの場合、value ではなく serial を比較すれば問題ありません。 各オブジェクトがユニークかつ比較可能な値を持てる場合はそれを利用するのが良いでしょう。