folly/gen/ParallelMap.h

   1 /*
   2  * Copyright 2014 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 #ifndef FOLLY_GEN_PARALLELMAP_H
  18 #define FOLLY_GEN_PARALLELMAP_H
  19
  20 #include <folly/gen/Core.h>
  21
  22 namespace folly { namespace gen {
  23
  24 namespace detail {
  25
  26 template<class Predicate>
  27 class PMap;
  28
  29 }  // namespace detail
  30
  31 /**
  32  * Run `pred` in parallel in nThreads. Results are returned in the
  33  * same order in which they were retrieved from the source generator
  34  * (similar to map).
  35  *
  36  * NOTE: Only `pred` is run from separate threads; the source
  37  *       generator and the rest of the pipeline is executed in the
  38  *       caller thread.
  39  */
  40 template<class Predicate,
  41          class PMap = detail::PMap<Predicate>>
  42   PMap pmap(Predicate pred = Predicate(), size_t nThreads = 0) {
  43   return PMap(std::move(pred), nThreads);
  44 }
  45
  46 }}  // namespaces
  47
  48 #include <folly/gen/ParallelMap-inl.h>
  49
  50 #endif  // FOLLY_GEN_PARALLELMAP_H