libs/hana/doc/html/assert_8hpp.html

   1 <!--
   2 Copyright Louis Dionne 2013-2017
   3 Distributed under the Boost Software License, Version 1.0.
   4 (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
   5 -->
   6 <!-- boost-no-inspect -->
   7 <!-- HTML header for doxygen 1.8.9.1-->
   8 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   9 <html xmlns="http://www.w3.org/1999/xhtml">
  10 <head>
  11 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  12 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  13 <meta name="generator" content="Doxygen 1.8.11"/>
  14 <title>Boost.Hana: boost/hana/assert.hpp File Reference</title>
  15 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="jquery.js"></script>
  17 <script type="text/javascript" src="dynsections.js"></script>
  18 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  19 <script type="text/javascript" src="resize.js"></script>
  20 <script type="text/javascript" src="navtreedata.js"></script>
  21 <script type="text/javascript" src="navtree.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(initResizable);
  24   $(window).load(resizeHeight);
  25 </script>
  26 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  27 <script type="text/javascript" src="search/searchdata.js"></script>
  28 <script type="text/javascript" src="search/search.js"></script>
  29 <script type="text/javascript">
  30   $(document).ready(function() { init_search(); });
  31 </script>
  32 <script type="text/x-mathjax-config">
  33   MathJax.Hub.Config({
  34     extensions: ["tex2jax.js"],
  35     jax: ["input/TeX","output/HTML-CSS"],
  36 });
  37 // Copyright Louis Dionne 2013-2017
  38 // Distributed under the Boost Software License, Version 1.0.
  39 // (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
  40 MathJax.Hub.Config({
  41     "HTML-CSS": {
  42         linebreaks: {
  43             automatic: true,
  44             width: "75% container"
  45         }
  46     }
  47 });
  48 </script><script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  49 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  50 <!-- Additional javascript for drawing charts. -->
  51 <script type="text/javascript" src="highcharts.js"></script>
  52 <script type="text/javascript" src="highcharts-data.js"></script>
  53 <script type="text/javascript" src="highcharts-exporting.js"></script>
  54 <script type="text/javascript" src="chart.js"></script>
  55 <script type="text/javascript" src="hana.js"></script>
  56 </head>
  57 <body>
  58 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  59 <div id="titlearea">
  60 <table cellspacing="0" cellpadding="0">
  61  <tbody>
  62  <tr style="height: 56px;">
  63   <td id="projectlogo"><img alt="Logo" src="Boost.png"/></td>
  64   <td style="padding-left: 0.5em;">
  65    <div id="projectname">Boost.Hana
  66    &#160;<span id="projectnumber">1.1.0</span>
  67    </div>
  68    <div id="projectbrief">Your standard library for metaprogramming</div>
  69   </td>
  70    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  71         <span class="left">
  72           <img id="MSearchSelect" src="search/mag_sel.png"
  73                onmouseover="return searchBox.OnSearchSelectShow()"
  74                onmouseout="return searchBox.OnSearchSelectHide()"
  75                alt=""/>
  76           <input type="text" id="MSearchField" value="Search" accesskey="S"
  77                onfocus="searchBox.OnSearchFieldFocus(true)"
  78                onblur="searchBox.OnSearchFieldFocus(false)"
  79                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  80           </span><span class="right">
  81             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  82           </span>
  83         </div>
  84 </td>
  85  </tr>
  86  </tbody>
  87 </table>
  88 </div>
  89 <!-- end header part -->
  90 <!-- Generated by Doxygen 1.8.11 -->
  91 <script type="text/javascript">
  92 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  93 </script>
  94 </div><!-- top -->
  95 <div id="side-nav" class="ui-resizable side-nav-resizable">
  96   <div id="nav-tree">
  97     <div id="nav-tree-contents">
  98       <div id="nav-sync" class="sync"></div>
  99     </div>
 100   </div>
 101   <div id="splitbar" style="-moz-user-select:none;"
 102        class="ui-resizable-handle">
 103   </div>
 104 </div>
 105 <script type="text/javascript">
 106 $(document).ready(function(){initNavTree('assert_8hpp.html','');});
 107 </script>
 108 <div id="doc-content">
 109 <!-- window showing the filter options -->
 110 <div id="MSearchSelectWindow"
 111      onmouseover="return searchBox.OnSearchSelectShow()"
 112      onmouseout="return searchBox.OnSearchSelectHide()"
 113      onkeydown="return searchBox.OnSearchSelectKey(event)">
 114 </div>
 115
 116 <!-- iframe showing the search results (closed by default) -->
 117 <div id="MSearchResultsWindow">
 118 <iframe src="javascript:void(0)" frameborder="0"
 119         name="MSearchResults" id="MSearchResults">
 120 </iframe>
 121 </div>
 122
 123 <div class="header">
 124   <div class="summary">
 125 <a href="#define-members">Macros</a>  </div>
 126   <div class="headertitle">
 127 <div class="title">assert.hpp File Reference</div>  </div>
 128 </div><!--header-->
 129 <div class="contents">
 130
 131 <p>Defines macros to perform different kinds of assertions.
 132 <a href="#details">More...</a></p>
 133 <table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 135 Macros</h2></td></tr>
 136 <tr class="memitem:gae4eb14a3b31e44f433b080d9bc2d14fd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#gae4eb14a3b31e44f433b080d9bc2d14fd">BOOST_HANA_RUNTIME_ASSERT</a>(condition)&#160;&#160;&#160;unspecified</td></tr>
 137 <tr class="memdesc:gae4eb14a3b31e44f433b080d9bc2d14fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expands to a runtime assertion.  <a href="group__group-assertions.html#gae4eb14a3b31e44f433b080d9bc2d14fd">More...</a><br /></td></tr>
 138 <tr class="separator:gae4eb14a3b31e44f433b080d9bc2d14fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:ga2e25bbdeefb0e5fbf45ffa9227ddb8d2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga2e25bbdeefb0e5fbf45ffa9227ddb8d2">BOOST_HANA_RUNTIME_ASSERT_MSG</a>(condition,  message)&#160;&#160;&#160;unspecified</td></tr>
 140 <tr class="memdesc:ga2e25bbdeefb0e5fbf45ffa9227ddb8d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_RUNTIME_ASSERT</code>, but allows providing a custom failure message.  <a href="group__group-assertions.html#ga2e25bbdeefb0e5fbf45ffa9227ddb8d2">More...</a><br /></td></tr>
 141 <tr class="separator:ga2e25bbdeefb0e5fbf45ffa9227ddb8d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:ga2626fa0c92b308cee62ac423ae2dba41"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga2626fa0c92b308cee62ac423ae2dba41">BOOST_HANA_CONSTANT_ASSERT</a>(condition)&#160;&#160;&#160;unspecified</td></tr>
 143 <tr class="memdesc:ga2626fa0c92b308cee62ac423ae2dba41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time assertion for <code>Constant</code>s.  <a href="group__group-assertions.html#ga2626fa0c92b308cee62ac423ae2dba41">More...</a><br /></td></tr>
 144 <tr class="separator:ga2626fa0c92b308cee62ac423ae2dba41"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:ga9961218055c571b279bb6e07befbba4d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga9961218055c571b279bb6e07befbba4d">BOOST_HANA_CONSTANT_ASSERT_MSG</a>(condition,  message)&#160;&#160;&#160;unspecified</td></tr>
 146 <tr class="memdesc:ga9961218055c571b279bb6e07befbba4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_CONSTANT_ASSERT</code>, but allows providing a custom failure message.  <a href="group__group-assertions.html#ga9961218055c571b279bb6e07befbba4d">More...</a><br /></td></tr>
 147 <tr class="separator:ga9961218055c571b279bb6e07befbba4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:ga90c1df2cb8eb67e8e0c822eac180b7bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga90c1df2cb8eb67e8e0c822eac180b7bc">BOOST_HANA_ASSERT</a>(condition)&#160;&#160;&#160;unspecified</td></tr>
 149 <tr class="memdesc:ga90c1df2cb8eb67e8e0c822eac180b7bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expands to the strongest form of assertion possible for the given condition.  <a href="group__group-assertions.html#ga90c1df2cb8eb67e8e0c822eac180b7bc">More...</a><br /></td></tr>
 150 <tr class="separator:ga90c1df2cb8eb67e8e0c822eac180b7bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:gaa7690973ea7b2ba5b6a72a6293fce873"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#gaa7690973ea7b2ba5b6a72a6293fce873">BOOST_HANA_ASSERT_MSG</a>(condition,  message)&#160;&#160;&#160;unspecified</td></tr>
 152 <tr class="memdesc:gaa7690973ea7b2ba5b6a72a6293fce873"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_ASSERT</code>, but allows providing a custom failure message.  <a href="group__group-assertions.html#gaa7690973ea7b2ba5b6a72a6293fce873">More...</a><br /></td></tr>
 153 <tr class="separator:gaa7690973ea7b2ba5b6a72a6293fce873"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:ga046d7ee458de8da63812fe2f059c0a4d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga046d7ee458de8da63812fe2f059c0a4d">BOOST_HANA_CONSTEXPR_ASSERT</a>(condition)&#160;&#160;&#160;unspecified</td></tr>
 155 <tr class="memdesc:ga046d7ee458de8da63812fe2f059c0a4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expands to a static assertion or a runtime assertion, depending on whether <code>constexpr</code> lambdas are supported.  <a href="group__group-assertions.html#ga046d7ee458de8da63812fe2f059c0a4d">More...</a><br /></td></tr>
 156 <tr class="separator:ga046d7ee458de8da63812fe2f059c0a4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:ga0a1327b758604bf330efeba450dd4a95"><td class="memItemLeft" align="right" valign="top">
 158 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga0a1327b758604bf330efeba450dd4a95">BOOST_HANA_CONSTEXPR_ASSERT_MSG</a>(condition,  message)&#160;&#160;&#160;unspecified</td></tr>
 159 <tr class="memdesc:ga0a1327b758604bf330efeba450dd4a95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_CONSTEXPR_ASSERT</code>, but allows providing a custom failure message. <br /></td></tr>
 160 <tr class="separator:ga0a1327b758604bf330efeba450dd4a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:ga1cd7a2be93e2bf4e9a18c7043276373e"><td class="memItemLeft" align="right" valign="top">
 162 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga1cd7a2be93e2bf4e9a18c7043276373e">BOOST_HANA_RUNTIME_CHECK_MSG</a>(condition,  message)                              </td></tr>
 163 <tr class="memdesc:ga1cd7a2be93e2bf4e9a18c7043276373e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_RUNTIME_ASSERT_MSG</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 164 <tr class="separator:ga1cd7a2be93e2bf4e9a18c7043276373e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:ga29b2b21ffa5513e5b706c50ffee980af"><td class="memItemLeft" align="right" valign="top">
 166 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga29b2b21ffa5513e5b706c50ffee980af">BOOST_HANA_RUNTIME_CHECK</a>(...)                                                                    </td></tr>
 167 <tr class="memdesc:ga29b2b21ffa5513e5b706c50ffee980af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_RUNTIME_ASSERT</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 168 <tr class="separator:ga29b2b21ffa5513e5b706c50ffee980af"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <tr class="memitem:ga41a7490fd94005e6b6a3b6a900207063"><td class="memItemLeft" align="right" valign="top">
 170 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga41a7490fd94005e6b6a3b6a900207063">BOOST_HANA_CONSTANT_CHECK_MSG</a>(condition,  message)                            </td></tr>
 171 <tr class="memdesc:ga41a7490fd94005e6b6a3b6a900207063"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_CONSTANT_ASSERT_MSG</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 172 <tr class="separator:ga41a7490fd94005e6b6a3b6a900207063"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:ga4bf9e0c46c44e21fbe5c5fbb3ace8356"><td class="memItemLeft" align="right" valign="top">
 174 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga4bf9e0c46c44e21fbe5c5fbb3ace8356">BOOST_HANA_CONSTANT_CHECK</a>(...)                                                                  </td></tr>
 175 <tr class="memdesc:ga4bf9e0c46c44e21fbe5c5fbb3ace8356"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_CONSTANT_ASSERT</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 176 <tr class="separator:ga4bf9e0c46c44e21fbe5c5fbb3ace8356"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:ga7af67ae500a237fe350f1bfceb4a5afa"><td class="memItemLeft" align="right" valign="top">
 178 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga7af67ae500a237fe350f1bfceb4a5afa">BOOST_HANA_CHECK_MSG</a>(condition,  message)                                              </td></tr>
 179 <tr class="memdesc:ga7af67ae500a237fe350f1bfceb4a5afa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_ASSERT_MSG</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 180 <tr class="separator:ga7af67ae500a237fe350f1bfceb4a5afa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:ga512de1fcd31e8a34931ffb2c891afd36"><td class="memItemLeft" align="right" valign="top">
 182 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga512de1fcd31e8a34931ffb2c891afd36">BOOST_HANA_CHECK</a>(...)                                                                                    </td></tr>
 183 <tr class="memdesc:ga512de1fcd31e8a34931ffb2c891afd36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA__ASSERT</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 184 <tr class="separator:ga512de1fcd31e8a34931ffb2c891afd36"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 <tr class="memitem:gaa76ba567944adfec0dce60cc20be35bc"><td class="memItemLeft" align="right" valign="top">
 186 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#gaa76ba567944adfec0dce60cc20be35bc">BOOST_HANA_CONSTEXPR_CHECK_MSG</a>(condition,  message)                          &#160;&#160;&#160;<a class="el" href="group__group-assertions.html#ga1cd7a2be93e2bf4e9a18c7043276373e">BOOST_HANA_RUNTIME_CHECK_MSG</a>(condition, message)                    \</td></tr>
 187 <tr class="memdesc:gaa76ba567944adfec0dce60cc20be35bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_CONSTEXPR_ASSERT_MSG</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 188 <tr class="separator:gaa76ba567944adfec0dce60cc20be35bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:ga5150cd7df438a22056a39529d21562d2"><td class="memItemLeft" align="right" valign="top">
 190 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-assertions.html#ga5150cd7df438a22056a39529d21562d2">BOOST_HANA_CONSTEXPR_CHECK</a>(...)                                                                </td></tr>
 191 <tr class="memdesc:ga5150cd7df438a22056a39529d21562d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to <code>BOOST_HANA_CONSTEXPR_ASSERT</code>, but not influenced by the <code>BOOST_HANA_CONFIG_DISABLE_ASSERTIONS</code> config macro. For internal use only. <br /></td></tr>
 192 <tr class="separator:ga5150cd7df438a22056a39529d21562d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 193 </table>
 194 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 195 <div class="textblock"><p>Defines macros to perform different kinds of assertions. </p>
 196 <dl class="section copyright"><dt>Copyright</dt><dd>Louis Dionne 2013-2017 Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE.md or copy at <a href="http://boost.org/LICENSE_1_0.txt">http://boost.org/LICENSE_1_0.txt</a>) </dd></dl>
 197 </div></div><!-- contents -->
 198 </div><!-- doc-content -->
 199 <!--
 200 Copyright Louis Dionne 2013-2017
 201 Distributed under the Boost Software License, Version 1.0.
 202 (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
 203 -->
 204 <!-- boost-no-inspect -->
 205 <!-- HTML footer for doxygen 1.8.9.1-->
 206 <!-- start footer part -->
 207 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 208   <ul>
 209     <li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_daf74c896eae580804ddb7810f485dad.html">hana</a></li><li class="navelem"><a class="el" href="assert_8hpp.html">assert.hpp</a></li>
 210   </ul>
 211 </div>
 212 </body>
 213 </html>