nodeSet.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_VDF_NODE_SET_H
#define PXR_EXEC_VDF_NODE_SET_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
#include "pxr/exec/vdf/node.h"
 
#include "pxr/base/tf/bits.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class VdfNodeSet {
public:
 
    VdfNodeSet() = default;
 
    bool IsEmpty() const {
        return _bits.GetSize() == 0 || _bits.GetNumSet() == 0;
    }
 
    size_t GetSize() const {
        return _bits.GetNumSet();
    }
 
    VDF_API
    void Clear();
 
    bool Contains(const VdfNode &node) const {
        return Contains(VdfNode::GetIndexFromId(node.GetId()));
    }
 
    bool Contains(const VdfIndex index) const {
        return index < _bits.GetSize() ? _bits.IsSet(index) : false;
    }
 
    inline void Insert(const VdfNode &node);
 
    VDF_API
    void Insert(const VdfNodeSet &rhs);
 
    VDF_API
    bool Remove(const VdfNode &node);
 
    typedef TfBits::View<TfBits::AllSet>::const_iterator iterator;
    typedef TfBits::View<TfBits::AllSet>::const_iterator const_iterator;
 
    const_iterator begin() const {
        return _bits.GetAllSetView().begin();
    }
 
    const_iterator end() const {
        return _bits.GetAllSetView().end();
    }
 
    friend void swap(VdfNodeSet &lhs, VdfNodeSet &rhs) {
        lhs._bits.Swap(rhs._bits);
    }
 
private:
 
    // Grow the underlying storage to accomodate at least the number of
    // specified indices.
    VDF_API
    void _Grow(size_t size);
 
    // The bit set representing nodes included in the set. The size of this
    // bit set denotes the capacity.
    TfBits _bits;
 
};
 
void
VdfNodeSet::Insert(const VdfNode &node)
{
    // Make sure to grow the bitset to accomodate the corresponding index of
    // the specified node.
    const VdfIndex index = VdfNode::GetIndexFromId(node.GetId());
    if (index >= _bits.GetSize()) {
        _Grow(index + 1);
    }
 
    // Set the index.
    _bits.Set(index);
}
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif