<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>libstdc++: for_each.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libstdc++</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00873.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">for_each.h</div> </div>
</div>
<div class="contents">
<a href="a00873.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- C++ -*-</span>
<a name="l00002"></a>00002
<a name="l00003"></a>00003 <span class="comment">// Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// This file is part of the GNU ISO C++ Library. This library is free</span>
<a name="l00006"></a>00006 <span class="comment">// software; you can redistribute it and/or modify it under the terms</span>
<a name="l00007"></a>00007 <span class="comment">// of the GNU General Public License as published by the Free Software</span>
<a name="l00008"></a>00008 <span class="comment">// Foundation; either version 3, or (at your option) any later</span>
<a name="l00009"></a>00009 <span class="comment">// version.</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">// This library is distributed in the hope that it will be useful, but</span>
<a name="l00012"></a>00012 <span class="comment">// WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00014"></a>00014 <span class="comment">// General Public License for more details.</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="comment">// Under Section 7 of GPL version 3, you are granted additional</span>
<a name="l00017"></a>00017 <span class="comment">// permissions described in the GCC Runtime Library Exception, version</span>
<a name="l00018"></a>00018 <span class="comment">// 3.1, as published by the Free Software Foundation.</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="comment">// You should have received a copy of the GNU General Public License and</span>
<a name="l00021"></a>00021 <span class="comment">// a copy of the GCC Runtime Library Exception along with this program;</span>
<a name="l00022"></a>00022 <span class="comment">// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see</span>
<a name="l00023"></a>00023 <span class="comment">// <http://www.gnu.org/licenses/>.</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">/** @file parallel/for_each.h</span>
<a name="l00026"></a>00026 <span class="comment"> * @brief Main interface for embarrassingly parallel functions.</span>
<a name="l00027"></a>00027 <span class="comment"> *</span>
<a name="l00028"></a>00028 <span class="comment"> * The explicit implementation are in other header files, like</span>
<a name="l00029"></a>00029 <span class="comment"> * workstealing.h, par_loop.h, omp_loop.h, and omp_loop_static.h.</span>
<a name="l00030"></a>00030 <span class="comment"> * This file is a GNU parallel extension to the Standard C++ Library.</span>
<a name="l00031"></a>00031 <span class="comment"> */</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">// Written by Felix Putze.</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _GLIBCXX_PARALLEL_FOR_EACH_H</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _GLIBCXX_PARALLEL_FOR_EACH_H 1</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <<a class="code" href="a01029.html" title="Runtime settings and tuning parameters, heuristics to decide whether to use parallelized algorithms...">parallel/settings.h</a>></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include <<a class="code" href="a00970.html" title="Parallelization of embarrassingly parallel execution by means of equal splitting. This file is a GNU ...">parallel/par_loop.h</a>></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <<a class="code" href="a00964.html" title="Parallelization of embarrassingly parallel execution by means of an OpenMP for loop. This file is a GNU parallel extension to the Standard C++ Library.">parallel/omp_loop.h</a>></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <<a class="code" href="a01122.html" title="Parallelization of embarrassingly parallel execution by means of work-stealing.">parallel/workstealing.h</a>></span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">namespace </span>__gnu_parallel
<a name="l00044"></a>00044 {<span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment"> /** @brief Chose the desired algorithm by evaluating @c __parallelism_tag.</span>
<a name="l00046"></a>00046 <span class="comment"> * @param __begin Begin iterator of input sequence.</span>
<a name="l00047"></a>00047 <span class="comment"> * @param __end End iterator of input sequence.</span>
<a name="l00048"></a>00048 <span class="comment"> * @param __user_op A user-specified functor (comparator, predicate,</span>
<a name="l00049"></a>00049 <span class="comment"> * associative operator,...)</span>
<a name="l00050"></a>00050 <span class="comment"> * @param __functionality functor to @a process an element with</span>
<a name="l00051"></a>00051 <span class="comment"> * __user_op (depends on desired functionality, e. g. accumulate,</span>
<a name="l00052"></a>00052 <span class="comment"> * for_each,...</span>
<a name="l00053"></a>00053 <span class="comment"> * @param __reduction Reduction functor.</span>
<a name="l00054"></a>00054 <span class="comment"> * @param __reduction_start Initial value for reduction.</span>
<a name="l00055"></a>00055 <span class="comment"> * @param __output Output iterator.</span>
<a name="l00056"></a>00056 <span class="comment"> * @param __bound Maximum number of elements processed.</span>
<a name="l00057"></a>00057 <span class="comment"> * @param __parallelism_tag Parallelization method */</span>
<a name="l00058"></a>00058 <span class="keyword">template</span><<span class="keyword">typename</span> _IIter, <span class="keyword">typename</span> _UserOp,
<a name="l00059"></a>00059 <span class="keyword">typename</span> _Functionality, <span class="keyword">typename</span> _Red, <span class="keyword">typename</span> _Result>
<a name="l00060"></a>00060 _UserOp
<a name="l00061"></a><a class="code" href="a01131.html#af1ed20b613a3d31d281c40b456e16a46">00061</a> <a class="code" href="a01131.html#af1ed20b613a3d31d281c40b456e16a46" title="Chose the desired algorithm by evaluating __parallelism_tag.">__for_each_template_random_access</a>(_IIter __begin, _IIter __end,
<a name="l00062"></a>00062 _UserOp __user_op,
<a name="l00063"></a>00063 _Functionality& __functionality,
<a name="l00064"></a>00064 _Red __reduction,
<a name="l00065"></a>00065 _Result __reduction_start,
<a name="l00066"></a>00066 _Result& __output, <span class="keyword">typename</span>
<a name="l00067"></a>00067 std::iterator_traits<_IIter>::
<a name="l00068"></a>00068 difference_type __bound,
<a name="l00069"></a>00069 <a class="code" href="a01131.html#a76f6cbf29b1b8d57762cce1ed9bd01a8" title="Run-time equivalents for the compile-time tags.">_Parallelism</a> __parallelism_tag)
<a name="l00070"></a>00070 {
<a name="l00071"></a>00071 <span class="keywordflow">if</span> (__parallelism_tag == <a class="code" href="a01131.html#a76f6cbf29b1b8d57762cce1ed9bd01a8ac530f35e669c50e9676af20454e1676f" title="Parallel unbalanced (equal-sized chunks).">parallel_unbalanced</a>)
<a name="l00072"></a>00072 <span class="keywordflow">return</span> <a class="code" href="a01131.html#a0453e79d37dc4bff76695e07d8a72f31" title="Embarrassingly parallel algorithm for random access iterators, using hand-crafted parallelization by ...">__for_each_template_random_access_ed</a>
<a name="l00073"></a>00073 (__begin, __end, __user_op, __functionality, __reduction,
<a name="l00074"></a>00074 __reduction_start, __output, __bound);
<a name="l00075"></a>00075 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (__parallelism_tag == <a class="code" href="a01131.html#a76f6cbf29b1b8d57762cce1ed9bd01a8ad1e39d5a03b2603328b50ada20730bd0" title="Parallel with OpenMP dynamic load-balancing.">parallel_omp_loop</a>)
<a name="l00076"></a>00076 <span class="keywordflow">return</span> <a class="code" href="a01131.html#aa667fe2f4943e82380d837c2a42238d5" title="Embarrassingly parallel algorithm for random access iterators, using an OpenMP for loop...">__for_each_template_random_access_omp_loop</a>
<a name="l00077"></a>00077 (__begin, __end, __user_op, __functionality, __reduction,
<a name="l00078"></a>00078 __reduction_start, __output, __bound);
<a name="l00079"></a>00079 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (__parallelism_tag == <a class="code" href="a01131.html#a76f6cbf29b1b8d57762cce1ed9bd01a8aa5624cdd99806daed0060c56908fd043" title="Parallel with OpenMP static load-balancing.">parallel_omp_loop_static</a>)
<a name="l00080"></a>00080 <span class="keywordflow">return</span> <a class="code" href="a01131.html#aa667fe2f4943e82380d837c2a42238d5" title="Embarrassingly parallel algorithm for random access iterators, using an OpenMP for loop...">__for_each_template_random_access_omp_loop</a>
<a name="l00081"></a>00081 (__begin, __end, __user_op, __functionality, __reduction,
<a name="l00082"></a>00082 __reduction_start, __output, __bound);
<a name="l00083"></a>00083 <span class="keywordflow">else</span> <span class="comment">//e. g. parallel_balanced</span>
<a name="l00084"></a>00084 <span class="keywordflow">return</span> <a class="code" href="a01131.html#a0723c5ff76bd65efb01e11ba74f780c7" title="Work stealing algorithm for random access iterators.">__for_each_template_random_access_workstealing</a>
<a name="l00085"></a>00085 (__begin, __end, __user_op, __functionality, __reduction,
<a name="l00086"></a>00086 __reduction_start, __output, __bound);
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="preprocessor">#endif </span><span class="comment">/* _GLIBCXX_PARALLEL_FOR_EACH_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00873.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.7.4 </li>
</ul>
</div>
</body>
</html>
