[ceph.git] / ceph / src / boost / libs / type_traits / doc / is_compound.qbk

[/ 
  Copyright 2007 John Maddock.
  Distributed under 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).
]

[section:is_compound is_compound]
   template <class T>
   struct is_compound : public __tof {};
  
__inherit If T is a (possibly cv-qualified) compound type then inherits from __true_type, 
otherwise inherits from __false_type.  Any type that is not a fundamental type is
a compound type (see also __is_fundamental).

__std_ref 3.9.2.

[all_compilers]

__header ` #include <boost/type_traits/is_compound.hpp>` or ` #include <boost/type_traits.hpp>`

__examples

[:`is_compound<MyClass>` inherits from `__true_type`.]

[:`is_compound<MyEnum>::type` is the type `__true_type`.]

[:`is_compound<int*>::value` is an integral constant 
expression that evaluates to /true/.]

[:`is_compound<int&>::value` is an integral constant 
expression that evaluates to /true/.]

[:`is_compound<int>::value` is an integral constant 
expression that evaluates to /false/.]

[:`is_compound<T>::value_type` is the type `bool`.]

[endsect]
Commit	Line	Data
7c673cae FG	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_compound is_compound]
	9	template <class T>
	10	struct is_compound : public __tof {};
	11
	12	__inherit If T is a (possibly cv-qualified) compound type then inherits from __true_type,
	13	otherwise inherits from __false_type. Any type that is not a fundamental type is
	14	a compound type (see also __is_fundamental).
	15
	16	__std_ref 3.9.2.
	17
	18	[all_compilers]
	19
	20	__header ` #include <boost/type_traits/is_compound.hpp>` or ` #include <boost/type_traits.hpp>`
	21
	22	__examples
	23
	24	[:`is_compound<MyClass>` inherits from `__true_type`.]
	25
	26	[:`is_compound<MyEnum>::type` is the type `__true_type`.]
	27
	28	[:`is_compound<int*>::value` is an integral constant
	29	expression that evaluates to /true/.]
	30
	31	[:`is_compound<int&>::value` is an integral constant
	32	expression that evaluates to /true/.]
	33
	34	[:`is_compound<int>::value` is an integral constant
	35	expression that evaluates to /false/.]
	36
	37	[:`is_compound<T>::value_type` is the type `bool`.]
	38
	39	[endsect]
	40