2004-11-28 03:35:12 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
2010-08-09 20:07:24 +00:00
< meta name = "generator" content = "Docutils 0.7: http://docutils.sourceforge.net/" />
2004-11-28 03:35:12 +00:00
< title > The MPL Reference Manual: BOOST_MPL_ASSERT_RELATION</ title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" />
</ head >
< body class = "docframe refmanual" >
< table class = "header" >< tr class = "header" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./assert-not.html" class = "navigation-link" > Prev</ a > < a href = "./introspection.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./assert-not.html" class = "navigation-link" > Back</ a > Along</ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./asserts.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 >
< td class = "header-group page-location" >< a href = "../refmanual.html" class = "navigation-link" > Front Page</ a > / < a href = "./macros.html" class = "navigation-link" > Macros</ a > / < a href = "./asserts.html" class = "navigation-link" > Asserts</ a > / < a href = "./assert-relation.html" class = "navigation-link" > BOOST_MPL_ASSERT_RELATION</ a ></ td >
</ tr ></ table >< div class = "header-separator" ></ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "boost-mpl-assert-relation" >
2010-08-09 20:07:24 +00:00
< h1 >< a class = "toc-backref" href = "./asserts.html#id1591" > BOOST_MPL_ASSERT_RELATION</ a ></ h1 >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1308" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#synopsis" name = "synopsis" > Synopsis</ a ></ h3 >
< pre class = "literal-block" >
#define < a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( x, relation, y ) \
< em > unspecified token sequence</ em > \
/**/
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1309" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#description" name = "description" > Description</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p > A specialized assertion macro for checking numerical conditions. Generates
a compilation error when the condition < tt class = "literal" >< span class = "pre" > (</ span > < span class = "pre" > x</ span > < span class = "pre" > relation</ span > < span class = "pre" > y</ span > < span class = "pre" > )</ span ></ tt >
2004-11-28 03:35:12 +00:00
doesn't hold.</ p >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1310" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#header" name = "header" > Header</ a ></ h3 >
< pre class = "literal-block" >
#include < < a href = "../../../../boost/mpl/assert.hpp" class = "header" > boost/mpl/assert.hpp</ a > >
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1311" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#parameters" name = "parameters" > Parameters</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< table border = "1" class = "docutils table" >
2004-11-28 03:35:12 +00:00
< colgroup >
< col width = "15%" />
< col width = "36%" />
< col width = "48%" />
</ colgroup >
< thead valign = "bottom" >
2009-08-17 11:30:52 +00:00
< tr >< th class = "head" > Parameter</ th >
< th class = "head" > Requirement</ th >
< th class = "head" > Description</ th >
2004-11-28 03:35:12 +00:00
</ tr >
</ thead >
< tbody valign = "top" >
< tr >< td >< tt class = "literal" >< span class = "pre" > x</ span ></ tt ></ td >
< td > An integral constant</ td >
< td > Left operand of the checked relation.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > y</ span ></ tt ></ td >
< td > An integral constant</ td >
< td > Right operand of the checked relation.</ td >
</ tr >
< tr >< td >< tt class = "literal" >< span class = "pre" > relation</ span ></ tt ></ td >
< td > A C++ operator token</ td >
< td > An operator token for the relation being
checked.</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1312" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics</ a ></ h3 >
< p > For any integral constants < tt class = "literal" >< span class = "pre" > x</ span ></ tt > , < tt class = "literal" >< span class = "pre" > y</ span ></ tt > and a legal C++ operator token < tt class = "literal" >< span class = "pre" > op</ span ></ tt > :</ p >
< pre class = "literal-block" >
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( x, op, y );
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< tr class = "field" >< th class = "field-name" > Return type:</ th >< td class = "field-body" >< p class = "first" > None.</ p >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
< tr class = "field" >< th class = "field-name" > Semantics:</ th >< td class = "field-body" >< p class = "first" > Generates a compilation error if < tt class = "literal" >< span class = "pre" > (</ span > < span class = "pre" > x</ span > < span class = "pre" > op</ span > < span class = "pre" > y</ span > < span class = "pre" > )</ span > < span class = "pre" > !=</ span > < span class = "pre" > true</ span ></ tt > , otherwise
has no effect.</ p >
< p > When possible within the compiler's diagnostic capabilities,
the error message will include a name of the relation being checked,
the actual values of both operands, and have a general form of:</ p >
< pre class = "last literal-block" >
< em > ...</ em > ************< em > ...</ em > assert_relation< op, x, y> ::************) < em > ...</ em >
</ pre >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1313" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#example" name = "example" > Example</ a ></ h3 >
< pre class = "literal-block" >
template< typename T, typename U > struct my
{
// ...
< a href = "./assert-relation.html" class = "identifier" > BOOST_MPL_ASSERT_RELATION</ a > ( sizeof(T), < , sizeof(U) );
};
my< char[50],char[10]> test;
// In instantiation of `my< char[50], char[10]> ':
// instantiated from here
// conversion from `
2009-08-17 11:30:52 +00:00
// mpl_::failed************mpl_::assert_relation< < a href = "./less.html" class = "identifier" > less</ a > , 50, 10> ::************'
2004-11-28 03:35:12 +00:00
// to non-scalar type `mpl_::assert< false> ' requested
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1314" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#see-also" name = "see-also" > See also</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< a class = "reference internal" href = "./asserts.html" > Asserts</ a > , < a class = "reference internal" href = "./assert.html" > BOOST_MPL_ASSERT</ a > , < a class = "reference internal" href = "./assert-not.html" > BOOST_MPL_ASSERT_NOT</ a > , < a class = "reference internal" href = "./assert-msg.html" > BOOST_MPL_ASSERT_MSG</ a ></ p >
2004-11-28 03:35:12 +00:00
</ div >
</ div >
< div class = "footer-separator" ></ div >
< table class = "footer" >< tr class = "footer" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./assert-not.html" class = "navigation-link" > Prev</ a > < a href = "./introspection.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./assert-not.html" class = "navigation-link" > Back</ a > Along</ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./asserts.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 >
2009-08-17 11:30:52 +00:00
< td >< div class = "copyright-footer" >< div class = "copyright" > Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</ div >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file 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 >
2004-11-28 03:35:12 +00:00
</ html >
