StripeScheduler.h

Go to the documentation of this file.

#pragma once
 
#include "Core/Scheduler/WorkScheduler.h"
#include "Math/math.h"
#include "Math/constant.h"
 
#include <Common/assertion.h>
 
#include <algorithm>
 
namespace ph
{
 
class StripeScheduler : public WorkScheduler
{
public:
    StripeScheduler();
 
    StripeScheduler(
        std::size_t     numWorkers, 
        const WorkUnit& totalWorkUnit);
 
    StripeScheduler(
        std::size_t     numWorkers, 
        const WorkUnit& totalWorkUnit,
        std::size_t     slicedAxis);
 
private:
    std::size_t m_slicedAxis;
    std::size_t m_numScheduled;
    std::size_t m_sideLength;
 
    void scheduleOne(WorkUnit* out_workUnit) override;
};
 
// In-header Implementations:
 
inline StripeScheduler::StripeScheduler()
 
    : WorkScheduler()
 
    , m_slicedAxis  (math::constant::X_AXIS)
    , m_numScheduled(0)
    , m_sideLength  (0)
{}
 
inline StripeScheduler::StripeScheduler(
    const std::size_t                   numWorkers,
    const WorkUnit&                     totalWorkUnit)
 
    : StripeScheduler(
        numWorkers, 
        totalWorkUnit,
        math::constant::Y_AXIS)// default to slice Y as it is likely more cache friendly
{}
 
inline StripeScheduler::StripeScheduler(
    const std::size_t numWorkers,
    const WorkUnit&   totalWorkUnit,
    const std::size_t slicedAxis)
 
    : WorkScheduler(numWorkers, totalWorkUnit)
 
    , m_slicedAxis  (slicedAxis)
    , m_numScheduled(0)
    , m_sideLength  (static_cast<std::size_t>(m_totalWorkUnit.getRegion().getExtents()[slicedAxis]))
{}
 
inline void StripeScheduler::scheduleOne(WorkUnit* const out_workUnit)
{
    PH_ASSERT(out_workUnit);
 
    if(m_numScheduled < m_numWorkers)
    {
        const auto sideRange = math::ith_evenly_divided_range(m_numScheduled, m_sideLength, m_numWorkers);
 
        Region stripRegion = m_totalWorkUnit.getRegion();
        auto [minVertex, maxVertex] = stripRegion.getVertices();
        minVertex[m_slicedAxis] += static_cast<int64>(sideRange.first);
        maxVertex[m_slicedAxis] -= static_cast<int64>(m_sideLength - sideRange.second);
        stripRegion.setVertices({minVertex, maxVertex});
 
        *out_workUnit = WorkUnit(stripRegion, m_totalWorkUnit.getDepth());
 
        ++m_numScheduled;
    }
    else
    {
        *out_workUnit = WorkUnit();
    }
}
 
}// end namespace ph