sel_vector.h

Go to the documentation of this file.

#pragma once
 
#include <memory>
 
#include "constants.h"
#include "types.h"
#include <span>
 
namespace kuzu {
namespace common {
 
class SelectionVector {
public:
    KUZU_API static const std::array<sel_t, DEFAULT_VECTOR_CAPACITY> INCREMENTAL_SELECTED_POS;
 
    explicit SelectionVector(sel_t capacity)
        : selectedSize{0}, capacity{capacity}, selectedPositions{nullptr} {
        selectedPositionsBuffer = std::make_unique<sel_t[]>(capacity);
        setToUnfiltered();
    }
 
    SelectionVector() : SelectionVector{DEFAULT_VECTOR_CAPACITY} {}
 
    bool isUnfiltered() const { return selectedPositions == INCREMENTAL_SELECTED_POS.data(); }
    bool isContinuous() const {
        return selectedPositions >= &*INCREMENTAL_SELECTED_POS.begin() &&
               selectedPositions <= &*INCREMENTAL_SELECTED_POS.end();
    }
 
    void setToUnfiltered() {
        selectedPositions = const_cast<sel_t*>(INCREMENTAL_SELECTED_POS.data());
    }
    void setToUnfiltered(sel_t size) {
        KU_ASSERT(size <= capacity);
        selectedPositions = const_cast<sel_t*>(INCREMENTAL_SELECTED_POS.data());
        selectedSize = size;
    }
 
    // Set to filtered is not very accurate. It sets selectedPositions to a mutable array.
    void setToFiltered() { selectedPositions = selectedPositionsBuffer.get(); }
    void setToFiltered(sel_t size) {
        KU_ASSERT(size <= capacity && selectedPositionsBuffer);
        selectedPositions = selectedPositionsBuffer.get();
        selectedSize = size;
    }
 
    std::span<sel_t> getMutableBuffer() const {
        return std::span<sel_t>(selectedPositionsBuffer.get(), capacity);
    }
    std::span<const sel_t> getSelectedPositions() const {
        return std::span<const sel_t>(selectedPositions, selectedSize);
    }
 
    template<class Func>
    void forEach(Func&& func) const {
        if (isContinuous()) {
            const auto start = selectedPositions[0];
            for (size_t i = start; i < start + selectedSize; i++) {
                func(i);
            }
        } else {
            for (size_t i = 0; i < selectedSize; i++) {
                func(selectedPositions[i]);
            }
        }
    }
 
    sel_t getSelSize() const { return selectedSize; }
    void setSelSize(sel_t size) {
        KU_ASSERT(size <= capacity);
        selectedSize = size;
    }
    void incrementSelSize(sel_t increment = 1) {
        KU_ASSERT(selectedSize < capacity);
        selectedSize += increment;
    }
 
    sel_t operator[](sel_t index) const {
        KU_ASSERT(index < capacity);
        return selectedPositions[index];
    }
    sel_t& operator[](sel_t index) {
        KU_ASSERT(index < capacity);
        return selectedPositions[index];
    }
 
private:
    sel_t selectedSize;
    sel_t capacity;
    std::unique_ptr<sel_t[]> selectedPositionsBuffer;
    sel_t* selectedPositions;
};
 
} // namespace common
} // namespace kuzu