Boost_1_39_0/libs/type_traits/doc/is_base_of.qbk

   1 [/
   2   Copyright 2007 John Maddock.
   3   Distributed under the Boost Software License, Version 1.0.
   4   (See accompanying file LICENSE_1_0.txt or copy at
   5   http://www.boost.org/LICENSE_1_0.txt).
   6 ]
   7
   8 [section:is_base_of is_base_of]
   9    template <class Base, class Derived>
  10    struct is_base_of : public __tof {};
  11
  12 __inherit If Base is base class of type Derived or if both types are the same
  13 then inherits from __true_type,
  14 otherwise inherits from __false_type.
  15
  16 This template will detect non-public base classes, and ambiguous base classes.
  17
  18 Note that `is_base_of<X,X>` will always inherit from __true_type.  [*This is the
  19 case even if `X` is not a class type].  This is a change in behaviour
  20 from Boost-1.33 in order to track the Technical Report on C++ Library Extensions.
  21
  22 Types `Base` and `Derived` must not be incomplete types.
  23
  24 __std_ref 10.
  25
  26 __header ` #include <boost/type_traits/is_base_of.hpp>` or ` #include <boost/type_traits.hpp>`
  27
  28 __compat If the compiler does not support partial-specialization of class templates,
  29 then this template can not be used with function types.  There are some older compilers
  30 which will produce compiler errors if `Base` is a private base class of `Derived`, or if
  31 `Base` is an ambiguous base of `Derived`.  These compilers include Borland C++, older
  32 versions of Sun Forte C++, Digital Mars C++, and older versions of EDG based compilers.
  33
  34 __examples
  35
  36 [:Given: ` class Base{}; class Derived : public Base{};` ]
  37
  38 [:`is_base_of<Base, Derived>` inherits from `__true_type`.]
  39
  40 [:`is_base_of<Base, Derived>::type` is the type `__true_type`.]
  41
  42 [:`is_base_of<Base, Derived>::value` is an integral constant
  43 expression that evaluates to /true/.]
  44
  45 [:`is_base_of<Base, Derived>::value` is an integral constant
  46 expression that evaluates to /true/.]
  47
  48 [:`is_base_of<Base, Base>::value` is an integral constant
  49 expression that evaluates to /true/: a class is regarded as it's own base.]
  50
  51 [:`is_base_of<T>::value_type` is the type `bool`.]
  52
  53 [endsect]
  54