Loading...
Searching...
No Matches
LeafManager.h
Go to the documentation of this file.
// Copyright Contributors to the OpenVDB Project
// SPDX-License-Identifier: MPL-2.0
/// @file LeafManager.h
///
/// @brief A LeafManager manages a linear array of pointers to a given tree's
/// leaf nodes, as well as optional auxiliary buffers (one or more per leaf)
/// that can be swapped with the leaf nodes' voxel data buffers.
/// @details The leaf array is useful for multithreaded computations over
/// leaf voxels in a tree with static topology but varying voxel values.
/// The auxiliary buffers are convenient for temporal integration.
/// Efficient methods are provided for multithreaded swapping and synching
/// (i.e., copying the contents) of these buffers.
#ifndef OPENVDB_TREE_LEAFMANAGER_HAS_BEEN_INCLUDED
#define OPENVDB_TREE_LEAFMANAGER_HAS_BEEN_INCLUDED
#include <openvdb/Types.h>
#include "RootNode.h" // for NodeChain
#include <tbb/blocked_range.h>
#include <tbb/parallel_for.h>
#include <tbb/parallel_reduce.h>
#include <deque>
#include <functional>
#include <type_traits>
namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace tree {
namespace leafmgr {
//@{
/// Useful traits for Tree types
template<typename TreeT> struct TreeTraits {
static const bool IsConstTree = false;
using LeafIterType = typename TreeT::LeafIter;
};
template<typename TreeT> struct TreeTraits<const TreeT> {
static const bool IsConstTree = true;
using LeafIterType = typename TreeT::LeafCIter;
};
//@}
} // namespace leafmgr
/// This helper class implements LeafManager methods that need to be
/// specialized for const vs. non-const trees.
template<typename ManagerT>
struct LeafManagerImpl
{
using RangeT = typename ManagerT::RangeType;
using LeafT = typename ManagerT::LeafType;
using BufT = typename ManagerT::BufferType;
static inline void doSwapLeafBuffer(const RangeT& r, size_t auxBufferIdx,
LeafT** leafs, BufT* bufs, size_t bufsPerLeaf)
{
for (size_t n = r.begin(), m = r.end(), N = bufsPerLeaf; n != m; ++n) {
leafs[n]->swap(bufs[n * N + auxBufferIdx]);
}
}
};
////////////////////////////////////////
/// @brief This class manages a linear array of pointers to a given tree's
/// leaf nodes, as well as optional auxiliary buffers (one or more per leaf)
/// that can be swapped with the leaf nodes' voxel data buffers.
/// @details The leaf array is useful for multithreaded computations over
/// leaf voxels in a tree with static topology but varying voxel values.
/// The auxiliary buffers are convenient for temporal integration.
/// Efficient methods are provided for multithreaded swapping and sync'ing
/// (i.e., copying the contents) of these buffers.
///
/// @note Buffer index 0 denotes a leaf node's internal voxel data buffer.
/// Any auxiliary buffers are indexed starting from one.
template<typename TreeT>
class LeafManager
{
public:
using TreeType = TreeT;
using ValueType = typename TreeT::ValueType;
using RootNodeType = typename TreeT::RootNodeType;
using NonConstLeafType = typename TreeType::LeafNodeType;
using LeafType = typename CopyConstness<TreeType, NonConstLeafType>::Type;
using LeafNodeType = LeafType;
using LeafIterType = typename leafmgr::TreeTraits<TreeT>::LeafIterType;
using NonConstBufferType = typename LeafType::Buffer;
using BufferType = typename CopyConstness<TreeType, NonConstBufferType>::Type;
using RangeType = tbb::blocked_range<size_t>; // leaf index range
static const Index DEPTH = 2; // root + leaf nodes
static const bool IsConstTree = leafmgr::TreeTraits<TreeT>::IsConstTree;
class LeafRange
{
public:
class Iterator
{
public:
Iterator(const LeafRange& range, size_t pos): mRange(range), mPos(pos)
{
assert(this->isValid());
}
Iterator(const Iterator&) = default;
Iterator& operator=(const Iterator&) = default;
/// Advance to the next leaf node.
Iterator& operator++() { ++mPos; return *this; }
/// Return a reference to the leaf node to which this iterator is pointing.
LeafType& operator*() const { return mRange.mLeafManager.leaf(mPos); }
/// Return a pointer to the leaf node to which this iterator is pointing.
LeafType* operator->() const { return &(this->operator*()); }
/// @brief Return the nth buffer for the leaf node to which this iterator is pointing,
/// where n = @a bufferIdx and n = 0 corresponds to the leaf node's own buffer.
BufferType& buffer(size_t bufferIdx)
{
return mRange.mLeafManager.getBuffer(mPos, bufferIdx);
}
/// Return the index into the leaf array of the current leaf node.
size_t pos() const { return mPos; }
/// Return @c true if the position of this iterator is in a valid range.
bool isValid() const { return mPos>=mRange.mBegin && mPos<=mRange.mEnd; }
/// Return @c true if this iterator is not yet exhausted.
bool test() const { return mPos < mRange.mEnd; }
/// Return @c true if this iterator is not yet exhausted.
operator bool() const { return this->test(); }
/// Return @c true if this iterator is exhausted.
bool empty() const { return !this->test(); }
bool operator!=(const Iterator& other) const
{
return (mPos != other.mPos) || (&mRange != &other.mRange);
}
bool operator==(const Iterator& other) const { return !(*this != other); }
const LeafRange& leafRange() const { return mRange; }
private:
const LeafRange& mRange;
size_t mPos;
};// end Iterator
LeafRange(size_t begin, size_t end, const LeafManager& leafManager, size_t grainSize=1)
: mEnd(end)
, mBegin(begin)
, mGrainSize(grainSize)
, mLeafManager(leafManager)
{
}
Iterator begin() const {return Iterator(*this, mBegin);}
Iterator end() const {return Iterator(*this, mEnd);}
size_t size() const { return mEnd - mBegin; }
size_t grainsize() const { return mGrainSize; }
const LeafManager& leafManager() const { return mLeafManager; }
bool empty() const {return !(mBegin < mEnd);}
bool is_divisible() const {return mGrainSize < this->size();}
LeafRange(LeafRange& r, tbb::split)
: mEnd(r.mEnd)
, mBegin(doSplit(r))
, mGrainSize(r.mGrainSize)
, mLeafManager(r.mLeafManager)
{
}
private:
size_t mEnd, mBegin, mGrainSize;
const LeafManager& mLeafManager;
static size_t doSplit(LeafRange& r)
{
assert(r.is_divisible());
size_t middle = r.mBegin + (r.mEnd - r.mBegin) / 2u;
r.mEnd = middle;
return middle;
}
};// end of LeafRange
/// @brief Constructor from a tree reference and an auxiliary buffer count
/// @note The default is no auxiliary buffers
LeafManager(TreeType& tree, size_t auxBuffersPerLeaf=0, bool serial=false)
: mTree(&tree)
, mLeafCount(0)
, mAuxBufferCount(0)
, mAuxBuffersPerLeaf(auxBuffersPerLeaf)
{
this->rebuild(serial);
}
/// @brief Construct directly from an existing array of leafnodes.
/// @warning The leafnodes are implicitly assumed to exist in the
/// input @a tree.
LeafManager(TreeType& tree, LeafType** begin, LeafType** end,
size_t auxBuffersPerLeaf=0, bool serial=false)
: mTree(&tree)
, mLeafCount(end-begin)
, mAuxBufferCount(0)
, mAuxBuffersPerLeaf(auxBuffersPerLeaf)
, mLeafPtrs(new LeafType*[mLeafCount])
, mLeafs(mLeafPtrs.get())
{
size_t n = mLeafCount;
LeafType **target = mLeafs, **source = begin;
while (n--) *target++ = *source++;
if (auxBuffersPerLeaf) this->initAuxBuffers(serial);
}
/// Shallow copy constructor called by tbb::parallel_for() threads
///
/// @note This should never get called directly
LeafManager(const LeafManager& other)
: mTree(other.mTree)
, mLeafCount(other.mLeafCount)
, mAuxBufferCount(other.mAuxBufferCount)
, mAuxBuffersPerLeaf(other.mAuxBuffersPerLeaf)
, mLeafs(other.mLeafs)
, mAuxBuffers(other.mAuxBuffers)
, mTask(other.mTask)
{
}
/// @brief (Re)initialize by resizing (if necessary) and repopulating the leaf array
/// and by deleting existing auxiliary buffers and allocating new ones.
/// @details Call this method if the tree's topology, and therefore the number
/// of leaf nodes, changes. New auxiliary buffers are initialized with copies
/// of corresponding leaf node buffers.
void rebuild(bool serial=false)
{
this->initLeafArray(serial);
this->initAuxBuffers(serial);
}
//@{
/// Repopulate the leaf array and delete and reallocate auxiliary buffers.
void rebuild(size_t auxBuffersPerLeaf, bool serial=false)
{
mAuxBuffersPerLeaf = auxBuffersPerLeaf;
this->rebuild(serial);
}
void rebuild(TreeType& tree, bool serial=false)
{
mTree = &tree;
this->rebuild(serial);
}
void rebuild(TreeType& tree, size_t auxBuffersPerLeaf, bool serial=false)
{
mTree = &tree;
mAuxBuffersPerLeaf = auxBuffersPerLeaf;
this->rebuild(serial);
}
//@}
/// @brief Change the number of auxiliary buffers.
/// @details If auxBuffersPerLeaf is 0, all existing auxiliary buffers are deleted.
/// New auxiliary buffers are initialized with copies of corresponding leaf node buffers.
/// This method does not rebuild the leaf array.
void rebuildAuxBuffers(size_t auxBuffersPerLeaf, bool serial=false)
{
mAuxBuffersPerLeaf = auxBuffersPerLeaf;
this->initAuxBuffers(serial);
}
/// @brief Remove the auxiliary buffers, but don't rebuild the leaf array.
void removeAuxBuffers() { this->rebuildAuxBuffers(0); }
/// @brief Remove the auxiliary buffers and rebuild the leaf array.
void rebuildLeafArray(bool serial = false)
{
this->removeAuxBuffers();
this->initLeafArray(serial);
}
/// @brief Return the total number of allocated auxiliary buffers.
size_t auxBufferCount() const { return mAuxBufferCount; }
/// @brief Return the number of auxiliary buffers per leaf node.
size_t auxBuffersPerLeaf() const { return mAuxBuffersPerLeaf; }
/// @brief Return the number of leaf nodes.
size_t leafCount() const { return mLeafCount; }
/// @brief Return the number of active voxels in the leaf nodes.
/// @note Multi-threaded for better performance than Tree::activeLeafVoxelCount
Index64 activeLeafVoxelCount() const
{
return tbb::parallel_reduce(this->leafRange(), Index64(0),
[] (const LeafRange& range, Index64 sum) -> Index64 {
for (const auto& leaf: range) { sum += leaf.onVoxelCount(); }
return sum;
},
[] (Index64 n, Index64 m) -> Index64 { return n + m; });
}
/// Return a const reference to tree associated with this manager.
const TreeType& tree() const { return *mTree; }
/// Return a reference to the tree associated with this manager.
TreeType& tree() { return *mTree; }
/// Return a const reference to root node associated with this manager.
const RootNodeType& root() const { return mTree->root(); }
/// Return a reference to the root node associated with this manager.
RootNodeType& root() { return mTree->root(); }
/// Return @c true if the tree associated with this manager is immutable.
bool isConstTree() const { return this->IsConstTree; }
/// @brief Return a pointer to the leaf node at index @a leafIdx in the array.
/// @note For performance reasons no range check is performed (other than an assertion)!
LeafType& leaf(size_t leafIdx) const { assert(leafIdx<mLeafCount); return *mLeafs[leafIdx]; }
/// @brief Return the leaf or auxiliary buffer for the leaf node at index @a leafIdx.
/// If @a bufferIdx is zero, return the leaf buffer, otherwise return the nth
/// auxiliary buffer, where n = @a bufferIdx - 1.
///
/// @note For performance reasons no range checks are performed on the inputs
/// (other than assertions)! Since auxiliary buffers, unlike leaf buffers,
/// might not exist, be especially careful when specifying the @a bufferIdx.
/// @note For const trees, this method always returns a reference to a const buffer.
/// It is safe to @c const_cast and modify any auxiliary buffer (@a bufferIdx > 0),
/// but it is not safe to modify the leaf buffer (@a bufferIdx = 0).
BufferType& getBuffer(size_t leafIdx, size_t bufferIdx) const
{
assert(leafIdx < mLeafCount);
assert(bufferIdx == 0 || bufferIdx - 1 < mAuxBuffersPerLeaf);
return bufferIdx == 0 ? mLeafs[leafIdx]->buffer()
: mAuxBuffers[leafIdx * mAuxBuffersPerLeaf + bufferIdx - 1];
}
/// @brief Return a @c tbb::blocked_range of leaf array indices.
///
/// @note Consider using leafRange() instead, which provides access methods
/// to leaf nodes and buffers.
RangeType getRange(size_t grainsize = 1) const { return RangeType(0, mLeafCount, grainsize); }
/// Return a TBB-compatible LeafRange.
LeafRange leafRange(size_t grainsize = 1) const
{
return LeafRange(0, mLeafCount, *this, grainsize);
}
/// @brief Swap each leaf node's buffer with the nth corresponding auxiliary buffer,
/// where n = @a bufferIdx.
/// @return @c true if the swap was successful
/// @param bufferIdx index of the buffer that will be swapped with
/// the corresponding leaf node buffer
/// @param serial if false, swap buffers in parallel using multiple threads.
/// @note Recall that the indexing of auxiliary buffers is 1-based, since
/// buffer index 0 denotes the leaf node buffer. So buffer index 1 denotes
/// the first auxiliary buffer.
bool swapLeafBuffer(size_t bufferIdx, bool serial = false)
{
namespace ph = std::placeholders;
if (bufferIdx == 0 || bufferIdx > mAuxBuffersPerLeaf || this->isConstTree()) return false;
mTask = std::bind(&LeafManager::doSwapLeafBuffer, ph::_1, ph::_2, bufferIdx - 1);
this->cook(serial ? 0 : 512);
return true;//success
}
/// @brief Swap any two buffers for each leaf node.
/// @note Recall that the indexing of auxiliary buffers is 1-based, since
/// buffer index 0 denotes the leaf node buffer. So buffer index 1 denotes
/// the first auxiliary buffer.
bool swapBuffer(size_t bufferIdx1, size_t bufferIdx2, bool serial = false)
{
namespace ph = std::placeholders;
const size_t b1 = std::min(bufferIdx1, bufferIdx2);
const size_t b2 = std::max(bufferIdx1, bufferIdx2);
if (b1 == b2 || b2 > mAuxBuffersPerLeaf) return false;
if (b1 == 0) {
if (this->isConstTree()) return false;
mTask = std::bind(&LeafManager::doSwapLeafBuffer, ph::_1, ph::_2, b2-1);
} else {
mTask = std::bind(&LeafManager::doSwapAuxBuffer, ph::_1, ph::_2, b1-1, b2-1);
}
this->cook(serial ? 0 : 512);
return true;//success
}
/// @brief Sync up the specified auxiliary buffer with the corresponding leaf node buffer.
/// @return @c true if the sync was successful
/// @param bufferIdx index of the buffer that will contain a
/// copy of the corresponding leaf node buffer
/// @param serial if false, sync buffers in parallel using multiple threads.
/// @note Recall that the indexing of auxiliary buffers is 1-based, since
/// buffer index 0 denotes the leaf node buffer. So buffer index 1 denotes
/// the first auxiliary buffer.
bool syncAuxBuffer(size_t bufferIdx, bool serial = false)
{
namespace ph = std::placeholders;
if (bufferIdx == 0 || bufferIdx > mAuxBuffersPerLeaf) return false;
mTask = std::bind(&LeafManager::doSyncAuxBuffer, ph::_1, ph::_2, bufferIdx - 1);
this->cook(serial ? 0 : 64);
return true;//success
}
/// @brief Sync up all auxiliary buffers with their corresponding leaf node buffers.
/// @return true if the sync was successful
/// @param serial if false, sync buffers in parallel using multiple threads.
bool syncAllBuffers(bool serial = false)
{
namespace ph = std::placeholders;
switch (mAuxBuffersPerLeaf) {
case 0: return false;//nothing to do
case 1: mTask = std::bind(&LeafManager::doSyncAllBuffers1, ph::_1, ph::_2); break;
case 2: mTask = std::bind(&LeafManager::doSyncAllBuffers2, ph::_1, ph::_2); break;
default: mTask = std::bind(&LeafManager::doSyncAllBuffersN, ph::_1, ph::_2); break;
}
this->cook(serial ? 0 : 64);
return true;//success
}
/// @brief Threaded method that applies a user-supplied functor
/// to each leaf node in the LeafManager.
///
/// @details The user-supplied functor needs to define the methods
/// required for tbb::parallel_for.
///
/// @param op user-supplied functor, see examples for interface details.
/// @param threaded optional toggle to disable threading, on by default.
/// @param grainSize optional parameter to specify the grainsize
/// for threading, one by default.
///
/// @warning The functor object is deep-copied to create TBB tasks.
/// This allows the function to use non-thread-safe members
/// like a ValueAccessor.
///
/// @par Example:
/// @code
/// // Functor to offset a tree's voxel values with values from another tree.
/// template<typename TreeType>
/// struct OffsetOp
/// {
/// using Accessor = tree::ValueAccessor<const TreeType>;
///
/// OffsetOp(const TreeType& tree): mRhsTreeAcc(tree) {}
///
/// template <typename LeafNodeType>
/// void operator()(LeafNodeType &lhsLeaf, size_t) const
/// {
/// const LeafNodeType *rhsLeaf = mRhsTreeAcc.probeConstLeaf(lhsLeaf.origin());
/// if (rhsLeaf) {
/// typename LeafNodeType::ValueOnIter iter = lhsLeaf.beginValueOn();
/// for (; iter; ++iter) {
/// iter.setValue(iter.getValue() + rhsLeaf->getValue(iter.pos()));
/// }
/// }
/// }
/// Accessor mRhsTreeAcc;
/// };
///
/// // usage:
/// tree::LeafManager<FloatTree> leafNodes(lhsTree);
/// leafNodes.foreach(OffsetOp<FloatTree>(rhsTree));
///
/// // A functor that performs a min operation between different auxiliary buffers.
/// template<typename LeafManagerType>
/// struct MinOp
/// {
/// using BufferType = typename LeafManagerType::BufferType;
///
/// MinOp(LeafManagerType& leafNodes): mLeafs(leafNodes) {}
///
/// template <typename LeafNodeType>
/// void operator()(LeafNodeType &leaf, size_t leafIndex) const
/// {
/// // get the first buffer
/// BufferType& buffer = mLeafs.getBuffer(leafIndex, 1);
///
/// // min ...
/// }
/// LeafManagerType& mLeafs;
/// };
/// @endcode
template<typename LeafOp>
void foreach(const LeafOp& op, bool threaded = true, size_t grainSize=1)
{
LeafTransformer<LeafOp> transform(op);
transform.run(this->leafRange(grainSize), threaded);
}
/// @brief 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.
///
/// @details The user-supplied functor needs to define the methods
/// required for tbb::parallel_reduce.
///
/// @param op user-supplied functor, see examples for interface details.
/// @param threaded optional toggle to disable threading, on by default.
/// @param grainSize optional parameter to specify the grainsize
/// for threading, one by default.
///
/// @warning The functor object is deep-copied to create TBB tasks.
/// This allows the function to use non-thread-safe members
/// like a ValueAccessor.
///
/// @par Example:
/// @code
/// // Functor to count the number of negative (active) leaf values
/// struct CountOp
/// {
/// CountOp() : mCounter(0) {}
/// CountOp(const CountOp &other) : mCounter(other.mCounter) {}
/// CountOp(const CountOp &other, tbb::split) : mCounter(0) {}
/// template <typename LeafNodeType>
/// void operator()(LeafNodeType &leaf, size_t)
/// {
/// typename LeafNodeType::ValueOnIter iter = leaf.beginValueOn();
/// for (; iter; ++iter) if (*iter < 0.0f) ++mCounter;
/// }
/// void join(const CountOp &other) {mCounter += other.mCounter;}
/// size_t mCounter;
/// };
///
/// // usage:
/// tree::LeafManager<FloatTree> leafNodes(tree);
/// MinValueOp min;
/// leafNodes.reduce(min);
/// std::cerr << "Number of negative active voxels = " << min.mCounter << std::endl;
///
/// @endcode
template<typename LeafOp>
void reduce(LeafOp& op, bool threaded = true, size_t grainSize=1)
{
LeafReducer<LeafOp> transform(op);
transform.run(this->leafRange(grainSize), threaded);
}
/// @brief Generate a linear array of prefix sums of offsets into the
/// active voxels in the leafs. So @a 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).
/// @return The total number of active values in the leaf nodes
/// @param offsets array of prefix sums of offsets to active voxels
/// @param size on input, the size of @a offsets; on output, its new size
/// @param grainSize optional grain size for threading
/// @details If @a offsets is @c nullptr or @a size is smaller than the
/// total number of active voxels (the return value) then @a offsets
/// is reallocated and @a size equals the total number of active voxels.
size_t getPrefixSum(size_t*& offsets, size_t& size, size_t grainSize=1) const
{
if (offsets == nullptr || size < mLeafCount) {
delete [] offsets;
offsets = new size_t[mLeafCount];
size = mLeafCount;
}
size_t prefix = 0;
if ( grainSize > 0 ) {
PrefixSum tmp(this->leafRange( grainSize ), offsets, prefix);
} else {// serial
for (size_t i=0; i<mLeafCount; ++i) {
offsets[i] = prefix;
prefix += mLeafs[i]->onVoxelCount();
}
}
return prefix;
}
////////////////////////////////////////////////////////////////////////////////////
// All methods below are for internal use only and should never be called directly
/// Used internally by tbb::parallel_for() - never call it directly!
void operator()(const RangeType& r) const
{
if (mTask) mTask(const_cast<LeafManager*>(this), r);
else OPENVDB_THROW(ValueError, "task is undefined");
}
private:
void initLeafArray(bool serial = false)
{
// Build an array of all nodes that have leaf nodes as their immediate children
using NodeChainT = typename NodeChain<RootNodeType, RootNodeType::LEVEL>::Type;
using NonConstLeafParentT = typename NodeChainT::template Get</*Level=*/1>;
using LeafParentT = typename CopyConstness<TreeType, NonConstLeafParentT>::Type;
std::deque<LeafParentT*> leafParents;
mTree->getNodes(leafParents);
// Compute the leaf counts for each node
std::vector<Index32> leafCounts;
if (serial) {
leafCounts.reserve(leafParents.size());
for (LeafParentT* leafParent : leafParents) {
leafCounts.push_back(leafParent->childCount());
}
} else {
leafCounts.resize(leafParents.size());
tbb::parallel_for(
// with typical node sizes and SSE enabled, there are only a handful
// of instructions executed per-operation with a default grainsize
// of 1, so increase to 64 to reduce parallel scheduling overhead
tbb::blocked_range<size_t>(0, leafParents.size(), /*grainsize=*/64),
[&](tbb::blocked_range<size_t>& range)
{
for (size_t i = range.begin(); i < range.end(); i++) {
leafCounts[i] = leafParents[i]->childCount();
}
}
);
}
// Turn leaf counts into a cumulative histogram and obtain total leaf count
for (size_t i = 1; i < leafCounts.size(); i++) {
leafCounts[i] += leafCounts[i-1];
}
const size_t leafCount = leafCounts.empty() ? 0 : leafCounts.back();
// Allocate (or deallocate) the leaf pointer array
if (leafCount != mLeafCount) {
if (leafCount > 0) {
mLeafPtrs.reset(new LeafType*[leafCount]);
mLeafs = mLeafPtrs.get();
} else {
mLeafPtrs.reset();
mLeafs = nullptr;
}
mLeafCount = leafCount;
}
if (mLeafCount == 0) return;
// Populate the leaf node pointers
if (serial) {
LeafType** leafPtr = mLeafs;
for (LeafParentT* leafParent : leafParents) {
for (auto iter = leafParent->beginChildOn(); iter; ++iter) {
*leafPtr++ = &iter.getValue();
}
}
} else {
tbb::parallel_for(
tbb::blocked_range<size_t>(0, leafParents.size()),
[&](tbb::blocked_range<size_t>& range)
{
size_t i = range.begin();
LeafType** leafPtr = mLeafs;
if (i > 0) leafPtr += leafCounts[i-1];
for ( ; i < range.end(); i++) {
for (auto iter = leafParents[i]->beginChildOn(); iter; ++iter) {
*leafPtr++ = &iter.getValue();
}
}
}
);
}
}
void initAuxBuffers(bool serial)
{
const size_t auxBufferCount = mLeafCount * mAuxBuffersPerLeaf;
if (auxBufferCount != mAuxBufferCount) {
if (auxBufferCount > 0) {
mAuxBufferPtrs.reset(new NonConstBufferType[auxBufferCount]);
mAuxBuffers = mAuxBufferPtrs.get();
} else {
mAuxBufferPtrs.reset();
mAuxBuffers = nullptr;
}
mAuxBufferCount = auxBufferCount;
}
this->syncAllBuffers(serial);
}
void cook(size_t grainsize)
{
if (grainsize>0) {
tbb::parallel_for(this->getRange(grainsize), *this);
} else {
(*this)(this->getRange());
}
}
void doSwapLeafBuffer(const RangeType& r, size_t auxBufferIdx)
{
LeafManagerImpl<LeafManager>::doSwapLeafBuffer(
r, auxBufferIdx, mLeafs, mAuxBuffers, mAuxBuffersPerLeaf);
}
void doSwapAuxBuffer(const RangeType& r, size_t auxBufferIdx1, size_t auxBufferIdx2)
{
for (size_t N = mAuxBuffersPerLeaf, n = N*r.begin(), m = N*r.end(); n != m; n+=N) {
mAuxBuffers[n + auxBufferIdx1].swap(mAuxBuffers[n + auxBufferIdx2]);
}
}
void doSyncAuxBuffer(const RangeType& r, size_t auxBufferIdx)
{
for (size_t n = r.begin(), m = r.end(), N = mAuxBuffersPerLeaf; n != m; ++n) {
mAuxBuffers[n*N + auxBufferIdx] = mLeafs[n]->buffer();
}
}
void doSyncAllBuffers1(const RangeType& r)
{
for (size_t n = r.begin(), m = r.end(); n != m; ++n) {
mAuxBuffers[n] = mLeafs[n]->buffer();
}
}
void doSyncAllBuffers2(const RangeType& r)
{
for (size_t n = r.begin(), m = r.end(); n != m; ++n) {
const BufferType& leafBuffer = mLeafs[n]->buffer();
mAuxBuffers[2*n ] = leafBuffer;
mAuxBuffers[2*n+1] = leafBuffer;
}
}
void doSyncAllBuffersN(const RangeType& r)
{
for (size_t n = r.begin(), m = r.end(), N = mAuxBuffersPerLeaf; n != m; ++n) {
const BufferType& leafBuffer = mLeafs[n]->buffer();
for (size_t i=n*N, j=i+N; i!=j; ++i) mAuxBuffers[i] = leafBuffer;
}
}
/// @brief Private member class that applies a user-defined
/// functor to perform parallel_for on all the leaf nodes.
template<typename LeafOp>
struct LeafTransformer
{
LeafTransformer(const LeafOp &leafOp) : mLeafOp(leafOp)
{
}
void run(const LeafRange &range, bool threaded) const
{
threaded ? tbb::parallel_for(range, *this) : (*this)(range);
}
void operator()(const LeafRange &range) const
{
for (typename LeafRange::Iterator it = range.begin(); it; ++it) mLeafOp(*it, it.pos());
}
const LeafOp mLeafOp;
};// LeafTransformer
/// @brief Private member class that applies a user-defined
/// functor to perform parallel_reduce on all the leaf nodes.
template<typename LeafOp>
struct LeafReducer
{
LeafReducer(LeafOp &leafOp) : mLeafOp(&leafOp)
{
}
LeafReducer(const LeafReducer &other, tbb::split)
: mLeafOpPtr(std::make_unique<LeafOp>(*(other.mLeafOp), tbb::split()))
, mLeafOp(mLeafOpPtr.get())
{
}
void run(const LeafRange& range, bool threaded)
{
threaded ? tbb::parallel_reduce(range, *this) : (*this)(range);
}
void operator()(const LeafRange& range)
{
LeafOp &op = *mLeafOp;//local registry
for (typename LeafRange::Iterator it = range.begin(); it; ++it) op(*it, it.pos());
}
void join(const LeafReducer& other) { mLeafOp->join(*(other.mLeafOp)); }
std::unique_ptr<LeafOp> mLeafOpPtr;
LeafOp *mLeafOp = nullptr;
};// LeafReducer
// Helper class to compute a prefix sum of offsets to active voxels
struct PrefixSum
{
PrefixSum(const LeafRange& r, size_t* offsets, size_t& prefix)
: mOffsets(offsets)
{
tbb::parallel_for( r, *this);
for (size_t i=0, leafCount = r.size(); i<leafCount; ++i) {
size_t tmp = offsets[i];
offsets[i] = prefix;
prefix += tmp;
}
}
inline void operator()(const LeafRange& r) const {
for (typename LeafRange::Iterator i = r.begin(); i; ++i) {
mOffsets[i.pos()] = i->onVoxelCount();
}
}
size_t* mOffsets;
};// PrefixSum
using FuncType = typename std::function<void (LeafManager*, const RangeType&)>;
TreeType* mTree;
size_t mLeafCount, mAuxBufferCount, mAuxBuffersPerLeaf;
std::unique_ptr<LeafType*[]> mLeafPtrs;
LeafType** mLeafs = nullptr;//array of LeafNode pointers
std::unique_ptr<NonConstBufferType[]> mAuxBufferPtrs;
NonConstBufferType* mAuxBuffers = nullptr;//array of auxiliary buffers
FuncType mTask = nullptr;
};//end of LeafManager class
// Partial specializations of LeafManager methods for const trees
template<typename TreeT>
struct LeafManagerImpl<LeafManager<const TreeT> >
{
using ManagerT = LeafManager<const TreeT>;
using RangeT = typename ManagerT::RangeType;
using LeafT = typename ManagerT::LeafType;
using BufT = typename ManagerT::BufferType;
static inline void doSwapLeafBuffer(const RangeT&, size_t /*auxBufferIdx*/,
LeafT**, BufT*, size_t /*bufsPerLeaf*/)
{
// Buffers can't be swapped into const trees.
}
};
} // namespace tree
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb
#endif // OPENVDB_TREE_LEAFMANAGER_HAS_BEEN_INCLUDED
RootNode.h
The root node of an OpenVDB tree.
openvdb::v10_0::ValueError
Definition Exceptions.h:65
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator
Definition LeafManager.h:105
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::test
bool test() const
Return true if this iterator is not yet exhausted.
Definition LeafManager.h:130
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::operator=
Iterator & operator=(const Iterator &)=default
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::isValid
bool isValid() const
Return true if the position of this iterator is in a valid range.
Definition LeafManager.h:128
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::empty
bool empty() const
Return true if this iterator is exhausted.
Definition LeafManager.h:134
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::Iterator
Iterator(const LeafRange &range, size_t pos)
Definition LeafManager.h:107
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::operator->
LeafType * operator->() const
Return a pointer to the leaf node to which this iterator is pointing.
Definition LeafManager.h:118
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::Iterator
Iterator(const Iterator &)=default
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::operator!=
bool operator!=(const Iterator &other) const
Definition LeafManager.h:135
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::operator*
LeafType & operator*() const
Return a reference to the leaf node to which this iterator is pointing.
Definition LeafManager.h:116
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::pos
size_t pos() const
Return the index into the leaf array of the current leaf node.
Definition LeafManager.h:126
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::buffer
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:121
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::operator++
Iterator & operator++()
Advance to the next leaf node.
Definition LeafManager.h:114
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::leafRange
const LeafRange & leafRange() const
Definition LeafManager.h:140
openvdb::v10_0::tree::LeafManager::LeafRange::Iterator::operator==
bool operator==(const Iterator &other) const
Definition LeafManager.h:139
openvdb::v10_0::tree::LeafManager::LeafRange
Definition LeafManager.h:102
openvdb::v10_0::tree::LeafManager::LeafRange::LeafRange
LeafRange(size_t begin, size_t end, const LeafManager &leafManager, size_t grainSize=1)
Definition LeafManager.h:147
openvdb::v10_0::tree::LeafManager::LeafRange::begin
Iterator begin() const
Definition LeafManager.h:155
openvdb::v10_0::tree::LeafManager::LeafRange::size
size_t size() const
Definition LeafManager.h:159
openvdb::v10_0::tree::LeafManager::LeafRange::is_divisible
bool is_divisible() const
Definition LeafManager.h:167
openvdb::v10_0::tree::LeafManager::LeafRange::leafManager
const LeafManager & leafManager() const
Definition LeafManager.h:163
openvdb::v10_0::tree::LeafManager::LeafRange::end
Iterator end() const
Definition LeafManager.h:157
openvdb::v10_0::tree::LeafManager::LeafRange::empty
bool empty() const
Definition LeafManager.h:165
openvdb::v10_0::tree::LeafManager::LeafRange::LeafRange
LeafRange(LeafRange &r, tbb::split)
Definition LeafManager.h:169
openvdb::v10_0::tree::LeafManager::LeafRange::grainsize
size_t grainsize() const
Definition LeafManager.h:161
openvdb::v10_0::tree::LeafManager
This class manages a linear array of pointers to a given tree's leaf nodes, as well as optional auxil...
Definition LeafManager.h:85
openvdb::v10_0::tree::LeafManager< TopologyT >::tree
const TreeType & tree() const
Definition LeafManager.h:302
openvdb::v10_0::tree::LeafManager::getBuffer
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:330
openvdb::v10_0::tree::LeafManager::getPrefixSum
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....
Definition LeafManager.h:549
openvdb::v10_0::tree::LeafManager< TopologyT >::leaf
LeafType & leaf(size_t leafIdx) const
Definition LeafManager.h:318
openvdb::v10_0::tree::LeafManager::auxBufferCount
size_t auxBufferCount() const
Return the total number of allocated auxiliary buffers.
Definition LeafManager.h:282
openvdb::v10_0::tree::LeafManager< TopologyT >::BufferType
typename CopyConstness< TreeType, NonConstBufferType >::Type BufferType
Definition LeafManager.h:95
openvdb::v10_0::tree::LeafManager::root
RootNodeType & root()
Return a reference to the root node associated with this manager.
Definition LeafManager.h:311
openvdb::v10_0::tree::LeafManager::tree
TreeType & tree()
Return a reference to the tree associated with this manager.
Definition LeafManager.h:305
openvdb::v10_0::tree::LeafManager< TopologyT >::ValueType
typename TopologyT::ValueType ValueType
Definition LeafManager.h:88
openvdb::v10_0::tree::LeafManager< TopologyT >::LeafIterType
typename leafmgr::TreeTraits< TopologyT >::LeafIterType LeafIterType
Definition LeafManager.h:93
openvdb::v10_0::tree::LeafManager::swapLeafBuffer
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:359
openvdb::v10_0::tree::LeafManager::rebuild
void rebuild(TreeType &tree, bool serial=false)
Definition LeafManager.h:250
openvdb::v10_0::tree::LeafManager::operator()
void operator()(const RangeType &r) const
Used internally by tbb::parallel_for() - never call it directly!
Definition LeafManager.h:572
openvdb::v10_0::tree::LeafManager< TopologyT >::rebuild
void rebuild(bool serial=false)
Definition LeafManager.h:238
openvdb::v10_0::tree::LeafManager::swapBuffer
bool swapBuffer(size_t bufferIdx1, size_t bufferIdx2, bool serial=false)
Swap any two buffers for each leaf node.
Definition LeafManager.h:371
openvdb::v10_0::tree::LeafManager::getRange
RangeType getRange(size_t grainsize=1) const
Return a tbb::blocked_range of leaf array indices.
Definition LeafManager.h:342
openvdb::v10_0::tree::LeafManager::syncAuxBuffer
bool syncAuxBuffer(size_t bufferIdx, bool serial=false)
Sync up the specified auxiliary buffer with the corresponding leaf node buffer.
Definition LeafManager.h:395
openvdb::v10_0::tree::LeafManager< TopologyT >::DEPTH
static const Index DEPTH
Definition LeafManager.h:97
openvdb::v10_0::tree::LeafManager::syncAllBuffers
bool syncAllBuffers(bool serial=false)
Sync up all auxiliary buffers with their corresponding leaf node buffers.
Definition LeafManager.h:407
openvdb::v10_0::tree::LeafManager::LeafManager
LeafManager(const LeafManager &other)
Definition LeafManager.h:222
openvdb::v10_0::tree::LeafManager::reduce
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....
Definition LeafManager.h:532
openvdb::v10_0::tree::LeafManager::isConstTree
bool isConstTree() const
Return true if the tree associated with this manager is immutable.
Definition LeafManager.h:314
openvdb::v10_0::tree::LeafManager< TopologyT >::RootNodeType
typename TopologyT::RootNodeType RootNodeType
Definition LeafManager.h:89
openvdb::v10_0::tree::LeafManager::LeafManager
LeafManager(TreeType &tree, size_t auxBuffersPerLeaf=0, bool serial=false)
Constructor from a tree reference and an auxiliary buffer count.
Definition LeafManager.h:192
openvdb::v10_0::tree::LeafManager< TopologyT >::auxBuffersPerLeaf
size_t auxBuffersPerLeaf() const
Definition LeafManager.h:284
openvdb::v10_0::tree::LeafManager< TopologyT >::NonConstLeafType
typename TreeType::LeafNodeType NonConstLeafType
Definition LeafManager.h:90
openvdb::v10_0::tree::LeafManager::LeafManager
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:204
openvdb::v10_0::tree::LeafManager::rebuildLeafArray
void rebuildLeafArray(bool serial=false)
Remove the auxiliary buffers and rebuild the leaf array.
Definition LeafManager.h:275
openvdb::v10_0::tree::LeafManager::leafCount
size_t leafCount() const
Return the number of leaf nodes.
Definition LeafManager.h:287
openvdb::v10_0::tree::LeafManager::rebuild
void rebuild(TreeType &tree, size_t auxBuffersPerLeaf, bool serial=false)
Definition LeafManager.h:255
openvdb::v10_0::tree::LeafManager< TopologyT >::RangeType
tbb::blocked_range< size_t > RangeType
Definition LeafManager.h:96
openvdb::v10_0::tree::LeafManager::rebuildAuxBuffers
void rebuildAuxBuffers(size_t auxBuffersPerLeaf, bool serial=false)
Change the number of auxiliary buffers.
Definition LeafManager.h:266
openvdb::v10_0::tree::LeafManager::rebuild
void rebuild(size_t auxBuffersPerLeaf, bool serial=false)
Repopulate the leaf array and delete and reallocate auxiliary buffers.
Definition LeafManager.h:245
openvdb::v10_0::tree::LeafManager< TopologyT >::NonConstBufferType
typename LeafType::Buffer NonConstBufferType
Definition LeafManager.h:94
openvdb::v10_0::tree::LeafManager< TopologyT >::leafRange
LeafRange leafRange(size_t grainsize=1) const
Definition LeafManager.h:345
openvdb::v10_0::tree::LeafManager< TopologyT >::IsConstTree
static const bool IsConstTree
Definition LeafManager.h:99
openvdb::v10_0::tree::LeafManager< TopologyT >::TreeType
TopologyT TreeType
Definition LeafManager.h:87
openvdb::v10_0::tree::LeafManager::root
const RootNodeType & root() const
Return a const reference to root node associated with this manager.
Definition LeafManager.h:308
openvdb::v10_0::tree::LeafManager< TopologyT >::LeafType
typename CopyConstness< TreeType, NonConstLeafType >::Type LeafType
Definition LeafManager.h:91
openvdb::v10_0::tree::LeafManager::activeLeafVoxelCount
Index64 activeLeafVoxelCount() const
Return the number of active voxels in the leaf nodes.
Definition LeafManager.h:291
openvdb::v10_0::tree::LeafManager< TopologyT >::LeafNodeType
LeafType LeafNodeType
Definition LeafManager.h:92
openvdb::v10_0::tree::LeafManager::removeAuxBuffers
void removeAuxBuffers()
Remove the auxiliary buffers, but don't rebuild the leaf array.
Definition LeafManager.h:272
openvdb::v10_0::ax::run
OPENVDB_AX_API void run(const char *ax, openvdb::GridBase &grid, const AttributeBindings &bindings={})
Run a full AX pipeline (parse, compile and execute) on a single OpenVDB Grid.
openvdb::v10_0::tree::leafmgr
Definition LeafManager.h:33
openvdb::v10_0::Index
Index32 Index
Definition Types.h:54
openvdb::v10_0::Index64
uint64_t Index64
Definition Types.h:53
openvdb
Definition Exceptions.h:13
OPENVDB_THROW
#define OPENVDB_THROW(exception, message)
Definition Exceptions.h:74
Types.h
openvdb::v10_0::CopyConstness::Type
typename std::remove_const< ToType >::type Type
Definition Types.h:400
openvdb::v10_0::tree::LeafManagerImpl< LeafManager< const TreeT > >::ManagerT
LeafManager< const TreeT > ManagerT
Definition LeafManager.h:817
openvdb::v10_0::tree::LeafManagerImpl< LeafManager< const TreeT > >::LeafT
typename ManagerT::LeafType LeafT
Definition LeafManager.h:819
openvdb::v10_0::tree::LeafManagerImpl< LeafManager< const TreeT > >::RangeT
typename ManagerT::RangeType RangeT
Definition LeafManager.h:818
openvdb::v10_0::tree::LeafManagerImpl< LeafManager< const TreeT > >::BufT
typename ManagerT::BufferType BufT
Definition LeafManager.h:820
openvdb::v10_0::tree::LeafManagerImpl< LeafManager< const TreeT > >::doSwapLeafBuffer
static void doSwapLeafBuffer(const RangeT &, size_t, LeafT **, BufT *, size_t)
Definition LeafManager.h:822
openvdb::v10_0::tree::LeafManagerImpl
Definition LeafManager.h:54
openvdb::v10_0::tree::LeafManagerImpl::doSwapLeafBuffer
static void doSwapLeafBuffer(const RangeT &r, size_t auxBufferIdx, LeafT **leafs, BufT *bufs, size_t bufsPerLeaf)
Definition LeafManager.h:59
openvdb::v10_0::tree::LeafManagerImpl::LeafT
typename ManagerT::LeafType LeafT
Definition LeafManager.h:56
openvdb::v10_0::tree::LeafManagerImpl::RangeT
typename ManagerT::RangeType RangeT
Definition LeafManager.h:55
openvdb::v10_0::tree::LeafManagerImpl::BufT
typename ManagerT::BufferType BufT
Definition LeafManager.h:57
openvdb::v10_0::tree::NodeChain::Type
typename SubtreeT::template Append< HeadT > Type
Definition RootNode.h:1003
openvdb::v10_0::tree::leafmgr::TreeTraits< const TreeT >::LeafIterType
typename TreeT::LeafCIter LeafIterType
Definition LeafManager.h:43
openvdb::v10_0::tree::leafmgr::TreeTraits< const TreeT >::IsConstTree
static const bool IsConstTree
Definition LeafManager.h:42
openvdb::v10_0::tree::leafmgr::TreeTraits
Useful traits for Tree types.
Definition LeafManager.h:37
openvdb::v10_0::tree::leafmgr::TreeTraits::LeafIterType
typename TreeT::LeafIter LeafIterType
Definition LeafManager.h:39
openvdb::v10_0::tree::leafmgr::TreeTraits::IsConstTree
static const bool IsConstTree
Definition LeafManager.h:38
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition version.h.in:121
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition version.h.in:212