Boost C++ Libraries Home Libraries People FAQ More
PrevUpHomeNext

Class tribool

boost::logic::tribool — A 3-state boolean type.

Synopsis

// In header: <boost/logic/tribool.hpp>


class tribool {
public:
  enum value_t;
  // construct/copy/destruct
  tribool() noexcept;
  tribool(bool) noexcept;
  tribool(indeterminate_keyword_t) noexcept;

  // public member functions
  BOOST_CONSTEXPR operator safe_bool() const noexcept;

  // public data members
  enum boost::logic::tribool::value_t value;
};

Description

3-state boolean values are either true, false, or indeterminate.

tribool public construct/copy/destruct

  1. tribool() noexcept;

    Construct a new 3-state boolean value with the value 'false'.

    Throws:

    		 Will not throw. 
  2. tribool(bool initial_value) noexcept;

    Construct a new 3-state boolean value with the given boolean value, which may be true or false.

    Throws:

    		 Will not throw. 
  3. tribool(indeterminate_keyword_t) noexcept;

    Construct a new 3-state boolean value with an indeterminate value.

    Throws:

    		 Will not throw.

tribool public member functions

  1. BOOST_CONSTEXPR operator safe_bool() const noexcept;

    Use a 3-state boolean in a boolean context. Will evaluate true in a boolean context only when the 3-state boolean is definitely true.

    Returns:

    true if the 3-state boolean is true, false otherwise

    Throws:

    		 Will not throw.
Copyright © 2002-2004 Douglas Gregor

Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
PrevUpHomeNext