aboutsummaryrefslogtreecommitdiff
path: root/sdk/common/NvBlastFixedPriorityQueue.h
diff options
context:
space:
mode:
authorBryan Galdrikian <[email protected]>2017-02-24 09:32:20 -0800
committerBryan Galdrikian <[email protected]>2017-02-24 09:32:20 -0800
commite1bf674c16e3c8472b29574159c789cd3f0c64e0 (patch)
tree9f0cfce09c71a2c27ff19589fcad6cd83504477c /sdk/common/NvBlastFixedPriorityQueue.h
parentfirst commit (diff)
downloadblast-e1bf674c16e3c8472b29574159c789cd3f0c64e0.tar.xz
blast-e1bf674c16e3c8472b29574159c789cd3f0c64e0.zip
Updating to [email protected] and [email protected] with a new directory structure.
NvBlast folder is gone, files have been moved to top level directory. README is changed to reflect this.
Diffstat (limited to 'sdk/common/NvBlastFixedPriorityQueue.h')
-rw-r--r--sdk/common/NvBlastFixedPriorityQueue.h192
1 files changed, 192 insertions, 0 deletions
diff --git a/sdk/common/NvBlastFixedPriorityQueue.h b/sdk/common/NvBlastFixedPriorityQueue.h
new file mode 100644
index 0000000..5079edb
--- /dev/null
+++ b/sdk/common/NvBlastFixedPriorityQueue.h
@@ -0,0 +1,192 @@
+/*
+* Copyright (c) 2016-2017, NVIDIA CORPORATION. All rights reserved.
+*
+* NVIDIA CORPORATION and its licensors retain all intellectual property
+* and proprietary rights in and to this software, related documentation
+* and any modifications thereto. Any use, reproduction, disclosure or
+* distribution of this software and related documentation without an express
+* license agreement from NVIDIA CORPORATION is strictly prohibited.
+*/
+
+#ifndef NVBLASTFIXEDPRIORITYQUEUE_H
+#define NVBLASTFIXEDPRIORITYQUEUE_H
+
+#include "NvBlastAssert.h"
+#include "NvBlastMemory.h"
+
+namespace Nv
+{
+
+namespace Blast
+{
+
+/*!
+FixedPriorityQueue is a priority queue container which is intended to be used with placement new on chunk of memory.
+It'll use following memory for data layout. As follows:
+
+// some memory
+char ​*buf = new char[64 *​ 1024];
+
+// placement new on this memory
+FixedPriorityQueue<SomeClass>* arr = new (buf) FixedPriorityQueue<SomeClass>();
+
+// you can get max requiredMemorySize by an array of 'capacity' elements count to use memory left
+buf = buf + FixedPriorityQueue<SomeClass>::requiredMemorySize(capacity);
+
+buf:
+
++------------------------------------------------------------+
+| uint32_t | T[0] | T[1] | T[2] | ... |
++------------------------------------------------------------+
+
+*/
+
+template <typename A>
+struct Less
+{
+ bool operator()(const A& a, const A& b) const
+ {
+ return a < b;
+ }
+};
+
+
+template<class Element, class Comparator = Less<Element> >
+class FixedPriorityQueue : protected Comparator // inherit so that stateless comparators take no space
+{
+public:
+ FixedPriorityQueue(const Comparator& less = Comparator()) : Comparator(less), mHeapSize(0)
+ {
+ }
+
+ ~FixedPriorityQueue()
+ {
+ }
+
+ static size_t requiredMemorySize(uint32_t capacity)
+ {
+ return align16(sizeof(FixedPriorityQueue<Element, Comparator>)) + align16(capacity * sizeof(Element));
+ }
+
+ //! Get the element with the highest priority
+ const Element top() const
+ {
+ return data()[0];
+ }
+
+ //! Get the element with the highest priority
+ Element top()
+ {
+ return data()[0];
+ }
+
+ //! Check to whether the priority queue is empty
+ bool empty() const
+ {
+ return (mHeapSize == 0);
+ }
+
+ //! Empty the priority queue
+ void clear()
+ {
+ mHeapSize = 0;
+ }
+
+ //! Insert a new element into the priority queue. Only valid when size() is less than Capacity
+ void push(const Element& value)
+ {
+ uint32_t newIndex;
+ uint32_t parentIndex = parent(mHeapSize);
+
+ for (newIndex = mHeapSize; newIndex > 0 && compare(value, data()[parentIndex]); newIndex = parentIndex, parentIndex= parent(newIndex))
+ {
+ data()[ newIndex ] = data()[parentIndex];
+ }
+ data()[newIndex] = value;
+ mHeapSize++;
+ NVBLAST_ASSERT(valid());
+ }
+
+ //! Delete the highest priority element. Only valid when non-empty.
+ Element pop()
+ {
+ NVBLAST_ASSERT(mHeapSize > 0);
+ uint32_t i, child;
+ //try to avoid LHS
+ uint32_t tempHs = mHeapSize-1;
+ mHeapSize = tempHs;
+ Element min = data()[0];
+ Element last = data()[tempHs];
+
+ for (i = 0; (child = left(i)) < tempHs; i = child)
+ {
+ /* Find highest priority child */
+ const uint32_t rightChild = child + 1;
+
+ child += ((rightChild < tempHs) & compare((data()[rightChild]), (data()[child]))) ? 1 : 0;
+
+ if(compare(last, data()[child]))
+ break;
+
+ data()[i] = data()[child];
+ }
+ data()[ i ] = last;
+
+ NVBLAST_ASSERT(valid());
+ return min;
+ }
+
+ //! Make sure the priority queue sort all elements correctly
+ bool valid() const
+ {
+ const Element& min = data()[0];
+ for(uint32_t i=1; i<mHeapSize; ++i)
+ {
+ if(compare(data()[i], min))
+ return false;
+ }
+
+ return true;
+ }
+
+ //! Return number of elements in the priority queue
+ uint32_t size() const
+ {
+ return mHeapSize;
+ }
+
+private:
+ uint32_t mHeapSize;
+
+ NV_FORCE_INLINE Element* data()
+ {
+ return (Element*)((char*)this + sizeof(FixedPriorityQueue<Element, Comparator>));
+ }
+
+ NV_FORCE_INLINE Element* data() const
+ {
+ return (Element*)((char*)this + sizeof(FixedPriorityQueue<Element, Comparator>));
+ }
+
+ bool compare(const Element& a, const Element& b) const
+ {
+ return Comparator::operator()(a,b);
+ }
+
+ static uint32_t left(uint32_t nodeIndex)
+ {
+ return (nodeIndex << 1) + 1;
+ }
+
+ static uint32_t parent(uint32_t nodeIndex)
+ {
+ return (nodeIndex - 1) >> 1;
+ }
+
+ FixedPriorityQueue<Element, Comparator>& operator = (const FixedPriorityQueue<Element, Comparator>);
+};
+
+} // namespace Blast
+} // namespace Nv
+
+#endif // ifndef NVBLASTFIXEDPRIORITYQUEUE_H