Parallel.h

Go to the documentation of this file.

/*************************************************************************
> File Name: Parallel.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Parallel functions for CubbyFlow.
> Created Time: 2017/02/05
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_PARALLEL_H
#define CUBBYFLOW_PARALLEL_H

namespace CubbyFlow
{
    enum class ExecutionPolicy { Serial, Parallel };

    template <typename RandomIterator, typename T>
    void ParallelFill(
        const RandomIterator& begin, const RandomIterator& end,
        const T& value,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template <typename IndexType, typename Function>
    void ParallelFor(
        IndexType beginIndex, IndexType endIndex,
        const Function& function,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template <typename IndexType, typename Function>
    void ParallelRangeFor(
        IndexType beginIndex, IndexType endIndex,
        const Function& function,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template <typename IndexType, typename Function>
    void ParallelFor(
        IndexType beginIndexX, IndexType endIndexX,
        IndexType beginIndexY, IndexType endIndexY,
        const Function& function,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template <typename IndexType, typename Function>
    void ParallelRangeFor(
        IndexType beginIndexX, IndexType endIndexX,
        IndexType beginIndexY, IndexType endIndexY,
        const Function& function,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template <typename IndexType, typename Function>
    void ParallelFor(
        IndexType beginIndexX, IndexType endIndexX,
        IndexType beginIndexY, IndexType endIndexY,
        IndexType beginIndexZ, IndexType endIndexZ,
        const Function& function,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template <typename IndexType, typename Function>
    void ParallelRangeFor(
        IndexType beginIndexX, IndexType endIndexX,
        IndexType beginIndexY, IndexType endIndexY,
        IndexType beginIndexZ, IndexType endIndexZ,
        const Function& function,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template <typename IndexType, typename Value, typename Function, typename Reduce>
    Value ParallelReduce(
        IndexType beginIndex, IndexType endIndex,
        const Value& identity, const Function& function,
        const Reduce& reduce,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template<typename RandomIterator>
    void ParallelSort(
        RandomIterator begin, RandomIterator end,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    template<typename RandomIterator, typename CompareFunction>
    void ParallelSort(
        RandomIterator begin, RandomIterator end,
        CompareFunction compare,
        ExecutionPolicy policy = ExecutionPolicy::Parallel);

    void SetMaxNumberOfThreads(unsigned int numThreads);

    unsigned int GetMaxNumberOfThreads();
}

#include <Core/Utils/Parallel-Impl.h>

#endif