changelog
[libcds.git] / tests / unit / pqueue / std_pqueue.h
1 /*
2     This file is a part of libcds - Concurrent Data Structures library
3
4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
5
6     Source code repo: http://github.com/khizmax/libcds/
7     Download: http://sourceforge.net/projects/libcds/files/
8     
9     Redistribution and use in source and binary forms, with or without
10     modification, are permitted provided that the following conditions are met:
11
12     * Redistributions of source code must retain the above copyright notice, this
13       list of conditions and the following disclaimer.
14
15     * Redistributions in binary form must reproduce the above copyright notice,
16       this list of conditions and the following disclaimer in the documentation
17       and/or other materials provided with the distribution.
18
19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.     
29 */
30
31 #ifndef CDSUNIT_STD_PQUEUE_H
32 #define CDSUNIT_STD_PQUEUE_H
33
34 #include <queue>
35 #include <mutex>    //unique_lock
36
37 namespace pqueue {
38
39     struct dummy_stat {};
40
41     template <typename T, typename Container, typename Lock, typename Less=std::less<typename Container::value_type> >
42     class StdPQueue
43     {
44         typedef T value_type;
45         typedef std::priority_queue<value_type, Container, Less> pqueue_type;
46
47         pqueue_type     m_PQueue;
48         mutable Lock    m_Lock;
49
50         typedef std::unique_lock<Lock> scoped_lock;
51
52     public:
53         bool push( value_type const& val )
54         {
55             scoped_lock l( m_Lock );
56             m_PQueue.push( val );
57             return true;
58         }
59
60         bool pop( value_type& dest )
61         {
62             scoped_lock l( m_Lock );
63             if ( !m_PQueue.empty() ) {
64                 dest = m_PQueue.top();
65                 m_PQueue.pop();
66                 return true;
67             }
68             return false;
69         }
70
71         template <typename Q, typename MoveFunc>
72         bool pop_with( Q& dest, MoveFunc f )
73         {
74             scoped_lock l( m_Lock );
75             if ( !m_PQueue.empty() ) {
76                 f( dest, m_PQueue.top());
77                 m_PQueue.pop();
78                 return true;
79             }
80             return false;
81         }
82
83         void clear()
84         {
85             scoped_lock l( m_Lock );
86             while ( !m_PQueue.empty() )
87                 m_PQueue.pop();
88         }
89
90         template <typename Func>
91         void clear_with( Func f )
92         {
93             scoped_lock l( m_Lock );
94             while ( !m_PQueue.empty() ) {
95                 f( m_PQueue.top() );
96                 m_PQueue.pop();
97             }
98         }
99
100         bool empty() const
101         {
102             return m_PQueue.empty();
103         }
104
105         size_t size() const
106         {
107             return m_PQueue.size();
108         }
109
110         dummy_stat statistics() const
111         {
112             return dummy_stat();
113         }
114     };
115
116 } // namespace pqueue
117
118 namespace std {
119     static inline ostream& operator <<( ostream& o, pqueue::dummy_stat )
120     {
121         return o;
122     }
123 }
124
125 #endif // #ifndef CDSUNIT_STD_PQUEUE_H