• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Struct begin</title>
6<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../../proto/reference.html#header.boost.proto.functional.range.begin_hpp" title="Header &lt;boost/proto/functional/range/begin.hpp&gt;">
10<link rel="prev" href="reverse/resu_1_3_33_5_18_2_1_1_1_5.html" title="Struct template result&lt;This(Seq &amp;)&gt;">
11<link rel="next" href="begin/resu_1_3_33_5_19_2_1_1_1_4.html" title="Struct template result&lt;This(Range)&gt;">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
16<td align="center"><a href="../../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="reverse/resu_1_3_33_5_18_2_1_1_1_5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.functional.range.begin_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="begin/resu_1_3_33_5_19_2_1_1_1_4.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.proto.functional.begin"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Struct begin</span></h2>
30<p>boost::proto::functional::begin — A <a class="link" href="../../../PolymorphicFunctionObject.html" title="Concept PolymorphicFunctionObject">PolymorphicFunctionObject</a> type that invokes the
31            <code class="computeroutput">boost::begin()</code> accessor function on its arguments.</p>
32</div>
33<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
34<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../proto/reference.html#header.boost.proto.functional.range.begin_hpp" title="Header &lt;boost/proto/functional/range/begin.hpp&gt;">boost/proto/functional/range/begin.hpp</a>&gt;
35
36</span>
37<span class="keyword">struct</span> <a class="link" href="begin.html" title="Struct begin">begin</a> <span class="special">:</span> <span class="keyword"></span> <a class="link" href="../callable.html" title="Struct callable">proto::callable</a> <span class="special">{</span>
38  <span class="comment">// member classes/structs/unions</span>
39  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> This<span class="special">,</span> <span class="keyword">typename</span> Range<span class="special">&gt;</span>
40  <span class="keyword">struct</span> <a class="link" href="begin/resu_1_3_33_5_19_2_1_1_1_4.html" title="Struct template result&lt;This(Range)&gt;">result</a><span class="special">&lt;</span><span class="identifier">This</span><span class="special">(</span><span class="identifier">Range</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">:</span> <span class="keyword"></span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special">&lt;</span>
41      <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">remove_reference</span><span class="special">&lt;</span><span class="identifier">Range</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
42  <span class="special">&gt;</span>
43  <span class="special">{</span>
44  <span class="special">}</span><span class="special">;</span>
45
46  <span class="comment">// <a class="link" href="begin.html#id-1_3_33_5_19_2_1_1_1_5-bb">public member functions</a></span>
47  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Range<span class="special">&gt;</span>
48    <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="begin.html#id-1_3_33_5_19_2_1_1_1_5_1-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Range</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
49  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Range<span class="special">&gt;</span>
50    <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
51    <a class="link" href="begin.html#id-1_3_33_5_19_2_1_1_1_5_2-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
52<span class="special">}</span><span class="special">;</span></pre></div>
53<div class="refsect1">
54<a name="id-1.3.33.5.21.4.4"></a><h2>Description</h2>
55<p>
56              A <a class="link" href="../../../PolymorphicFunctionObject.html" title="Concept PolymorphicFunctionObject">PolymorphicFunctionObject</a> type that invokes the
57              <code class="computeroutput">boost::begin()</code> accessor function on its arguments.</p>
58<div class="refsect2">
59<a name="id-1.3.33.5.21.4.4.3"></a><h3>
60<a name="id-1_3_33_5_19_2_1_1_1_5-bb"></a><code class="computeroutput">begin</code> public member functions</h3>
61<div class="orderedlist"><ol class="orderedlist" type="1">
62<li class="listitem">
63<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Range<span class="special">&gt;</span>
64  <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="id-1_3_33_5_19_2_1_1_1_5_1-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Range</span> <span class="special">&amp;</span> rng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
65<div class="variablelist"><table border="0" class="variablelist compact">
66<colgroup>
67<col align="left" valign="top">
68<col>
69</colgroup>
70<tbody><tr>
71<td><p><span class="term">Returns:</span></p></td>
72<td><p><code class="computeroutput">boost::begin(rng)</code></p></td>
73</tr></tbody>
74</table></div>
75</li>
76<li class="listitem">
77<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Range<span class="special">&gt;</span>
78  <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
79  <a name="id-1_3_33_5_19_2_1_1_1_5_2-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&amp;</span> rng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
80<div class="variablelist"><table border="0" class="variablelist compact">
81<colgroup>
82<col align="left" valign="top">
83<col>
84</colgroup>
85<tbody><tr>
86<td><p><span class="term">Returns:</span></p></td>
87<td><p><code class="computeroutput">boost::begin(rng)</code></p></td>
88</tr></tbody>
89</table></div>
90</li>
91</ol></div>
92</div>
93</div>
94</div>
95<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
96<td align="left"></td>
97<td align="right"><div class="copyright-footer">Copyright © 2008 Eric Niebler<p>
98        Distributed under the Boost Software License, Version 1.0. (See accompanying
99        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
100      </p>
101</div></td>
102</tr></table>
103<hr>
104<div class="spirit-nav">
105<a accesskey="p" href="reverse/resu_1_3_33_5_18_2_1_1_1_5.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../proto/reference.html#header.boost.proto.functional.range.begin_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="begin/resu_1_3_33_5_19_2_1_1_1_4.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
106</div>
107</body>
108</html>
109