libs/vmd/doc/html/BOOST_VMD_EQUAL.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_VMD_EQUAL</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&#160;1.&#160;The Variadic Macro Data Library 1.9">
   8 <link rel="up" href="header/boost/vmd/equal_hpp.html" title="Header &lt;boost/vmd/equal.hpp&gt;">
   9 <link rel="prev" href="header/boost/vmd/equal_hpp.html" title="Header &lt;boost/vmd/equal.hpp&gt;">
  10 <link rel="next" href="BOOST_VMD_EQUAL_D.html" title="Macro BOOST_VMD_EQUAL_D">
  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="header/boost/vmd/equal_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/equal_hpp.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="BOOST_VMD_EQUAL_D.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_VMD_EQUAL"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_VMD_EQUAL</span></h2>
  29 <p>BOOST_VMD_EQUAL &#8212; Tests any two sequences for equality. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="header/boost/vmd/equal_hpp.html" title="Header &lt;boost/vmd/equal.hpp&gt;">boost/vmd/equal.hpp</a>&gt;
  33
  34 </span>BOOST_VMD_EQUAL(sequence, ...)</pre></div>
  35 <div class="refsect1">
  36 <a name="idm45529680872992"></a><h2>Description</h2>
  37 <p>sequence = First sequence. ... = variadic parameters, maximum of 2.</p>
  38 <p>The first variadic parameter is required and is the second sequence to test. The optional second variadic parameter is a VMD type as a filter.</p>
  39 <p>The macro tests any two sequences for equality. For sequences to be equal the VMD types of each sequence must be equal and the individual elements of the sequence must be equal. For Boost PP composite types the macro tests that the composite types have the same size and then tests that each element of the composite type is equal. This means that all elements of a composite type must be a VMD type in order to use this macro successfully.</p>
  40 <p>The single optional parameter is a filter. The filter is a VMD type which specifies that both sequences to test must be of that VMD type, as well as being equal to each other, for the test to succeed.</p>
  41 <p>returns = 1 upon success or 0 upon failure. Success means that both sequences are equal and, if the optional parameter is specified, that the sequences are of the optional VMD type. </p>
  42 </div>
  43 </div>
  44 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  45 <td align="left"></td>
  46 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2017 Tropic Software
  47       East Inc</div></td>
  48 </tr></table>
  49 <hr>
  50 <div class="spirit-nav">
  51 <a accesskey="p" href="header/boost/vmd/equal_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/equal_hpp.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="BOOST_VMD_EQUAL_D.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  52 </div>
  53 </body>
  54 </html>