sum_tree.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/numbers.h>
#include <iterator>

namespace nvbio {




template <typename Iterator>
struct SumTree
{
    typedef Iterator                                              iterator_type;
    typedef typename std::iterator_traits<Iterator>::value_type   value_type;

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    static uint32 node_count(const uint32 size);

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    SumTree(const uint32 size, iterator_type cells);

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    uint32 size() const { return m_size; }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    uint32 padded_size() const { return m_padded_size; }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    uint32 nodes() const { return m_padded_size * 2u - 1u; }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    void setup(const value_type zero = value_type(0));

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    void add(const uint32 i, const value_type v);

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    void set(const uint32 i, const value_type v);

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    value_type sum() const { return m_cells[ m_padded_size * 2u - 2u ]; }

    NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
    value_type cell(const uint32 i) const { return m_cells[i]; }

private:
    iterator_type m_cells;
    uint32        m_size;
    uint32        m_padded_size;
};

template <typename Iterator>
NVBIO_FORCEINLINE NVBIO_HOST_DEVICE
uint32 sample(const SumTree<Iterator>& tree, const float value);


} // namespace nvbio

#include <nvbio/basic/sum_tree_inl.h>