summaryrefslogtreecommitdiffstats
path: root/src/bm/index.h
blob: 75cf85c99f7dabb92357573b6bb7657e15687142 (plain)
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the BM project on Qt Labs.
**
** This file may be used under the terms of the GNU General Public
** License version 2.0 or 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of
** this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
****************************************************************************/

#ifndef INDEX_H
#define INDEX_H

#include <QString>
#include <QList>

class ResultHistoryInfo;

class Index {
public:
    Index(
        const QList<ResultHistoryInfo *> &candidateRHInfos, const int baseTimestamp,
        const QList<int> &evalTimestamps, int medianWinSize, int *rejectedNonPositive = 0);
    virtual ~Index();

    bool isValid() const { return valid; }
    QString invalidReason() const {return invalidReason_; }

    struct RankedInfo {
        int bmcontextId;
        int basePos;
        int diffPos1; // target pos for the eval timestamp that precedes the main eval timestamp
        int diffPos2; // target pos for the main eval timestamp
        QString descr; // free description
        RankedInfo(
            const int bmcontextId, const int basePos, const int diffPos1, const int diffPos2,
            const QString &descr)
            : bmcontextId(bmcontextId), basePos(basePos), diffPos1(diffPos1), diffPos2(diffPos2)
            , descr(descr)
        {}
    };

    // Computes the index value at each evaluation timestamp into \a values. The position
    // of the index value corresponding to the base timestamp is passed in \a baseValuePos.
    // The umber of contributing result histories for each evaluation timestamp is passed
    // in \a contrCounts.
    // If non-null, the \a topContr list will upon return contain a list of the \a topContrLimit
    // most significant contributors at each evaluation timestamp.
    virtual bool computeValues(
        QList<qreal> *values, int *baseValuePos, QList<int> *contrCounts, QString *error,
        QList<QList<RankedInfo> > *topContr = 0, int topContrLimit = -1) const = 0;

protected:
    QList<ResultHistoryInfo *> rhInfos;
    int baseTimestamp;
    QList<int> evalTimestamps;
    int medianWinSize;

private:
    bool valid;
    QString invalidReason_;

    void init(
        const QList<ResultHistoryInfo *> &candidateRHInfos, int *rejectedNonPositive = 0);
    void populateRHInfos(
        const QList<ResultHistoryInfo *> &candidateRHInfos, int *rejectedNonPositive = 0);
};

// ### 2 B DOCUMENTED!
class IndexAlgorithm1 : public Index {
public:
    IndexAlgorithm1(
        const QList<ResultHistoryInfo *> &candidateRHInfos, const int baseTimestamp,
        const QList<int> &evalTimestamps, int medianWinSize, int *rejectedNonPositive = 0)
        : Index(
            candidateRHInfos, baseTimestamp, evalTimestamps, medianWinSize, rejectedNonPositive)
    {}

    bool computeValues(
        QList<qreal> *values, int *baseValuePos, QList<int> *contrCounts, QString *error,
        QList<QList<RankedInfo> > *topContr = 0, int topContrLimit = -1) const;
};

#endif // INDEX_H