42 #ifndef OPENVDB_TREE_LEAFMANAGER_HAS_BEEN_INCLUDED 43 #define OPENVDB_TREE_LEAFMANAGER_HAS_BEEN_INCLUDED 45 #include <openvdb/Types.h> 47 #include <tbb/blocked_range.h> 48 #include <tbb/parallel_for.h> 49 #include <tbb/parallel_reduce.h> 51 #include <type_traits> 64 static const bool IsConstTree =
false;
67 template<
typename TreeT>
struct TreeTraits<const TreeT> {
68 static const bool IsConstTree =
true;
78 template<
typename ManagerT>
81 using RangeT =
typename ManagerT::RangeType;
82 using LeafT =
typename ManagerT::LeafType;
83 using BufT =
typename ManagerT::BufferType;
86 LeafT** leafs,
BufT* bufs,
size_t bufsPerLeaf)
88 for (
size_t n = r.begin(), m = r.end(), N = bufsPerLeaf; n != m; ++n) {
89 leafs[n]->swap(bufs[n * N + auxBufferIdx]);
109 template<
typename TreeT>
135 assert(this->isValid());
149 return mRange.mLeafManager.getBuffer(mPos, bufferIdx);
152 size_t pos()
const {
return mPos; }
154 bool isValid()
const {
return mPos>=mRange.mBegin && mPos<=mRange.mEnd; }
156 bool test()
const {
return mPos < mRange.mEnd; }
158 operator bool()
const {
return this->test(); }
160 bool empty()
const {
return !this->test(); }
163 return (mPos != other.mPos) || (&mRange != &other.mRange);
176 , mGrainSize(grainSize)
177 , mLeafManager(leafManager)
185 size_t size()
const {
return mEnd - mBegin; }
191 bool empty()
const {
return !(mBegin < mEnd);}
198 , mGrainSize(r.mGrainSize)
199 , mLeafManager(r.mLeafManager)
204 size_t mEnd, mBegin, mGrainSize;
210 size_t middle = r.mBegin + (r.mEnd - r.mBegin) / 2u;
222 , mAuxBuffersPerLeaf(auxBuffersPerLeaf)
224 , mAuxBuffers(nullptr)
228 this->rebuild(serial);
235 size_t auxBuffersPerLeaf=0,
bool serial=
false)
237 , mLeafCount(end-begin)
239 , mAuxBuffersPerLeaf(auxBuffersPerLeaf)
241 , mAuxBuffers(nullptr)
245 size_t n = mLeafCount;
246 LeafType **target = mLeafs, **source = begin;
247 while (n--) *target++ = *source++;
248 if (auxBuffersPerLeaf) this->initAuxBuffers(serial);
256 , mLeafCount(other.mLeafCount)
257 , mAuxBufferCount(other.mAuxBufferCount)
258 , mAuxBuffersPerLeaf(other.mAuxBuffersPerLeaf)
259 , mLeafs(other.mLeafs)
260 , mAuxBuffers(other.mAuxBuffers)
270 delete [] mAuxBuffers;
281 this->initLeafArray();
282 this->initAuxBuffers(serial);
285 void rebuild(
size_t auxBuffersPerLeaf,
bool serial=
false)
288 mAuxBuffersPerLeaf = auxBuffersPerLeaf;
289 this->rebuild(serial);
294 this->rebuild(serial);
299 mAuxBuffersPerLeaf = auxBuffersPerLeaf;
300 this->rebuild(serial);
303 void rebuildAuxBuffers(
size_t auxBuffersPerLeaf,
bool serial=
false)
309 mAuxBuffersPerLeaf = auxBuffersPerLeaf;
310 this->initAuxBuffers(serial);
318 this->removeAuxBuffers();
319 this->initLeafArray();
334 return tbb::parallel_reduce(this->leafRange(),
Index64(0),
336 for (
const auto& leaf: range) { sum += leaf.onVoxelCount(); }
359 LeafType&
leaf(
size_t leafIdx)
const { assert(leafIdx<mLeafCount);
return *mLeafs[leafIdx]; }
373 assert(leafIdx < mLeafCount);
374 assert(bufferIdx == 0 || bufferIdx - 1 < mAuxBuffersPerLeaf);
375 return bufferIdx == 0 ? mLeafs[leafIdx]->buffer()
376 : mAuxBuffers[leafIdx * mAuxBuffersPerLeaf + bufferIdx - 1];
388 return LeafRange(0, mLeafCount, *
this, grainsize);
402 namespace ph = std::placeholders;
403 if (bufferIdx == 0 || bufferIdx > mAuxBuffersPerLeaf || this->isConstTree())
return false;
404 mTask = std::bind(&LeafManager::doSwapLeafBuffer, ph::_1, ph::_2, bufferIdx - 1);
405 this->cook(serial ? 0 : 512);
412 bool swapBuffer(
size_t bufferIdx1,
size_t bufferIdx2,
bool serial =
false)
414 namespace ph = std::placeholders;
415 const size_t b1 =
std::min(bufferIdx1, bufferIdx2);
416 const size_t b2 =
std::max(bufferIdx1, bufferIdx2);
417 if (b1 == b2 || b2 > mAuxBuffersPerLeaf)
return false;
419 if (this->isConstTree())
return false;
420 mTask = std::bind(&LeafManager::doSwapLeafBuffer, ph::_1, ph::_2, b2-1);
422 mTask = std::bind(&LeafManager::doSwapAuxBuffer, ph::_1, ph::_2, b1-1, b2-1);
424 this->cook(serial ? 0 : 512);
438 namespace ph = std::placeholders;
439 if (bufferIdx == 0 || bufferIdx > mAuxBuffersPerLeaf)
return false;
440 mTask = std::bind(&LeafManager::doSyncAuxBuffer, ph::_1, ph::_2, bufferIdx - 1);
441 this->cook(serial ? 0 : 64);
450 namespace ph = std::placeholders;
451 switch (mAuxBuffersPerLeaf) {
452 case 0:
return false;
453 case 1: mTask = std::bind(&LeafManager::doSyncAllBuffers1, ph::_1, ph::_2);
break;
454 case 2: mTask = std::bind(&LeafManager::doSyncAllBuffers2, ph::_1, ph::_2);
break;
455 default: mTask = std::bind(&LeafManager::doSyncAllBuffersN, ph::_1, ph::_2);
break;
457 this->cook(serial ? 0 : 64);
523 template<
typename LeafOp>
524 void foreach(
const LeafOp& op,
bool threaded =
true,
size_t grainSize=1)
526 LeafTransformer<LeafOp> transform(op);
527 transform.run(this->leafRange(grainSize), threaded);
572 template<
typename LeafOp>
573 void reduce(LeafOp& op,
bool threaded =
true,
size_t grainSize=1)
575 LeafReducer<LeafOp> transform(op);
576 transform.run(this->leafRange(grainSize), threaded);
584 template<
typename ArrayT>
587 using T =
typename ArrayT::value_type;
588 static_assert(std::is_pointer<T>::value,
"argument to getNodes() must be a pointer array");
589 using LeafT =
typename std::conditional<std::is_const<
590 typename std::remove_pointer<T>::type>::value,
const LeafType, LeafType>::type;
593 if (std::is_same<T, LeafT*>::value) {
594 array.resize(mLeafCount);
595 for (
size_t i=0; i<mLeafCount; ++i) array[i] = reinterpret_cast<T>(mLeafs[i]);
597 mTree->getNodes(array);
606 template<
typename ArrayT>
609 using T =
typename ArrayT::value_type;
610 static_assert(std::is_pointer<T>::value,
"argument to getNodes() must be a pointer array");
611 static_assert(std::is_const<
typename std::remove_pointer<T>::type>::value,
612 "argument to getNodes() must be an array of const node pointers");
615 if (std::is_same<T, const LeafType*>::value) {
616 array.resize(mLeafCount);
617 for (
size_t i=0; i<mLeafCount; ++i) array[i] = reinterpret_cast<T>(mLeafs[i]);
619 mTree->getNodes(array);
635 size_t getPrefixSum(
size_t*& offsets,
size_t& size,
size_t grainSize=1)
const 637 if (offsets ==
nullptr || size < mLeafCount) {
639 offsets =
new size_t[mLeafCount];
643 if ( grainSize > 0 ) {
644 PrefixSum tmp(this->leafRange( grainSize ), offsets, prefix);
646 for (
size_t i=0; i<mLeafCount; ++i) {
648 prefix += mLeafs[i]->onVoxelCount();
660 if (mTask) mTask(const_cast<LeafManager*>(
this), r);
672 MyArray(value_type* array) : ptr(array) {}
673 void push_back(value_type leaf) { *ptr++ = leaf; }
678 const size_t leafCount = mTree->leafCount();
679 if (leafCount != mLeafCount) {
681 mLeafs = (leafCount == 0) ?
nullptr :
new LeafType*[leafCount];
682 mLeafCount = leafCount;
688 void initAuxBuffers(
bool serial)
690 const size_t auxBufferCount = mLeafCount * mAuxBuffersPerLeaf;
691 if (auxBufferCount != mAuxBufferCount) {
692 delete [] mAuxBuffers;
693 mAuxBuffers = (auxBufferCount == 0) ?
nullptr :
new NonConstBufferType[auxBufferCount];
694 mAuxBufferCount = auxBufferCount;
696 this->syncAllBuffers(serial);
699 void cook(
size_t grainsize)
702 tbb::parallel_for(this->getRange(grainsize), *
this);
704 (*this)(this->getRange());
708 void doSwapLeafBuffer(
const RangeType& r,
size_t auxBufferIdx)
711 r, auxBufferIdx, mLeafs, mAuxBuffers, mAuxBuffersPerLeaf);
714 void doSwapAuxBuffer(
const RangeType& r,
size_t auxBufferIdx1,
size_t auxBufferIdx2)
716 for (
size_t N = mAuxBuffersPerLeaf, n = N*r.begin(), m = N*r.end(); n != m; n+=N) {
717 mAuxBuffers[n + auxBufferIdx1].swap(mAuxBuffers[n + auxBufferIdx2]);
721 void doSyncAuxBuffer(
const RangeType& r,
size_t auxBufferIdx)
723 for (
size_t n = r.begin(), m = r.end(), N = mAuxBuffersPerLeaf; n != m; ++n) {
724 mAuxBuffers[n*N + auxBufferIdx] = mLeafs[n]->buffer();
728 void doSyncAllBuffers1(
const RangeType& r)
730 for (
size_t n = r.begin(), m = r.end(); n != m; ++n) {
731 mAuxBuffers[n] = mLeafs[n]->buffer();
735 void doSyncAllBuffers2(
const RangeType& r)
737 for (
size_t n = r.begin(), m = r.end(); n != m; ++n) {
738 const BufferType& leafBuffer = mLeafs[n]->buffer();
739 mAuxBuffers[2*n ] = leafBuffer;
740 mAuxBuffers[2*n+1] = leafBuffer;
744 void doSyncAllBuffersN(
const RangeType& r)
746 for (
size_t n = r.begin(), m = r.end(), N = mAuxBuffersPerLeaf; n != m; ++n) {
747 const BufferType& leafBuffer = mLeafs[n]->buffer();
748 for (
size_t i=n*N, j=i+N; i!=j; ++i) mAuxBuffers[i] = leafBuffer;
754 template<
typename LeafOp>
755 struct LeafTransformer
757 LeafTransformer(
const LeafOp &leafOp) : mLeafOp(leafOp)
760 void run(
const LeafRange &range,
bool threaded)
const 762 threaded ? tbb::parallel_for(range, *
this) : (*this)(range);
764 void operator()(
const LeafRange &range)
const 768 const LeafOp mLeafOp;
773 template<
typename LeafOp>
776 LeafReducer(LeafOp &leafOp) : mLeafOp(&leafOp), mOwnsOp(
false)
779 LeafReducer(
const LeafReducer &other, tbb::split)
780 : mLeafOp(
new LeafOp(*(other.mLeafOp), tbb::split())), mOwnsOp(
true)
783 ~LeafReducer() {
if (mOwnsOp)
delete mLeafOp; }
784 void run(
const LeafRange& range,
bool threaded)
786 threaded ? tbb::parallel_reduce(range, *
this) : (*this)(range);
790 LeafOp &op = *mLeafOp;
793 void join(
const LeafReducer& other) { mLeafOp->join(*(other.mLeafOp)); }
801 PrefixSum(
const LeafRange& r,
size_t* offsets,
size_t& prefix)
804 tbb::parallel_for( r, *
this);
805 for (
size_t i=0, leafCount = r.
size(); i<leafCount; ++i) {
806 size_t tmp = offsets[i];
811 inline void operator()(
const LeafRange& r)
const {
813 mOffsets[i.pos()] = i->onVoxelCount();
819 using FuncType =
typename std::function<void (LeafManager*, const RangeType&)>;
822 size_t mLeafCount, mAuxBufferCount, mAuxBuffersPerLeaf;
826 const bool mIsMaster;
831 template<
typename TreeT>
850 #endif // OPENVDB_TREE_LEAFMANAGER_HAS_BEEN_INCLUDED void removeAuxBuffers()
Remove the auxiliary buffers, but don't rebuild the leaf array.
Definition: LeafManager.h:313
void rebuildLeafArray()
Remove the auxiliary buffers and rebuild the leaf array.
Definition: LeafManager.h:316
RootNodeType & root()
Return a reference to the root node associated with this manager.
Definition: LeafManager.h:352
LeafType * operator->() const
Return a pointer to the leaf node to which this iterator is pointing.
Definition: LeafManager.h:144
bool empty() const
Return true if this iterator is exhausted.
Definition: LeafManager.h:160
typename TreeT::RootNodeType RootNodeType
Definition: LeafManager.h:115
const LeafManager & leafManager() const
Definition: LeafManager.h:189
LeafType & operator*() const
Return a reference to the leaf node to which this iterator is pointing.
Definition: LeafManager.h:142
Definition: LeafManager.h:130
void rebuild(TreeType &tree, size_t auxBuffersPerLeaf, bool serial=false)
Repopulate the leaf array and delete and reallocate auxiliary buffers.
Definition: LeafManager.h:296
bool syncAllBuffers(bool serial=false)
Sync up all auxiliary buffers with their corresponding leaf node buffers.
Definition: LeafManager.h:448
typename TreeT::LeafCIter LeafIterType
Definition: LeafManager.h:69
LeafRange leafRange(size_t grainsize=1) const
Return a TBB-compatible LeafRange.
Definition: LeafManager.h:386
size_t leafCount() const
Return the number of leaf nodes.
Definition: LeafManager.h:328
LeafRange(LeafRange &r, tbb::split)
Definition: LeafManager.h:195
#define OPENVDB_THROW(exception, message)
Definition: Exceptions.h:109
void reduce(LeafOp &op, bool threaded=true, size_t grainSize=1)
Threaded method that applies a user-supplied functor to each leaf node in the LeafManager. Unlike foreach (defined above) this method performs a reduction on all the leaf nodes.
Definition: LeafManager.h:573
size_t auxBuffersPerLeaf() const
Return the number of auxiliary buffers per leaf node.
Definition: LeafManager.h:325
typename TreeT::ValueType ValueType
Definition: LeafManager.h:114
LeafType LeafNodeType
Definition: LeafManager.h:118
static void doSwapLeafBuffer(const RangeT &r, size_t auxBufferIdx, LeafT **leafs, BufT *bufs, size_t bufsPerLeaf)
Definition: LeafManager.h:85
void operator()(const RangeType &r) const
Used internally by tbb::parallel_for() - never call it directly!
Definition: LeafManager.h:658
typename ManagerT::LeafType LeafT
Definition: LeafManager.h:82
LeafManager(TreeType &tree, LeafType **begin, LeafType **end, size_t auxBuffersPerLeaf=0, bool serial=false)
Construct directly from an existing array of leafnodes.
Definition: LeafManager.h:234
BufferType & getBuffer(size_t leafIdx, size_t bufferIdx) const
Return the leaf or auxiliary buffer for the leaf node at index leafIdx. If bufferIdx is zero...
Definition: LeafManager.h:371
const RootNodeType & root() const
Return a const reference to root node associated with this manager.
Definition: LeafManager.h:349
BufferType & buffer(size_t bufferIdx)
Return the nth buffer for the leaf node to which this iterator is pointing, where n = bufferIdx and n...
Definition: LeafManager.h:147
bool syncAuxBuffer(size_t bufferIdx, bool serial=false)
Sync up the specified auxiliary buffer with the corresponding leaf node buffer.
Definition: LeafManager.h:436
LeafManager(TreeType &tree, size_t auxBuffersPerLeaf=0, bool serial=false)
Constructor from a tree reference and an auxiliary buffer count.
Definition: LeafManager.h:218
size_t auxBufferCount() const
Return the total number of allocated auxiliary buffers.
Definition: LeafManager.h:323
bool swapLeafBuffer(size_t bufferIdx, bool serial=false)
Swap each leaf node's buffer with the nth corresponding auxiliary buffer, where n = bufferIdx...
Definition: LeafManager.h:400
size_t grainsize() const
Definition: LeafManager.h:187
void rebuild(bool serial=false)
(Re)initialize by resizing (if necessary) and repopulating the leaf array and by deleting existing au...
Definition: LeafManager.h:279
LeafManager(const LeafManager &other)
Definition: LeafManager.h:254
typename std::remove_const< ToType >::type Type
Definition: TreeIterator.h:68
typename CopyConstness< TreeType, NonConstLeafType >::Type LeafType
Definition: LeafManager.h:117
void getNodes(ArrayT &array)
Insert pointers to nodes of the specified type into the array.
Definition: LeafManager.h:585
Useful traits for Tree types.
Definition: LeafManager.h:63
Iterator end() const
Definition: LeafManager.h:183
Definition: LeafManager.h:79
bool test() const
Return true if this iterator is not yet exhausted.
Definition: LeafManager.h:156
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h:136
LeafRange(size_t begin, size_t end, const LeafManager &leafManager, size_t grainSize=1)
Definition: LeafManager.h:173
Iterator & operator++()
Advance to the next leaf node.
Definition: LeafManager.h:140
Index64 activeLeafVoxelCount() const
Return the number of active voxels in the leaf nodes.
Definition: LeafManager.h:332
Definition: Exceptions.h:92
bool empty() const
Definition: LeafManager.h:191
LeafType & leaf(size_t leafIdx) const
Return a pointer to the leaf node at index leafIdx in the array.
Definition: LeafManager.h:359
Iterator begin() const
Definition: LeafManager.h:181
Definition: Exceptions.h:40
typename ManagerT::BufferType BufT
Definition: LeafManager.h:837
typename ManagerT::LeafType LeafT
Definition: LeafManager.h:836
typename CopyConstness< TreeType, NonConstBufferType >::Type BufferType
Definition: LeafManager.h:121
typename TreeT::LeafIter LeafIterType
Definition: LeafManager.h:65
bool operator==(const Iterator &other) const
Definition: LeafManager.h:165
typename TreeType::LeafNodeType NonConstLeafType
Definition: LeafManager.h:116
Index32 Index
Definition: Types.h:61
bool operator!=(const Iterator &other) const
Definition: LeafManager.h:161
typename ManagerT::RangeType RangeT
Definition: LeafManager.h:81
typename LeafType::Buffer NonConstBufferType
Definition: LeafManager.h:120
static void doSwapLeafBuffer(const RangeT &, size_t, LeafT **, BufT *, size_t)
Definition: LeafManager.h:839
uint64_t Index64
Definition: Types.h:60
TreeT TreeType
Definition: LeafManager.h:113
This class manages a linear array of pointers to a given tree's leaf nodes, as well as optional auxil...
Definition: LeafManager.h:110
size_t pos() const
Return the index into the leaf array of the current leaf node.
Definition: LeafManager.h:152
Iterator(const LeafRange &range, size_t pos)
Definition: LeafManager.h:133
typename ManagerT::BufferType BufT
Definition: LeafManager.h:83
size_t size() const
Definition: LeafManager.h:185
Definition: LeafManager.h:127
const TreeType & tree() const
Return a const reference to tree associated with this manager.
Definition: LeafManager.h:343
typename leafmgr::TreeTraits< TreeT >::LeafIterType LeafIterType
Definition: LeafManager.h:119
bool isConstTree() const
Return true if the tree associated with this manager is immutable.
Definition: LeafManager.h:355
const LeafRange & leafRange() const
Definition: LeafManager.h:166
bool isValid() const
Return true if the position of this iterator is in a valid range.
Definition: LeafManager.h:154
void rebuild(TreeType &tree, bool serial=false)
Repopulate the leaf array and delete and reallocate auxiliary buffers.
Definition: LeafManager.h:291
virtual ~LeafManager()
Definition: LeafManager.h:266
Mat3< typename promote< T0, T1 >::type > operator*(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Multiply m0 by m1 and return the resulting matrix.
Definition: Mat3.h:645
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:188
size_t getPrefixSum(size_t *&offsets, size_t &size, size_t grainSize=1) const
Generate a linear array of prefix sums of offsets into the active voxels in the leafs. So offsets[n]+m is the offset to the mth active voxel in the nth leaf node (useful for user-managed value buffers, e.g. in tools/LevelSetAdvect.h).
Definition: LeafManager.h:635
RangeType getRange(size_t grainsize=1) const
Return a tbb::blocked_range of leaf array indices.
Definition: LeafManager.h:383
void getNodes(ArrayT &array) const
Insert node pointers of the specified type into the array.
Definition: LeafManager.h:607
bool swapBuffer(size_t bufferIdx1, size_t bufferIdx2, bool serial=false)
Swap any two buffers for each leaf node.
Definition: LeafManager.h:412
bool is_divisible() const
Definition: LeafManager.h:193
typename ManagerT::RangeType RangeT
Definition: LeafManager.h:835
TreeType & tree()
Return a reference to the tree associated with this manager.
Definition: LeafManager.h:346
tbb::blocked_range< size_t > RangeType
Definition: LeafManager.h:122