Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/mpl/doc/refmanual/order.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 8.0 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- Copyright Aleksey Gurtovoy 2006. Distributed under the Boost -->
5<!-- Software License, Version 1.0. (See accompanying -->
6<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
7<head>
8<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9<meta name="generator" content="Docutils 0.3.6: http://docutils.sourceforge.net/" />
10<title>The MPL Reference Manual: order</title>
11<link rel="stylesheet" href="../style.css" type="text/css" />
12</head>
13<body class="docframe refmanual">
14<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./key-type.html" class="navigation-link">Prev</a>&nbsp;<a href="./pop-back.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./key-type.html" class="navigation-link">Back</a>&nbsp;<a href="./pop-back.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
15<td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./sequences.html" class="navigation-link">Sequences</a> / <a href="./intrinsic-metafunctions.html" class="navigation-link">Intrinsic Metafunctions</a> / <a href="./order.html" class="navigation-link">order</a></td>
16</tr></table><div class="header-separator"></div>
17<div class="section" id="order">
18<h1><a class="toc-backref" href="./intrinsic-metafunctions.html#id368" name="order">order</a></h1>
19<div class="section" id="order-synopsis">
20<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
21<pre class="literal-block">
22template&lt;
23      typename Sequence
24    , typename Key
25    &gt;
26struct <a href="./order.html" class="identifier">order</a>
27{
28    typedef <em>unspecified</em> type;
29};
30</pre>
31</div>
32<div class="section" id="order-description">
33<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
34<p>Returns a unique unsigned <a class="reference" href="./integral-constant.html">Integral Constant</a> associated with the key <tt class="literal"><span class="pre">Key</span></tt> in
35<tt class="literal"><span class="pre">Sequence</span></tt>.</p>
36</div>
37<div class="section" id="order-header">
38<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
39<pre class="literal-block">
40#include &lt;<a href="../../../../boost/mpl/order.hpp" class="header">boost/mpl/order.hpp</a>&gt;
41</pre>
42</div>
43<div class="section" id="order-model-of">
44<h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
45<p><a class="reference" href="./tag-dispatched.html">Tag Dispatched Metafunction</a></p>
46</div>
47<div class="section" id="order-parameters">
48<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
49<table border="1" class="table">
50<colgroup>
51<col width="17%" />
52<col width="30%" />
53<col width="53%" />
54</colgroup>
55<thead valign="bottom">
56<tr><th>Parameter</th>
57<th>Requirement</th>
58<th>Description</th>
59</tr>
60</thead>
61<tbody valign="top">
62<tr><td><tt class="literal"><span class="pre">Sequence</span></tt></td>
63<td><a class="reference" href="./associative-sequence.html">Associative Sequence</a></td>
64<td>A sequence to query.</td>
65</tr>
66<tr><td><tt class="literal"><span class="pre">Key</span></tt></td>
67<td>Any type</td>
68<td>The queried key.</td>
69</tr>
70</tbody>
71</table>
72</div>
73<div class="section" id="order-expression-semantics">
74<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
75<p>For any <a class="reference" href="./associative-sequence.html">Associative Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, and arbitrary type <tt class="literal"><span class="pre">key</span></tt>:</p>
76<pre class="literal-block">
77typedef <a href="./order.html" class="identifier">order</a>&lt;s,key&gt;::type n;
78</pre>
79<table class="field-list" frame="void" rules="none">
80<col class="field-name" />
81<col class="field-body" />
82<tbody valign="top">
83<tr class="field"><th class="field-name">Return type:</th><td class="field-body">Unsigned <a class="reference" href="./integral-constant.html">Integral Constant</a>.</td>
84</tr>
85<tr class="field"><th class="field-name">Semantics:</th><td class="field-body">If <tt class="literal"><span class="pre"><a href="./has-key.html" class="identifier">has_key</a>&lt;s,key&gt;::value</span> <span class="pre">==</span> <span class="pre">true</span></tt>, <tt class="literal"><span class="pre">n</span></tt> is a unique unsigned
86<a class="reference" href="./integral-constant.html">Integral Constant</a> associated with <tt class="literal"><span class="pre">key</span></tt> in <tt class="literal"><span class="pre">s</span></tt>; otherwise,
87<tt class="literal"><span class="pre">n</span></tt> is identical to <tt class="literal"><span class="pre"><a href="./void.html" class="identifier">void_</a></span></tt>.</td>
88</tr>
89</tbody>
90</table>
91</div>
92<div class="section" id="order-complexity">
93<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
94<p>Amortized constant time.</p>
95</div>
96<div class="section" id="order-example">
97<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
98<pre class="literal-block">
99typedef <a href="./map.html" class="identifier">map</a>&lt; <a href="./pair.html" class="identifier">pair</a>&lt;int,unsigned&gt;, <a href="./pair.html" class="identifier">pair</a>&lt;char,long&gt; &gt; m;
100
101<a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( is_same&lt; <a href="./order.html" class="identifier">order</a>&lt;m,int&gt;::type, <a href="./void.html" class="identifier">void_</a> &gt; ));
102<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./order.html" class="identifier">order</a>&lt;m,long&gt;::type,<a href="./void.html" class="identifier">void_</a> > ));
103</pre>
104</div>
105<div class="section" id="order-see-also">
106<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
107<p><a class="reference" href="./associative-sequence.html">Associative Sequence</a>, <a class="refentry reference" href="./has-key.html"><tt class="refentry literal"><span class="pre">has_key</span></tt></a>, <a class="refentry reference" href="./count.html"><tt class="refentry literal"><span class="pre">count</span></tt></a>, <a class="refentry reference" href="./map.html"><tt class="refentry literal"><span class="pre">map</span></tt></a></p>
108<!-- modtime: November 13, 2004 01:30:27 +0000 -->
109<!-- Sequences/Intrinsic Metafunctions//pop_back -->
110</div>
111</div>
112
113<div class="footer-separator"></div>
114<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./key-type.html" class="navigation-link">Prev</a>&nbsp;<a href="./pop-back.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./key-type.html" class="navigation-link">Back</a>&nbsp;<a href="./pop-back.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
115</tr></table></body>
116</html>
Note: See TracBrowser for help on using the repository browser.