• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>at</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../../index.html" title="Chapter 1. Fusion 2.2">
8<link rel="up" href="../functions.html" title="Functions">
9<link rel="prev" href="size.html" title="size">
10<link rel="next" href="at_c.html" title="at_c">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="size.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><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="at_c.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="fusion.sequence.intrinsic.functions.at"></a><a class="link" href="at.html" title="at">at</a>
28</h5></div></div></div>
29<h6>
30<a name="fusion.sequence.intrinsic.functions.at.h0"></a>
31            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.at.description"></a></span><a class="link" href="at.html#fusion.sequence.intrinsic.functions.at.description">Description</a>
32          </h6>
33<p>
34            Returns the M-th element from the beginning of the sequence.
35          </p>
36<h6>
37<a name="fusion.sequence.intrinsic.functions.at.h1"></a>
38            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.at.synopsis"></a></span><a class="link" href="at.html#fusion.sequence.intrinsic.functions.at.synopsis">Synopsis</a>
39          </h6>
40<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">M</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
41<span class="keyword">typename</span> <a class="link" href="../metafunctions/at.html" title="at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
42<span class="identifier">at</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
43
44<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">M</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
45<span class="keyword">typename</span> <a class="link" href="../metafunctions/at.html" title="at"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">N</span><span class="special">&gt;::</span><span class="identifier">type</span>
46<span class="identifier">at</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
47</pre>
48<h6>
49<a name="fusion.sequence.intrinsic.functions.at.h2"></a>
50            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.at.parameters"></a></span><a class="link" href="at.html#fusion.sequence.intrinsic.functions.at.parameters">Parameters</a>
51          </h6>
52<div class="informaltable"><table class="table">
53<colgroup>
54<col>
55<col>
56<col>
57</colgroup>
58<thead><tr>
59<th>
60                    <p>
61                      Parameter
62                    </p>
63                  </th>
64<th>
65                    <p>
66                      Requirement
67                    </p>
68                  </th>
69<th>
70                    <p>
71                      Description
72                    </p>
73                  </th>
74</tr></thead>
75<tbody>
76<tr>
77<td>
78                    <p>
79                      <code class="computeroutput"><span class="identifier">seq</span></code>
80                    </p>
81                  </td>
82<td>
83                    <p>
84                      Model of <a class="link" href="../../concepts/random_access_sequence.html" title="Random Access Sequence">Random
85                      Access Sequence</a>
86                    </p>
87                  </td>
88<td>
89                    <p>
90                      The sequence we wish to investigate.
91                    </p>
92                  </td>
93</tr>
94<tr>
95<td>
96                    <p>
97                      <code class="computeroutput"><span class="identifier">M</span></code>
98                    </p>
99                  </td>
100<td>
101                    <p>
102                      An <a href="http://www.boost.org/libs/mpl/doc/refmanual/integral-constant.html" target="_top">MPL
103                      Integral Constant</a>
104                    </p>
105                  </td>
106<td>
107                    <p>
108                      An index from the beginning of the sequence.
109                    </p>
110                  </td>
111</tr>
112</tbody>
113</table></div>
114<h6>
115<a name="fusion.sequence.intrinsic.functions.at.h3"></a>
116            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.at.expression_semantics"></a></span><a class="link" href="at.html#fusion.sequence.intrinsic.functions.at.expression_semantics">Expression
117            Semantics</a>
118          </h6>
119<pre class="programlisting"><span class="identifier">at</span><span class="special">&lt;</span><span class="identifier">M</span><span class="special">&gt;(</span><span class="identifier">seq</span><span class="special">);</span>
120</pre>
121<p>
122            <span class="bold"><strong>Return type</strong></span>: Returns a reference to
123            the M-th element from the beginning of the sequence <code class="computeroutput"><span class="identifier">seq</span></code>
124            if <code class="computeroutput"><span class="identifier">seq</span></code> is mutable and
125            <code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
126            <span class="identifier">o</span></code>, where <code class="computeroutput"><span class="identifier">e</span></code>
127            is the M-th element from the beginning of the sequence, is a valid expression.
128            Else, returns a type convertible to the M-th element from the beginning
129            of the sequence.
130          </p>
131<p>
132            <span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><span class="number">0</span>
133            <span class="special">&lt;=</span> <span class="identifier">M</span><span class="special">::</span><span class="identifier">value</span> <span class="special">&lt;</span> <a class="link" href="size.html" title="size"><code class="computeroutput"><span class="identifier">size</span></code></a><span class="special">(</span><span class="identifier">seq</span><span class="special">)</span></code>
134            (where <code class="computeroutput"><span class="identifier">seq</span></code> is not <a class="link" href="../../concepts/unbounded_sequence.html" title="Unbounded Sequence">Unbounded Sequence</a>)
135          </p>
136<p>
137            <span class="bold"><strong>Semantics</strong></span>: Equivalent to
138          </p>
139<pre class="programlisting"><a class="link" href="../../../iterator/functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><a class="link" href="../../../iterator/functions/advance.html" title="advance"><code class="computeroutput"><span class="identifier">advance</span></code></a><span class="special">&lt;</span><span class="identifier">M</span><span class="special">&gt;(</span><a class="link" href="begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">s</span><span class="special">)))</span>
140</pre>
141<h6>
142<a name="fusion.sequence.intrinsic.functions.at.h4"></a>
143            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.at.header"></a></span><a class="link" href="at.html#fusion.sequence.intrinsic.functions.at.header">Header</a>
144          </h6>
145<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">at</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
146<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">at</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
147</pre>
148<h6>
149<a name="fusion.sequence.intrinsic.functions.at.h5"></a>
150            <span class="phrase"><a name="fusion.sequence.intrinsic.functions.at.example"></a></span><a class="link" href="at.html#fusion.sequence.intrinsic.functions.at.example">Example</a>
151          </h6>
152<pre class="programlisting"><a class="link" href="../../../container/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
153<span class="identifier">assert</span><span class="special">(</span><span class="identifier">at</span><span class="special">&lt;</span><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">int_</span><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;</span> <span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">2</span><span class="special">);</span>
154</pre>
155</div>
156<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
157<td align="left"></td>
158<td align="right"><div class="copyright-footer">Copyright © 2001-2006, 2011, 2012 Joel de Guzman,
159      Dan Marsden, Tobias Schwinger<p>
160        Distributed under the Boost Software License, Version 1.0. (See accompanying
161        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>)
162      </p>
163</div></td>
164</tr></table>
165<hr>
166<div class="spirit-nav">
167<a accesskey="p" href="size.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><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="at_c.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
168</div>
169</body>
170</html>
171