<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: for_each.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('a00893_source.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">for_each.h</div> </div> </div><!--header--> <div class="contents"> <a href="a00893.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (C) 2007-2018 Free Software Foundation, Inc.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// This file is part of the GNU ISO C++ Library. This library is free</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// software; you can redistribute it and/or modify it under the terms</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// of the GNU General Public License as published by the Free Software</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Foundation; either version 3, or (at your option) any later</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// version.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// This library is distributed in the hope that it will be useful, but</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// General Public License for more details.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Under Section 7 of GPL version 3, you are granted additional</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// permissions described in the GCC Runtime Library Exception, version</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 3.1, as published by the Free Software Foundation.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// You should have received a copy of the GNU General Public License and</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// a copy of the GCC Runtime Library Exception along with this program;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/** @file parallel/for_each.h</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @brief Main interface for embarrassingly parallel functions.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * The explicit implementation are in other header files, like</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * workstealing.h, par_loop.h, omp_loop.h, and omp_loop_static.h.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * This file is a GNU parallel extension to the Standard C++ Library.</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Written by Felix Putze.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifndef _GLIBCXX_PARALLEL_FOR_EACH_H</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define _GLIBCXX_PARALLEL_FOR_EACH_H 1</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include <<a class="code" href="a00959.html">parallel/settings.h</a>></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <<a class="code" href="a00929.html">parallel/par_loop.h</a>></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <<a class="code" href="a00923.html">parallel/omp_loop.h</a>></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include <<a class="code" href="a00974.html">parallel/workstealing.h</a>></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">namespace </span><a class="code" href="a01572.html">__gnu_parallel</a></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {<span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /** @brief Chose the desired algorithm by evaluating @c __parallelism_tag.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * @param __begin Begin iterator of input sequence.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @param __end End iterator of input sequence.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @param __user_op A user-specified functor (comparator, predicate,</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * associative operator,...)</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param __functionality functor to @a process an element with</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * __user_op (depends on desired functionality, e. g. accumulate,</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * for_each,...</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @param __reduction Reduction functor.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @param __reduction_start Initial value for reduction.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @param __output Output iterator.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @param __bound Maximum number of elements processed.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @param __parallelism_tag Parallelization method */</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">template</span><<span class="keyword">typename</span> _IIter, <span class="keyword">typename</span> _UserOp,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">typename</span> _Functionality, <span class="keyword">typename</span> _Red, <span class="keyword">typename</span> _Result></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  _UserOp</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="a01572.html#a0ebbe56e1b059cba72c3d706307a0e50"> 61</a></span>  <a class="code" href="a01572.html#a0ebbe56e1b059cba72c3d706307a0e50">__for_each_template_random_access</a>(_IIter __begin, _IIter __end,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  _UserOp __user_op,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  _Functionality& __functionality,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  _Red __reduction,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  _Result __reduction_start,</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  _Result& __output, <span class="keyword">typename</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::iterator_traits<_IIter>::</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  difference_type __bound,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8">_Parallelism</a> __parallelism_tag)</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">if</span> (__parallelism_tag == <a class="code" href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8ac530f35e669c50e9676af20454e1676f">parallel_unbalanced</a>)</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> <a class="code" href="a01572.html#a12c48efb47ea3e00a7ef666d595ae185">__for_each_template_random_access_ed</a></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  (__begin, __end, __user_op, __functionality, __reduction,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  __reduction_start, __output, __bound);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (__parallelism_tag == <a class="code" href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8ad1e39d5a03b2603328b50ada20730bd0">parallel_omp_loop</a>)</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> <a class="code" href="a01572.html#a6a5228179a033ede58cd143f66cdf354">__for_each_template_random_access_omp_loop</a></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  (__begin, __end, __user_op, __functionality, __reduction,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  __reduction_start, __output, __bound);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (__parallelism_tag == <a class="code" href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8aa5624cdd99806daed0060c56908fd043">parallel_omp_loop_static</a>)</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> <a class="code" href="a01572.html#a6a5228179a033ede58cd143f66cdf354">__for_each_template_random_access_omp_loop</a></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  (__begin, __end, __user_op, __functionality, __reduction,</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  __reduction_start, __output, __bound);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">else</span> <span class="comment">//e. g. parallel_balanced</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> <a class="code" href="a01572.html#a14bdca2e9c62cde7dd8478d972f60272">__for_each_template_random_access_workstealing</a></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  (__begin, __end, __user_op, __functionality, __reduction,</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  __reduction_start, __output, __bound);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif </span><span class="comment">/* _GLIBCXX_PARALLEL_FOR_EACH_H */</span><span class="preprocessor"></span></div><div class="ttc" id="a01572_html_a76f6cbf29b1b8d57762cce1ed9bd01a8aa5624cdd99806daed0060c56908fd043"><div class="ttname"><a href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8aa5624cdd99806daed0060c56908fd043">__gnu_parallel::parallel_omp_loop_static</a></div><div class="ttdoc">Parallel with OpenMP static load-balancing.</div><div class="ttdef"><b>Definition:</b> <a href="a00968_source.html#l00059">types.h:59</a></div></div> <div class="ttc" id="a00959_html"><div class="ttname"><a href="a00959.html">settings.h</a></div><div class="ttdoc">Runtime settings and tuning parameters, heuristics to decide whether to use parallelized algorithms....</div></div> <div class="ttc" id="a00923_html"><div class="ttname"><a href="a00923.html">omp_loop.h</a></div><div class="ttdoc">Parallelization of embarrassingly parallel execution by means of an OpenMP for loop....</div></div> <div class="ttc" id="a01572_html_a12c48efb47ea3e00a7ef666d595ae185"><div class="ttname"><a href="a01572.html#a12c48efb47ea3e00a7ef666d595ae185">__gnu_parallel::__for_each_template_random_access_ed</a></div><div class="ttdeci">_Op __for_each_template_random_access_ed(_RAIter __begin, _RAIter __end, _Op __o, _Fu &__f, _Red __r, _Result __base, _Result &__output, typename std::iterator_traits< _RAIter >::difference_type __bound)</div><div class="ttdoc">Embarrassingly parallel algorithm for random access iterators, using hand-crafted parallelization by ...</div><div class="ttdef"><b>Definition:</b> <a href="a00929_source.html#l00067">par_loop.h:67</a></div></div> <div class="ttc" id="a01572_html_a6a5228179a033ede58cd143f66cdf354"><div class="ttname"><a href="a01572.html#a6a5228179a033ede58cd143f66cdf354">__gnu_parallel::__for_each_template_random_access_omp_loop</a></div><div class="ttdeci">_Op __for_each_template_random_access_omp_loop(_RAIter __begin, _RAIter __end, _Op __o, _Fu &__f, _Red __r, _Result __base, _Result &__output, typename std::iterator_traits< _RAIter >::difference_type __bound)</div><div class="ttdoc">Embarrassingly parallel algorithm for random access iterators, using an OpenMP for loop.</div><div class="ttdef"><b>Definition:</b> <a href="a00923_source.html#l00067">omp_loop.h:67</a></div></div> <div class="ttc" id="a01572_html_a76f6cbf29b1b8d57762cce1ed9bd01a8ad1e39d5a03b2603328b50ada20730bd0"><div class="ttname"><a href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8ad1e39d5a03b2603328b50ada20730bd0">__gnu_parallel::parallel_omp_loop</a></div><div class="ttdoc">Parallel with OpenMP dynamic load-balancing.</div><div class="ttdef"><b>Definition:</b> <a href="a00968_source.html#l00056">types.h:56</a></div></div> <div class="ttc" id="a01572_html_a76f6cbf29b1b8d57762cce1ed9bd01a8"><div class="ttname"><a href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8">__gnu_parallel::_Parallelism</a></div><div class="ttdeci">_Parallelism</div><div class="ttdoc">Run-time equivalents for the compile-time tags.</div><div class="ttdef"><b>Definition:</b> <a href="a00968_source.html#l00044">types.h:44</a></div></div> <div class="ttc" id="a00929_html"><div class="ttname"><a href="a00929.html">par_loop.h</a></div><div class="ttdoc">Parallelization of embarrassingly parallel execution by means of equal splitting. This file is a GNU ...</div></div> <div class="ttc" id="a01572_html_a0ebbe56e1b059cba72c3d706307a0e50"><div class="ttname"><a href="a01572.html#a0ebbe56e1b059cba72c3d706307a0e50">__gnu_parallel::__for_each_template_random_access</a></div><div class="ttdeci">_UserOp __for_each_template_random_access(_IIter __begin, _IIter __end, _UserOp __user_op, _Functionality &__functionality, _Red __reduction, _Result __reduction_start, _Result &__output, typename std::iterator_traits< _IIter >::difference_type __bound, _Parallelism __parallelism_tag)</div><div class="ttdoc">Chose the desired algorithm by evaluating __parallelism_tag.</div><div class="ttdef"><b>Definition:</b> <a href="a00893_source.html#l00061">for_each.h:61</a></div></div> <div class="ttc" id="a01572_html_a76f6cbf29b1b8d57762cce1ed9bd01a8ac530f35e669c50e9676af20454e1676f"><div class="ttname"><a href="a01572.html#a76f6cbf29b1b8d57762cce1ed9bd01a8ac530f35e669c50e9676af20454e1676f">__gnu_parallel::parallel_unbalanced</a></div><div class="ttdoc">Parallel unbalanced (equal-sized chunks).</div><div class="ttdef"><b>Definition:</b> <a href="a00968_source.html#l00050">types.h:50</a></div></div> <div class="ttc" id="a01572_html_a14bdca2e9c62cde7dd8478d972f60272"><div class="ttname"><a href="a01572.html#a14bdca2e9c62cde7dd8478d972f60272">__gnu_parallel::__for_each_template_random_access_workstealing</a></div><div class="ttdeci">_Op __for_each_template_random_access_workstealing(_RAIter __begin, _RAIter __end, _Op __op, _Fu &__f, _Red __r, _Result __base, _Result &__output, typename std::iterator_traits< _RAIter >::difference_type __bound)</div><div class="ttdoc">Work stealing algorithm for random access iterators.</div><div class="ttdef"><b>Definition:</b> <a href="a00974_source.html#l00099">workstealing.h:99</a></div></div> <div class="ttc" id="a00974_html"><div class="ttname"><a href="a00974.html">workstealing.h</a></div><div class="ttdoc">Parallelization of embarrassingly parallel execution by means of work-stealing.</div></div> <div class="ttc" id="a01572_html"><div class="ttname"><a href="a01572.html">__gnu_parallel</a></div><div class="ttdoc">GNU parallel code for public use.</div><div class="ttdef"><b>Definition:</b> <a href="a00869_source.html#l00061">balanced_quicksort.h:61</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_3a83f109ff04170a1f8448445d1bdcba.html">include</a></li><li class="navelem"><a class="el" href="dir_2f1ac407c3bb97b79c0150323d069a39.html">parallel</a></li><li class="navelem"><a class="el" href="a00893.html">for_each.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>