Public Types | Public Member Functions

priority_queue< Config_ > Class Template Reference
[Internals]

External priority queue data structure. More...

#include <priority_queue.h>

Inherits noncopyable.

Collaboration diagram for priority_queue< Config_ >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Config::value_type value_type
 The type of object stored in the priority_queue.
typedef Config::comparator_type comparator_type
 Comparison object.
typedef stxxl::uint64 size_type
 An unsigned integral type (64 bit).

Public Member Functions

 priority_queue (prefetch_pool< block_type > &p_pool_, write_pool< block_type > &w_pool_)
 Constructs external priority queue object.
 priority_queue (unsigned_type p_pool_mem, unsigned_type w_pool_mem)
 Constructs external priority queue object.
size_type size () const
 Returns number of elements contained.
bool empty () const
 Returns true if queue has no elements.
const value_typetop () const
 Returns "largest" element.
void pop ()
 Removes the element at the top.
void push (const value_type &obj)
 Inserts x into the priority_queue.
unsigned_type mem_cons () const
 Returns number of bytes consumed by the priority_queue.

Detailed Description

template<class Config_>
class priority_queue< Config_ >

External priority queue data structure.


Member Typedef Documentation

template<class Config_ >
typedef Config::comparator_type priority_queue< Config_ >::comparator_type

Comparison object.

template<class Config_ >
typedef stxxl::uint64 priority_queue< Config_ >::size_type

An unsigned integral type (64 bit).

template<class Config_ >
typedef Config::value_type priority_queue< Config_ >::value_type

The type of object stored in the priority_queue.


Member Function Documentation

template<class Config_ >
bool priority_queue< Config_ >::empty (  )  const [inline]

Returns true if queue has no elements.

Returns:
true if queue has no elements, false otherwise

References priority_queue< Config_ >::size().

template<class Config_ >
unsigned_type priority_queue< Config_ >::mem_cons (  )  const [inline]

Returns number of bytes consumed by the priority_queue.

number of bytes consumed by the priority_queue from the internal memory not including pools (see the constructor)


The documentation for this class was generated from the following file: