blob: 92d6bb7a0eeb1067d0bc07e354bcab9e1ba00e35 [file] [log] [blame]
Brian Silverman4a2409e2018-08-04 23:24:02 -07001[/
2 Copyright 2007 John Maddock.
3 Copyright 2013 Antony Polukhin.
4 Distributed under the Boost Software License, Version 1.0.
5 (See accompanying file LICENSE_1_0.txt or copy at
6 http://www.boost.org/LICENSE_1_0.txt).
7]
8
9[section:has_trivial_move_constructor has_trivial_move_constructor]
10
11 template <class T>
12 struct has_trivial_move_constructor : public __tof {};
13
14__inherit If T is a (possibly cv-qualified) type with a trivial move-constructor
15then inherits from __true_type, otherwise inherits from __false_type.
16
17If a type has a trivial move-constructor then the constructor has the same effect
18as copying the bits of one object to the other:
19calls to the constructor can be safely replaced with a call to `memcpy`.
20
21__compat Without some (as yet unspecified) help from the compiler,
22has_trivial_move_constructor will never report that a user-defined class or struct has a
23trivial constructor; this is always safe, if possibly sub-optimal.
24In addition C++11's `decltype` is required to correctly support deleted or private
25move constructors.
26Currently (June 2015) compilers that have the necessary __intrinsics to ensure that this
27trait "just works" include Clang, GCC-5.1, and MSVC-12.0.
28You may also test to see if the necessary __intrinsics are available
29by checking to see if the macro `BOOST_HAS_TRIVIAL_MOVE_CONSTRUCTOR` is defined.
30
31
32__header ` #include <boost/type_traits/has_trivial_move_constructor.hpp>` or ` #include <boost/type_traits.hpp>`
33
34__examples
35
36[:`has_trivial_move_constructor<int>` inherits from `__true_type`.]
37
38[:`has_trivial_move_constructor<char*>::type` is the type `__true_type`.]
39
40[:`has_trivial_move_constructor<int (*)(long)>::value` is an integral constant
41expression that evaluates to /true/.]
42
43[:`has_trivial_move_constructor<MyClass>::value` is an integral constant
44expression that evaluates to /false/.]
45
46[:`has_trivial_move_constructor<T>::value_type` is the type `bool`.]
47
48[endsect]
49