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<head> 5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> 7<title>The MPL Reference Manual: is_sequence</title> 8<link rel="stylesheet" href="../style.css" type="text/css" /> 9</head> 10<body class="docframe refmanual"> 11<table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./insert-range.html" class="navigation-link">Prev</a> <a href="./key-type.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./insert-range.html" class="navigation-link">Back</a> <a href="./key-type.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td> 12<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="./is-sequence.html" class="navigation-link">is_sequence</a></td> 13</tr></table><div class="header-separator"></div> 14<div class="section" id="is-sequence"> 15<h1><a class="toc-backref" href="./intrinsic-metafunctions.html#id1438">is_sequence</a></h1> 16<div class="section" id="id292"> 17<h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3> 18<pre class="literal-block"> 19template< 20 typename X 21 > 22struct <a href="./is-sequence.html" class="identifier">is_sequence</a> 23{ 24 typedef <em>unspecified</em> type; 25}; 26</pre> 27</div> 28<div class="section" id="id293"> 29<h3><a class="subsection-title" href="#description" name="description">Description</a></h3> 30<p>Returns a boolean <a class="reference internal" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> such that <tt class="literal"><span class="pre">c::value</span> <span class="pre">==</span> <span class="pre">true</span></tt> if and 31only if <tt class="literal"><span class="pre">X</span></tt> is a model of <a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>.</p> 32</div> 33<div class="section" id="id294"> 34<h3><a class="subsection-title" href="#header" name="header">Header</a></h3> 35<pre class="literal-block"> 36#include <<a href="../../../../boost/mpl/is_sequence.hpp" class="header">boost/mpl/is_sequence.hpp</a>> 37</pre> 38</div> 39<div class="section" id="id295"> 40<h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3> 41<table border="1" class="docutils table"> 42<colgroup> 43<col width="19%" /> 44<col width="23%" /> 45<col width="58%" /> 46</colgroup> 47<thead valign="bottom"> 48<tr><th class="head">Parameter</th> 49<th class="head">Requirement</th> 50<th class="head">Description</th> 51</tr> 52</thead> 53<tbody valign="top"> 54<tr><td><tt class="literal"><span class="pre">X</span></tt></td> 55<td>Any type</td> 56<td>The type to query.</td> 57</tr> 58</tbody> 59</table> 60</div> 61<div class="section" id="id296"> 62<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3> 63<pre class="literal-block"> 64typedef <a href="./is-sequence.html" class="identifier">is_sequence</a><X>::type c; 65</pre> 66<table class="docutils field-list" frame="void" rules="none"> 67<col class="field-name" /> 68<col class="field-body" /> 69<tbody valign="top"> 70<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Boolean <a class="reference internal" href="./integral-constant.html">Integral Constant</a>.</p> 71</td> 72</tr> 73<tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first">Equivalent to</p> 74<pre class="last literal-block"> 75typedef <a href="./not.html" class="identifier">not_</a>< is_same< <a href="./begin.html" class="identifier">begin</a><T>::type,<a href="./void.html" class="identifier">void_</a> > >::type c; 76</pre> 77</td> 78</tr> 79</tbody> 80</table> 81</div> 82<div class="section" id="id297"> 83<h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3> 84<p>Amortized constant time.</p> 85</div> 86<div class="section" id="id298"> 87<h3><a class="subsection-title" href="#example" name="example">Example</a></h3> 88<pre class="literal-block"> 89struct UDT {}; 90 91<a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< std::<a href="./vector.html" class="identifier">vector</a><int> > )); 92<a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< int > )); 93<a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< int& > )); 94<a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< UDT > )); 95<a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< UDT* > )); 96<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< <a href="./range-c.html" class="identifier">range_c</a><int,0,0> > )); 97<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< <a href="./list.html" class="identifier">list</a><> > )); 98<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< <a href="./list.html" class="identifier">list</a><int> > )); 99<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< <a href="./vector.html" class="identifier">vector</a><> > )); 100<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( <a href="./is-sequence.html" class="identifier">is_sequence</a>< <a href="./vector.html" class="identifier">vector</a><int> > )); 101</pre> 102</div> 103<div class="section" id="id299"> 104<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3> 105<p><a class="reference internal" href="./forward-sequence.html">Forward Sequence</a>, <a class="reference internal" href="./begin.html">begin</a>, <a class="reference internal" href="./end.html">end</a>, <a class="reference internal" href="./vector.html">vector</a>, <a class="reference internal" href="./list.html">list</a>, <a class="reference internal" href="./range-c.html">range_c</a></p> 106<!-- Sequences/Intrinsic Metafunctions//key_type --> 107</div> 108</div> 109 110<div class="footer-separator"></div> 111<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./insert-range.html" class="navigation-link">Prev</a> <a href="./key-type.html" class="navigation-link">Next</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./insert-range.html" class="navigation-link">Back</a> <a href="./key-type.html" class="navigation-link">Along</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./intrinsic-metafunctions.html" class="navigation-link">Up</a> <a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator"> | </span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td> 112<td><div class="copyright-footer"><div class="copyright">Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</div> 113Distributed under the Boost Software License, Version 1.0. (See accompanying 114file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body> 115</html> 116