folly/gen/ParallelMap.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18 #define FOLLY_GEN_PARALLELMAP_H_
  19
  20 #include <folly/gen/Core.h>
  21
  22 namespace folly {
  23 namespace gen {
  24
  25 namespace detail {
  26
  27 template<class Predicate>
  28 class PMap;
  29
  30 } // namespace detail
  31
  32 /**
  33  * Run `pred` in parallel in nThreads. Results are returned in the
  34  * same order in which they were retrieved from the source generator
  35  * (similar to map).
  36  *
  37  * NOTE: Only `pred` is run from separate threads; the source
  38  *       generator and the rest of the pipeline is executed in the
  39  *       caller thread.
  40  */
  41 template<class Predicate,
  42          class PMap = detail::PMap<Predicate>>
  43   PMap pmap(Predicate pred = Predicate(), size_t nThreads = 0) {
  44   return PMap(std::move(pred), nThreads);
  45 }
  46 } // namespace gen
  47 } // namespace folly
  48
  49 #include <folly/gen/ParallelMap-inl.h>