priority_queue.h

Go to the documentation of this file.

/*
 * nvbio
 * Copyright (c) 2011-2014, NVIDIA CORPORATION. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    * Neither the name of the NVIDIA CORPORATION nor the
 *      names of its contributors may be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <nvbio/basic/types.h>
#include <nvbio/basic/popcount.h>

namespace nvbio {



    
template <typename Key, typename Container, typename Compare>
struct priority_queue
{
    typedef Key                                         value_type;
    typedef Container                                   container_type;
    typedef typename container_type::const_iterator     const_iterator;
    typedef const_iterator                              iterator;

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE priority_queue(Container cont = Container(), const Compare cmp = Compare());

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE bool  empty() const;

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE uint32 size() const;

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE void push(const Key key);

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE void pop();

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE Key& top();

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE Key top() const;

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE const Key& operator[] (const uint32 i) const;

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE void clear();

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE 
    const_iterator begin() const { return m_queue.size() ? m_queue.begin() + 1u : m_queue.end(); }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE 
    iterator begin() { return m_queue.size() ? m_queue.begin() + 1u : m_queue.end(); }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE 
    const_iterator end() const { return m_queue.end(); }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE 
    iterator end() { return m_queue.end(); }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE iterator upper_bound(const Key& x);

    uint32      m_size;
    Container   m_queue;
    Compare     m_cmp;
};


} // namespace nvbio

#include <nvbio/basic/priority_queue_inline.h>