1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function template condition_if_c</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 1. Boost.Contract 1.0.0"> 8<link rel="up" href="../../reference.html#header.boost.contract.call_if_hpp" title="Header <boost/contract/call_if.hpp>"> 9<link rel="prev" href="call_if.html" title="Function template call_if"> 10<link rel="next" href="condition_if.html" title="Function template condition_if"> 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="call_if.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.call_if_hpp"><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="condition_if.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.contract.condition_if_c"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function template condition_if_c</span></h2> 29<p>boost::contract::condition_if_c — Select compilation and execution of a boolean functor template condition using a static boolean predicate (not needed on C++17 compilers, use <code class="computeroutput">if constexpr</code> instead). </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: <<a class="link" href="../../reference.html#header.boost.contract.call_if_hpp" title="Header <boost/contract/call_if.hpp>">boost/contract/call_if.hpp</a>> 33 34</span> 35<span class="keyword">template</span><span class="special"><</span><span class="keyword">bool</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">></span> 36 <span class="keyword">bool</span> <span class="identifier">condition_if_c</span><span class="special">(</span><span class="identifier">Then</span> f<span class="special">,</span> <span class="keyword">bool</span> else_ <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre></div> 37<div class="refsect1"> 38<a name="idm45988680390848"></a><h2>Description</h2> 39<p>Compile and execute the nullary boolean functor template call <code class="computeroutput">f()</code> if and only if the specified static boolean predicate <code class="computeroutput">Pred</code> is <code class="computeroutput">true</code>, otherwise trivially return <code class="computeroutput">else_</code> (<code class="computeroutput">true</code> by default) at run-time.</p> 40<p>A call to <code class="computeroutput">boost::contract::condition_if_c<Pred>(f, else_)</code> is logically equivalent to <code class="computeroutput">boost::contract::call_if_c<Pred>(f, [] { return else_; })</code> (but its internal implementation is optimized and it does not actually use <code class="computeroutput">call_if_c</code>).</p> 41<p><span class="bold"><strong>See Also:</strong></span></p> 42<p> <a class="link" href="../../boost_contract/extras.html#boost_contract.extras.assertion_requirements__templates_" title="Assertion Requirements (Templates)"> 43 Assertion Requirements</a></p> 44<p> 45</p> 46<p> 47 48 49 50 51</p> 52<div class="variablelist"><table border="0" class="variablelist compact"> 53<colgroup> 54<col align="left" valign="top"> 55<col> 56</colgroup> 57<tbody> 58<tr> 59<td><p><span class="term">Parameters:</span></p></td> 60<td><div class="variablelist"><table border="0" class="variablelist compact"> 61<colgroup> 62<col align="left" valign="top"> 63<col> 64</colgroup> 65<tbody> 66<tr> 67<td><p><span class="term"><code class="computeroutput">else_</code></span></p></td> 68<td><p>Boolean value to return when <code class="computeroutput">Pred</code> is <code class="computeroutput">false</code> (instead of compiling and executing the functor template call <code class="computeroutput">f()</code>).</p></td> 69</tr> 70<tr> 71<td><p><span class="term"><code class="computeroutput">f</code></span></p></td> 72<td><p>Nullary boolean functor template. The functor template call <code class="computeroutput">f()</code> is compiled and executed if and only if <code class="computeroutput">Pred</code> is <code class="computeroutput">true</code>.</p></td> 73</tr> 74</tbody> 75</table></div></td> 76</tr> 77<tr> 78<td><p><span class="term">Template Parameters:</span></p></td> 79<td><div class="variablelist"><table border="0" class="variablelist compact"> 80<colgroup> 81<col align="left" valign="top"> 82<col> 83</colgroup> 84<tbody><tr> 85<td><p><span class="term"><code class="computeroutput">Pred</code></span></p></td> 86<td><p>Static boolean predicate selecting when the functor template call <code class="computeroutput">f()</code> should be compiled and executed. </p></td> 87</tr></tbody> 88</table></div></td> 89</tr> 90<tr> 91<td><p><span class="term">Returns:</span></p></td> 92<td><p>Boolean value returned by <code class="computeroutput">f()</code> if the static predicate <code class="computeroutput">Pred</code> is <code class="computeroutput">true</code>. Otherwise, trivially return <code class="computeroutput">else_</code>. </p></td> 93</tr> 94</tbody> 95</table></div> 96</div> 97</div> 98<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 99<td align="left"></td> 100<td align="right"><div class="copyright-footer">Copyright © 2008-2019 Lorenzo Caminiti<p> 101 Distributed under the Boost Software License, Version 1.0 (see accompanying 102 file LICENSE_1_0.txt or a copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 103 </p> 104</div></td> 105</tr></table> 106<hr> 107<div class="spirit-nav"> 108<a accesskey="p" href="call_if.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.call_if_hpp"><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="condition_if.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 109</div> 110</body> 111</html> 112
