summaryrefslogtreecommitdiff
path: root/indra/llcommon/llpriqueuemap.h
blob: 79934d094b72aab1013b78ec27fccd51e2d17dfa (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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/**
 * @file llpriqueuemap.h
 * @brief Priority queue implementation
 *
 * $LicenseInfo:firstyear=2003&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */
#ifndef LL_LLPRIQUEUEMAP_H
#define LL_LLPRIQUEUEMAP_H

#include <map>

//
// Priority queue, implemented under the hood as a
// map.  Needs to be done this way because none of the
// standard STL containers provide a representation
// where it's easy to reprioritize.
//

template <class DATA>
class LLPQMKey
{
public:
    LLPQMKey(const F32 priority, DATA data) : mPriority(priority), mData(data)
    {
    }

    bool operator<(const LLPQMKey &b) const
    {
        if (mPriority > b.mPriority)
        {
            return TRUE;
        }
        if (mPriority < b.mPriority)
        {
            return FALSE;
        }
        if (mData > b.mData)
        {
            return TRUE;
        }
        return FALSE;
    }

    F32 mPriority;
    DATA mData;
};

template <class DATA_TYPE>
class LLPriQueueMap
{
public:
    typedef typename std::map<LLPQMKey<DATA_TYPE>, DATA_TYPE>::iterator pqm_iter;
    typedef std::pair<LLPQMKey<DATA_TYPE>, DATA_TYPE> pqm_pair;
    typedef void (*set_pri_fn)(DATA_TYPE &data, const F32 priority);
    typedef F32 (*get_pri_fn)(DATA_TYPE &data);


    LLPriQueueMap(set_pri_fn set_pri, get_pri_fn get_pri) : mSetPriority(set_pri), mGetPriority(get_pri)
    {
    }

    void push(const F32 priority, DATA_TYPE data)
    {
#ifdef _DEBUG
        pqm_iter iter = mMap.find(LLPQMKey<DATA_TYPE>(priority, data));
        if (iter != mMap.end())
        {
            LL_ERRS() << "Pushing already existing data onto queue!" << LL_ENDL;
        }
#endif
        mMap.insert(pqm_pair(LLPQMKey<DATA_TYPE>(priority, data), data));
    }

    BOOL pop(DATA_TYPE *datap)
    {
        pqm_iter iter;
        iter = mMap.begin();
        if (iter == mMap.end())
        {
            return FALSE;
        }
        *datap = (*(iter)).second;
        mMap.erase(iter);

        return TRUE;
    }

    void reprioritize(const F32 new_priority, DATA_TYPE data)
    {
        pqm_iter iter;
        F32 cur_priority = mGetPriority(data);
        LLPQMKey<DATA_TYPE> cur_key(cur_priority, data);
        iter = mMap.find(cur_key);
        if (iter == mMap.end())
        {
            LL_WARNS() << "Data not on priority queue!" << LL_ENDL;
            // OK, try iterating through all of the data and seeing if we just screwed up the priority
            // somehow.
            for (pqm_pair pair : mMap)
            {
                if (pair.second == data)
                {
                    LL_ERRS() << "Data on priority queue but priority not matched!" << LL_ENDL;
                }
            }
            return;
        }

        mMap.erase(iter);
        mSetPriority(data, new_priority);
        push(new_priority, data);
    }

    S32 getLength() const
    {
        return (S32)mMap.size();
    }

    // Hack: public for use by the transfer manager, ugh.
    std::map<LLPQMKey<DATA_TYPE>, DATA_TYPE> mMap;
protected:
    void (*mSetPriority)(DATA_TYPE &data, const F32 priority);
    F32 (*mGetPriority)(DATA_TYPE &data);
};

#endif // LL_LLPRIQUEUEMAP_H