summaryrefslogtreecommitdiff
path: root/doc/html/indeterminate.html
blob: 3e208d97c4ec80aa4304a19afbb0ac037cb14fcd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Function indeterminate</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="tribool/reference.html#id996838" title="Header &lt;boost/logic/tribool.hpp&gt;">
<link rel="prev" href="boost/logic/tribool.html" title="Class tribool">
<link rel="next" href="id866049.html" title="Function operator!">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost/logic/tribool.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tribool/reference.html#id996838"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id866049.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="indeterminate"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Function indeterminate</span></h2>
<p>boost::logic::indeterminate &#8212; Keyword and test function for the indeterminate tribool value. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
<span class="type"><span class="bold"><strong>bool</strong></span></span> indeterminate(<a href="boost/logic/tribool.html" title="Class tribool">tribool</a> x, <span class="emphasis"><em>unspecified</em></span> dummy = <span class="emphasis"><em>unspecified</em></span>);</pre></div>
<div class="refsect1" lang="en">
<a name="id1569800"></a><h2>Description</h2>
<p>The <code class="computeroutput">indeterminate</code>  function has a dual role. It's first role is as a unary function that tells whether the tribool value is in the "indeterminate" state. It's second role is as a keyword representing the indeterminate (just like "true" and "false" represent the true and false states). If you do not like the name "indeterminate", and would prefer to use a different name, see the macro <code class="computeroutput">BOOST_TRIBOOL_THIRD_STATE</code> .</p>
<p></p>
<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:

    <code class="computeroutput">x.value == tribool::indeterminate_value</code><br><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Throws</span></b>:

    Will not throw.</p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2002-2004 Douglas Gregor</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost/logic/tribool.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tribool/reference.html#id996838"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id866049.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>