ISO/IEC JTC1 SC22 WG21 Programming Language C++
D3019R14
Working Group: Library Evolution, Library
Date: 2025-02-10
Jonathan Coe <jonathanbcoe@gmail.com>
Antony Peacock <ant.peacock@gmail.com>
Sean Parent <sparent@adobe.com>
We propose the addition of two new class templates to the C++ Standard Library:
indirect<T> and polymorphic<T>.
Specializations of these class templates have value semantics and compose well with other standard library types (such as vector), allowing the compiler to correctly generate special member functions.
The class template indirect confers value-like semantics on a
dynamically-allocated object. An indirect may hold an object of a class T.
Copying the indirect will copy the object T. When an indirect<T> is
accessed through a const access path, constness will propagate to the owned
object.
The class template polymorphic confers value-like semantics on a
dynamically-allocated object. A polymorphic<T> may hold an object of a class
publicly derived from T. Copying the polymorphic<T> will copy the object of
the derived type. When a polymorphic<T> is accessed through a const access
path, constness will propagate to the owned object.
This proposal is a fusion of two earlier individual proposals, P1950 and P0201. The design of the two proposed class templates is sufficiently similar that they should not be considered in isolation.
-
Remove mandates that
Tis copy-constructible fromindirect'soperator=(U&&). -
Use
std::strong_ordering::lessinstead offalse < trueinoperator <=>forindirect. -
Amend
rhstolhsin valueless check foroperator<=>forindirect. -
Add missing commas in wording.
-
Remove noexcept specification from
operator<=>forindirect. -
Add a second clarifying example to tagged constructors explanatory text.
-
Remove constraint
is_same_v<U, polymorphic>isfalseon polymorphic constructors takingin_place_type_tand an intializer list. -
Order
polymorphicconstructor constraints consistently. -
Remove needless introduction of
UUinindirectconstraints. -
Update discussion of constraints and incomplete type support in appendix.
-
Fix
indirectsynopsis to includeexpliciton the default constructor. -
Replace "may only be X" with "may be X only" in specification of
indirectandpolymorphic. -
Change constraints on
TwhereTcould be an incomplete type to mandates. -
Remove mandates that
Tis a complete type where this is implicitly required by type_traits. -
Tinindirectneeds to be copy-constructible only for the copy constructor(s). -
Add discussion of constraints and incomplete type support in appendix.
-
Fix specification of
<=>to usesynth-three-way-result. -
Change constraints on
operator==forindirectto mandates. -
Remove constraints on
operator<=>forindirect. -
Updates to non-technical specification sections to reflect design revisions for constraints and comparison.
-
Remove unnecesary
remove_constfrom the specification of hash for indirect. -
Add a default template type parameter for single-argument constructors for indirect and polymorphic and for indirect's perfect-forwarding assignment.
-
Add postconditions to say that the moved-from
indirectis valueless in move assigment, move constructor and allocator-extended move construction. The same does not apply for polymorphic which permits a small buffer optimization. -
Add drafting note for use of italicised code font for exposition only variables.
-
Prevent
Tfrom beingin_place_tor a specialization ofin_place_type_tfor both indirect and polymorphic. -
Collect
in_place_tandin_place_type_tconstructors together. -
Define
UUasremove_cvref_t<U>to simplify various requirements. -
Use
derived_fromrather thanis_base_of_vin requirements for polymorphic. -
Require
is_same_v<remove_cvref_t<U>, U>forpolymorphicconstructors takingin_place_type_t<U>. -
Check
is_same_vconstraints first.
-
Correct naming of explicit 'converting' constructors to 'single-argument' constructors.
-
Amend naming of indirect's 'converting' constructor to 'perfect-forwarded' assignment.
-
Correct changelog from R9.
-
Move throws clauses from individual constructor specifications to the start of constructors specification for indirect and polymorphic.
-
Re-order constructors.
-
Add perfect-forwarded assignment operator to
indirect. -
Add single-argument constructors to
indirectandpolymorphic. -
Add intializer list constructors to
indirectandpolymorphic. -
Avoid use of 'heap' and 'free-store' in favour of 'dynamically-allocated storage'.
-
Wording cleanup in parallel with independent implementation.
-
Add more explicit wording for use of
allocator_traits::constructinindirectandpolymorphicconstructors. -
Prevent
indirectandpolymorphicclasses from being instantiated within_place_tand specializations ofin_place_type_t. -
Strike mandates
Tis a complete type from indirect comparison operators and hash for consistency with reference wrapper.
-
Discuss
indirect's non-conditional copy constructor in the light of implementation tricks that would enable it. -
Improve wording for assignment operators to remove ambiguity.
-
Add motivation for
valueless_after_movemember function.
-
Add
std::in_place_targument to indirect constructors. -
Amend wording for assignment operators to provide strong exception guarantee.
-
Amend wording for swap to consider the valueless state.
-
Remove comparison operators for
indirectwhere they can be compiler-synthesized. -
Rename erroneous exposition only variable
allocatortoalloc. -
Add drafting note on exception guarantees behaviour to
swap.
-
Fix wording for assignment operators to provide strong exception guarantee.
-
Add missing wording for valueless hash.
-
Use constraints to require that the object owned by
indirectis copy constructible. This ensures thatstd::is_copy_constructible_vdoes not give misleading results. -
Modify comparison of
indirectallow comparsion of valueless objects. Comparisons are implemented in terms ofoperator==andoperator<=>returningboolandauto. -
Remove
std::formatsupport forstd::indirectas it cannot handle a valueless state. -
Allow copy, move, assign and swap of valueless objects, discuss similarities with variant.
-
No longer specify constructors as uses-allocator constructing anything.
-
Require
Tto satisfy the requirements ofCpp17Destructible. -
Rename exposition only variables
p_topandallocator_toalloc. -
Add discussion on incomplete types.
-
Add discussion on explicit constructors.
-
Add discussion on arithmetic operators and update change table.
-
Remove references to
std::indirect/std::polymorphicvalues terms under[*.general]sections.
-
Add explicit to constructors.
-
Add constructor
indirect(U&& u, Us&&... us)overload and requisite constraints. -
Add constructor
polymorphic(allocator_arg_t, const Allocator& a)overload. -
Add discussion on similarities and differences with variant.
-
Add table of breaking and non-breaking changes to appendix C.
-
Add missing comparison operators and ensure they are all conditionally noexcept.
-
Add argument deduction guides for
std::indirect. -
Address incorrect
std::indirectusage in composite example. -
Additions to acknowledgements.
-
Address wording for
swap()relating tonoexcept. -
Address constraints wording for
std::indirectcomparison operators. -
Copy constructor now uses
allocator_traits::select_on_container_copy_construction. -
Ensure swap and assign with self are nops.
-
Move feature test macros to [version.syn].
-
Remove
std::optionalspecializations. -
Replace use of "erroneous" with "undefined behaviour".
-
Strong exception guarantee for copy assignment.
-
Specify constructors as uses-allocator constructing
T. -
Wording review and additions to
<memory>synopsis [memory.syn]
-
Add discussion on returning
autoforstd::indirectcomparison operators. -
Add discussion of
emplace()to appendix. -
Update wording to support allocator awareness.
-
Add feature-test macros.
-
Add
std::formatsupport forstd::indirect -
Add Appendix B before and after examples.
-
Add preconditions checking for types are not valueless.
-
Add constexpr support.
-
Allow quality of implementation support for small buffer optimization for
polymorphic. -
Extend wording for allocator support.
-
Change constraints to mandates to enable support for incomplete types.
-
Change pointer usage to use
allocator_traitspointer. -
Remove
std::uses_allocatorspecliazations. -
Remove
std::inplace_tparameter in constructors forstd::indirect. -
Fix
sizeoferror.
The standard library has no vocabulary type for a dynamically-allocated object with value semantics. When designing a composite class, we may need an object to be stored indirectly to support incomplete types, reduce object size or support open-set polymorphism.
We propose the addition of two new class templates to the standard library to
represent indirectly stored values: indirect and polymorphic. Both class
templates represent dynamically-allocated objects with value-like semantics.
polymorphic<T> can own any object of a type publicly derived from T,
allowing composite classes to contain polymorphic components. We require the
addition of two classes to avoid the cost of virtual dispatch (calling the copy
constructor of a potentially derived-type object through type erasure) when
copying of polymorphic objects is not needed.
We review the fundamental design requirements of indirect and polymorphic
that make them suitable for composite class design.
Both class templates are suitable for use as members of composite classes where
the compiler will generate special member functions. This means that the class
templates should provide the special member functions where they are supported
by the owned object type T. As T may be an incomplete type, the special member
functions are unconditionally available to participate in overload resolution but
would lead to an ill-formed program if they are called for a type that does not
support them.
Copies of indirect<T> and polymorphic<T> should own copies of the owned
object created with the copy constructor of the owned object. In the case of
polymorphic<T>, this means that the copy should own a copy of a potentially
derived type object created with the copy constructor of the derived type
object.
Note: Including a polymorphic component in a composite class means that
virtual dispatch will be used (through type erasure) in copying the
polymorphic member. Where a composite class contains a polymorphic member from
a known set of types, prefer std::variant or indirect<std::variant> if
indirect storage is required.
When composite objects contain pointer, unique_ptr or shared_ptr members
they allow non-const access to their respective pointees when accessed through a
const access path. This prevents the compiler from eliminating a source of
const-correctness bugs and makes it difficult to reason about the
const-correctness of a composite object.
Accessors of unique and shared pointers do not have const and non-const overloads:
T* unique_ptr<T>::operator->() const;
T& unique_ptr<T>::operator*() const;
T* shared_ptr<T>::operator->() const;
T& shared_ptr<T>::operator*() const;When a parent object contains a member of type indirect<T> or
polymorphic<T>, access to the owned object (of type T) through a const
access path should be const qualified.
struct A {
enum class Constness { CONST, NON_CONST };
Constness foo() { return Constness::NON_CONST; }
Constness foo() const { return Constness::CONST; }
};
class Composite {
indirect<A> a_;
Constness foo() { return a_->foo(); }
Constness foo() const { return a_->foo(); }
};
int main() {
Composite c;
assert(c.foo() == A::Constness::NON_CONST);
const Composite& cc = c;
assert(cc.foo() == A::Constness::CONST);
}Both indirect and polymorphic are value types whose owned object's
storage is managed by the specified allocator.
When a value type is copied it gives rise to two independent objects that can be modified separately.
The owned object is part of the logical state of indirect and polymorphic.
Operations on a const-qualified object do not make changes to the object's
logical state nor to the logical state of owned objects.
Both indirect and polymorphic have a valueless state that is used to
implement move. The valueless state is not intended to be observable to the
user. There is no operator bool or has_value member function. Accessing the
value of an indirect or polymorphic after it has been moved from is
undefined behaviour. We provide a valueless_after_move member function that
returns true if an object is in a valueless state. This allows explicit checks
for the valueless state in cases where it cannot be verified statically.
Without a valueless state, moving indirect or polymorphic would require
allocation and moving from the owned object. This would be expensive and would
require the owned object to be moveable. The existence of a valueless state
allows move to be implemented cheaply without requiring the owned object to be
moveable.
Where a nullable indirect or polymorphic is required, using std::optional
is recommended. This may become common practice since indirect and
polymorphic can replace smart pointers in composite classes, where they are
currently used to (mis)represent component objects. Using dynamically-allocated
storage for T should not make it nullable. Nullability must be explicitly opted
into by using std::optional<indirect<T>> or std::optional<polymorphic<T>>.
Both indirect and polymorphic are allocator-aware types. They must be
suitable for use in allocator-aware composite types and containers. Existing
allocator-aware types in the standard, such as vector and map, take an
allocator type as a template parameter, provide allocator_type, and have
constructor overloads taking an additional allocator_type_t and allocator
instance as arguments. As indirect and polymorphic need to work with, and in
the same way, as existing allocator-aware types, they too take an allocator type
as a template parameter, provide allocator_type, and have constructor
overloads taking an additional allocator_type_t and allocator instance as
arguments.
The class templates indirect and polymorphic have strong similarities to
existing class templates. These similarities motivate much of the design; we aim
for consistency with existing library types, not innovation.
The class template indirect owns an object of known type, permits copies,
propagates const and is allocator aware.
-
Like
optionalandunique_ptr,indirectcan be in a valueless state;indirectcan get into the valueless state only after being moved from, or after assignment or construction from a valueless state. -
unique_ptrandoptionalhave preconditions foroperator->andoperator*: the behavior is undefined if*thisdoes not contain a value. -
unique_ptrandoptionalmarkoperator->andoperator*as noexcept:indirectdoes the same. -
optionalandindirectknow the underlying type of the owned object so can implement r-value qualified versions ofoperator*. Forunique_ptr, the underlying type is not known (it could be an instance of a derived class) so r-value qualified versions ofoperator*are not provided. -
Like
vector,indirectowns an object created by an allocator. The move constructor and move assignment operator forvectorare conditionally noexcept on properties of the allocator. Thus forindirect, the move constructor and move assignment operator are conditionally noexcept on properties of the allocator. (Allocator instances may have different underlying memory resources; it is not possible for an allocator with one memory resource to delete an object in another memory resource. When allocators have different underlying memory resources, move necessitates the allocation of memory and cannot be marked noexcept.) Likevector,indirectmarks member and non-memberswapas noexcept and requires allocators to be equal. -
Like
optional,indirectknows the type of the owned object so it can forward comparison operators and hash to the underlying object. A valuelessindirect, like an emptyoptional, hashes to an implementation-defined value.
The class template polymorphic owns an object of unknown type, requires copies,
propagates const and is allocator aware.
-
Like
optionalandunique_ptr,polymorphiccan be in a valueless state;polymorphiccan get into the valueless state only after being moved from, or after assignment or construction from a valueless state. -
unique_ptrandoptionalhave preconditions foroperator->andoperator*: the behavior is undefined if*thisdoes not contain a value. -
unique_ptrandoptionalmarkoperator->andoperator*as noexcept:polymorphicdoes the same. -
Neither
unique_ptrnorpolymorphicknow the underlying type of the owned object so cannot implement r-value qualified versions ofoperator*. Foroptional, the underlying type is known, so r-value qualified versions ofoperator*are provided. -
Like
vector,polymorphicowns an object created by an allocator. The move constructor and move assignment operator forvectorare conditionally noexcept on properties of the allocator. Thus forpolymorphic, the move constructor and move assignment operator are conditionally noexcept on properties of the allocator. Likevector,polymorphicmarks member and non-memberswapas noexcept and requires allocators to be equal. -
Like
unique_ptr,polymorphicdoes not know the type of the owned object (it could be an instance of a derived type). As a result,polymorphiccannot forward comparison operators or hash to the owned object.
The sum type variant<Ts...> models one of several alternatives; indirect<T>
models a single type T, but with different storage constraints to T.
Like indirect, a variant can get into a valueless state. For variant, this
valueless state is accessible when an exception is thrown when changing the
type: variant has bool valueless_by_exception(). When all of the types Ts
are comparable, variant<Ts...> supports comparison without preconditions: it
is valid to compare variants when they are in a valueless state. Variant
comparisons can account for the valueless state with zero cost. A variant must
check which type is the engaged type to perform comparison; valueless is one of
the possible states it can be in. For indirect, allowing comparison when in a
valueless state necessitates the addition of an otherwise redundant check. After
feedback from standard library implementers, we opt to allow hash and comparison
of indirect in a valueless state, at cost, to avoid making comparison or
hash of indirect in a valueless state undefined behaviour.
variant allows valueless objects to be passed around via copy, assignment, move
and move assignment. There is no precondition on variant that it must not be in
a valueless state to be copied from, moved from, assigned from or move assigned
from. While the notion that a valueless indirect or polymorphic is toxic and
must not be passed around code is appealing, it would not interact well with
generic code which may need to handle a variety of types. Note that the standard
does not require a moved-from object to be valid for copy, move, assign or move
assignment: the restriction is only that it should be in a well-formed but
unspecified state. However, there is no precedent for standard library types to
have preconditions on move, copy, assign or move assignment. We opt for
consistency with existing standard library types (namely variant, which has a
valueless state) and allow copy, move, assignment and move assignment of a
valueless indirect and polymorphic. Handling of the valueless state for
indirect and polymorphic in move operations will not incur cost; for copy
operations, the cost of handling the valueless state will be insignificant
compared to the cost of allocating memory. Introducing preconditions for copy,
move, assign and move assign in a later revision of the C++ standard would be a
silent breaking change.
Like variant, indirect does not support formatting by forwarding to the
owned object. There may be no owned object to format so we require the user to
write code to determine how to format a valueless indirect or to validate that
the indirect is not valueless before formatting *i (where i is an instance
of indirect for some formattable type T).
C++ library design guidelines recommend that member functions with narrow
contracts (runtime preconditions) should not be marked noexcept. This is
partially motivated by a non-vendor implementation of the C++ standard library
that uses exceptions in a debug build to check for precondition violations by
throwing an exception. The noexcept status of operator-> and operator* for
indirect and polymorphic is identical to that of optional and
unique_ptr. All have preconditions (*this cannot be valueless), all are
marked noexcept. Whatever strategy was used for testing optional and
unique_ptr can be used for indirect and polymorphic.
Not marking operator-> and operator* as noexcept for indirect and
polymorphic would make them strictly less useful than unique_ptr in contexts
where they would otherwise be a valid replacement.
Constructors for indirect and polymorphic taking an allocator or owned-object
constructor arguments are tagged with allocator_arg_t and in_place_t
(or in_place_type_t) respectively. This is consistent with the standard
library’s use of tagged constructors in optional, any and variant.
Without in_place_t the constructor of indirect would not be able to
construct an owned object using the owned object’s allocator-extended
constructor. indirect(std::in_place, std::allocator_arg, alloc, args)
constructs an indirect with a default-constructed allocator and
an owned object constructed with an allocator-extended constructor taking an
allocator alloc and constructor arguments args.
For comparison, indirect(std::allocator_arg, a, std::in_place, std::allocator_arg, alloc, args)
constructs an indirect with an allocator a and an owned object
constructed with an allocator-extended constructor taking an allocator
alloc and constructor arguments args.
In line with optional and variant, we add single-argument constructors to both
indirect and polymorphic so they can be constructed from single values
without the need to use in_place or in_place_type. As indirect and
polymorphic are allocator-aware types, we also provide allocator-extended
versions of these constructors, in line with those from basic_optional [2] and
existing constructors from indirect and polymorphic.
We add initializer-list constructors to both indirect and polymorphic in
line with those in optional and variant. As indirect and polymorphic are
allocator-aware types, we provide allocator-extended versions of these
constructors, in line with those from basic_optional [2] and existing
constructors from indirect and polymorphic.
Constructors for indirect and polymorphic are marked as explicit. This
disallows “implicit conversion” from single arguments or braced initializers.
Given both indirect and polymorphic use dynamically-allocated storage, there
are no instances where an object could be considered semantically equivalent to
its constructor arguments (unlike pair or variant). To construct an
indirect or polymorphic object, and with it use dynamically-allocated memory,
the user must explicitly use a constructor.
The standard already marks multiple argument constructors as explicit for the
inplace constructors of optional and any.
With some suitably compelling motivation, the explicit keyword could be
removed from some constructors in a later revision of the C++ standard without
rendering code ill-formed.
We add a perfect-forwarded assignment operator for indirect
in line with those from optional and variant.
template <class U=T>
constexpr optional& operator=(U&& u);When assigning to an indirect, there is potential for optimisation if there is
an existing owned object to be assigned to:
indirect<int> i;
foo(i); // could move from `i`.
if (!i.valueless_after_move()) {
*i = 5;
} else {
i = indirect(5);
}With perfect-forwarded assignment, handling the valueless state and potentially creating a new indirect object is done within the perfect-forwarded assignment. The code below is equivalent to the code above:
indirect<int> i;
foo(i); // could move from `i`.
i = 5;There is no perfect-forwarded assignment for polymorphic as type information is
erased. There is no optimisation opportunity to be made as a new object will
need creating regardless of whether the target of assignment is valueless or
not.
Both indirect and polymorphic have a valueless_after_move member function
that is used to query the object state. This member function should rarely be
called: it should be clear through static analysis whether or not an object has
been moved from. The valueless_after_move member function allows explicit
checks for the valueless state in cases where it cannot be verified statically
or where explicit checks might be required by a coding standard such as MISRA or
High Integrity C++.
A type PolymorphicInterface used as a base class with polymorphic does not
need a virtual destructor. The same mechanism that is used to call the copy
constructor of a potentially derived-type object will be used to call the
destructor.
To allow compiler-generation of special member functions of an abstract
interface type PolymorphicInterface in conjunction with polymorphic,
PolymorphicInterface needs at least a non-virtual protected destructor and a
protected copy constructor. PolymorphicInterface does not need to be
assignable, move constructible or move assignable for
polymorphic<PolymorphicInterface> to be assignable, move constructible or move
assignable.
class PolymorphicInterface {
protected:
PolymorphicInterface(const PolymorphicInterface&) = default;
~PolymorphicInterface() = default;
public:
// virtual functions
};For an interface type with a public virtual destructor, users would potentially
pay the cost of virtual dispatch twice when deleting polymorphic<I> objects
containing derived-type objects.
All derived types owned by a polymorphic must be publicly copy constructible.
This proposal continues the work started in [P0201] and [P1950].
Previous work on a cloned pointer type [N3339] met with opposition because of
the mixing of value and pointer semantics. We believe that the unambiguous value
semantics of indirect and polymorphic as described in this proposal address
these concerns.
This proposal is a pure library extension. It requires additions to be made to
the standard library header <memory>.
Note to editors: Add the following macros with editor provided values to [version.syn]
#define __cpp_lib_indirect ??????L // also in <memory>
#define __cpp_lib_polymorphic ??????L // also in <memory>namespace std {
// [inout.ptr], function template inout_ptr
template<class Pointer = void, class Smart, class... Args>
auto inout_ptr(Smart& s, Args&&... args);
<ins>
// DRAFTING NOTE: not sure how to typeset <ins> reasonably in markdown
// [indirect], class template indirect
template<class T, class Allocator = allocator<T>>
class indirect;
// [indirect.hash], hash support
template <class T, class Alloc> struct hash<indirect<T, Alloc>>;
// [polymorphic], class template polymorphic
template <class T, class Allocator = allocator<T>>
class polymorphic;
namespace pmr {
template<class T> using indirect =
indirect<T, polymorphic_allocator<T>>;
template<class T> using polymorphic =
polymorphic<T, polymorphic_allocator<T>>;
}
</ins>
}[Drafting note: The member alloc should be formatted as an exposition only identifier,
but limitations of the processor used to prepare this paper means not all uses are italicised.]
-
An indirect object manages the lifetime of an owned object. An indirect object is valueless if it has no owned object. An indirect object may become valueless only after it has been moved from.
-
In every specialization
indirect<T, Allocator>, if the typeallocator_traits<Allocator>::value_typeis not the same type asT, the program is ill-formed. Every object of typeindirect<T, Allocator>uses an object of typeAllocatorto allocate and free storage for the owned object as needed. -
Constructing an owned object with
args...using the allocatorameans calling
allocator_traits<Allocator>::construct(a, p, args...)whereargsis an expression pack,ais an allocator, andpis a pointer obtained by callingallocator_traits<Allocator>::allocate. -
The member
allocis used for any memory allocation and element construction performed by member functions during the lifetime of each indirect object. The allocatorallocmay be replaced only via assignment orswap(). Allocator replacement is performed by copy assignment, move assignment, or swapping of the allocator only if ([container.reqmts]):allocator_traits<Allocator>::propagate_on_container_copy_assignment::value, or
allocator_traits<Allocator>::propagate_on_container_move_assignment::value, or
allocator_traits<Allocator>::propagate_on_container_swap::valueistruewithin the implementation of the corresponding indirect operation. -
A program that instantiates the definition of the template
indirect<T, Allocator>with a type for theTparameter that is a non-object type, an array type,in_place_t, a specialization ofin_place_type_t, or a cv-qualified type is ill-formed. -
The template parameter
Tofindirectmay be an incomplete type. -
The template parameter
Allocatorofindirectshall meet the Cpp17Allocator requirements. -
If a program declares an explicit or partial specialization of
indirect, the behavior is undefined.
template <class T, class Allocator = allocator<T>>
class indirect {
public:
using value_type = T;
using allocator_type = Allocator;
using pointer = typename allocator_traits<Allocator>::pointer;
using const_pointer = typename allocator_traits<Allocator>::const_pointer;
explicit constexpr indirect();
explicit constexpr indirect(allocator_arg_t, const Allocator& a);
constexpr indirect(const indirect& other);
constexpr indirect(allocator_arg_t, const Allocator& a,
const indirect& other);
constexpr indirect(indirect&& other) noexcept;
constexpr indirect(allocator_arg_t, const Allocator& a,
indirect&& other) noexcept(see below);
template <class U=T>
explicit constexpr indirect(U&& u);
template <class U=T>
explicit constexpr indirect(allocator_arg_t, const Allocator& a, U&& u);
template <class... Us>
explicit constexpr indirect(in_place_t, Us&&... us);
template <class... Us>
explicit constexpr indirect(allocator_arg_t, const Allocator& a,
in_place_t, Us&&... us);
template<class I, class... Us>
explicit constexpr indirect(in_place_t, initializer_list<I> ilist,
Us&&... us);
template<class I, class... Us>
explicit constexpr indirect(allocator_arg_t, const Allocator& a,
in_place_t, initializer_list<I> ilist,
Us&&... us);
constexpr ~indirect();
constexpr indirect& operator=(const indirect& other);
constexpr indirect& operator=(indirect&& other) noexcept(see below);
template <class U=T>
constexpr indirect& operator=(U&& u);
constexpr const T& operator*() const & noexcept;
constexpr T& operator*() & noexcept;
constexpr const T&& operator*() const && noexcept;
constexpr T&& operator*() && noexcept;
constexpr const_pointer operator->() const noexcept;
constexpr pointer operator->() noexcept;
constexpr bool valueless_after_move() const noexcept;
constexpr allocator_type get_allocator() const noexcept;
constexpr void swap(indirect& other) noexcept(see below);
friend constexpr void swap(indirect& lhs, indirect& rhs) noexcept(see below);
template <class U, class AA>
friend constexpr bool operator==(
const indirect& lhs, const indirect<U, AA>& rhs) noexcept(see below);
template <class U>
friend constexpr bool operator==(
const indirect& lhs, const U& rhs) noexcept(see below);
template <class U, class AA>
friend constexpr auto operator<=>(
const indirect& lhs, const indirect<U, AA>& rhs)
-> synth-three-way-result<T, U>;
template <class U>
friend constexpr auto operator<=>(
const indirect& lhs, const U& rhs)
-> synth-three-way-result<T, U>;
private:
pointer p; // exposition only
Allocator alloc = Allocator(); // exposition only
};
template <class Value>
indirect(Value) -> indirect<Value>;
template <class Allocator, class Value>
indirect(allocator_arg_t, Allocator, Value) -> indirect<Value,
typename allocator_traits<Allocator>::template rebind_alloc<Value>>;The following element applies to all functions in [indirect.ctor]:
Throws: Nothing unless allocator_traits<Allocator>::allocate or
allocator_traits<Allocator>::construct throws.
explicit constexpr indirect();-
Constraints:
is_default_constructible_v<Allocator>istrue. -
Mandates:
is_default_constructible_v<T>istrue. -
Effects: Constructs an owned object of type
Twith an empty argument list, using the allocatoralloc.
explicit constexpr indirect(allocator_arg_t, const Allocator& a);-
Mandates:
is_default_constructible_v<T>istrue. -
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeTwith an empty argument list, using the allocatoralloc.
constexpr indirect(const indirect& other);-
Mandates:
is_copy_constructible_v<T>istrue. -
Effects:
allocis direct-non-list-initialized with
allocator_traits<Allocator>::select_on_container_copy_construction(other.alloc). Ifotheris valueless,*thisis valueless. Otherwise, constructs an owned object of typeTwith*other, using the allocatoralloc.
constexpr indirect(allocator_arg_t, const Allocator& a,
const indirect& other);-
Mandates:
is_copy_constructible_v<T>istrue. -
Effects:
allocis direct-non-list-initialized witha. Ifotheris valueless,*thisis valueless. Otherwise, constructs an owned object of typeTwith*other, using the allocatoralloc.
constexpr indirect(indirect&& other) noexcept;-
Effects:
allocis direct-non-list-initialized fromstd::move(other.alloc). Ifotheris valueless,*thisis valueless. Otherwise*thistakes ownership of the owned object ofother. -
Postconditions:
otheris valueless.
constexpr indirect(allocator_arg_t, const Allocator& a, indirect&& other)
noexcept(allocator_traits<Allocator>::is_always_equal::value);-
Mandates: If
allocator_traits<Allocator>::is_always_equal::valueisfalsethenTis a complete type. -
Effects:
allocis direct-non-list-initialized witha. Ifotheris valueless,*thisis valueless. Otherwise, ifalloc == other.allocistrue, constructs an object of typeindirectthat takes ownership of the owned object ofother. Otherwise, constructs an owned object of typeTwith*std::move(other), using the allocatoralloc. -
Postconditions:
otheris valueless.
template <class U=T>
explicit constexpr indirect(U&& u);-
Constraints:
is_same_v<remove_cvref_t<U>, indirect>isfalse,is_same_v<remove_cvref_t<U>, in_place_t>isfalse,is_constructible_v<T, U>istrue, andis_default_constructible_v<Allocator>istrue.
-
Effects: Constructs an owned object of type
Twithstd::forward<U>(u), using the allocatoralloc.
template <class U=T>
explicit constexpr indirect(allocator_arg_t, const Allocator& a, U&& u);-
Constraints:
is_same_v<remove_cvref_t<U>, indirect>isfalse,is_same_v<remove_cvref_t<U>, in_place_t>isfalse, andis_constructible_v<T, U>istrue.
-
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeTwithstd::forward<U>(u), using the allocatoralloc.
template <class... Us>
explicit constexpr indirect(in_place_t, Us&&... us);-
Constraints:
is_constructible_v<T, Us...>istrue, andis_default_constructible_v<Allocator>istrue.
-
Effects: Constructs an owned object of type
Twithstd::forward<Us>(us)..., using the allocatoralloc.
template <class... Us>
explicit constexpr indirect(allocator_arg_t, const Allocator& a,
in_place_t, Us&& ...us);-
Constraints:
is_constructible_v<T, Us...>istrue. -
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeTwithstd::forward<Us>(us)..., using the allocatoralloc.
template<class I, class... Us>
explicit constexpr indirect(in_place_t, initializer_list<I> ilist,
Us&&... us);-
Constraints:
is_constructible_v<T, initializer_list<I>&, Us...>istrue, andis_default_constructible_v<Allocator>istrue.
-
Effects: Constructs an owned object of type
Twith the argumentsilist,std::forward<Us>(us)..., using the allocatoralloc.
template<class I, class... Us>
explicit constexpr indirect(allocator_arg_t, const Allocator& a,
in_place_t, initializer_list<I> ilist,
Us&&... us);-
Constraints:
is_constructible_v<T, initializer_list<I>&, Us...>istrue. -
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeTwith the argumentsilist,std::forward<Us>(us)..., using the allocatoralloc.
constexpr ~indirect();-
Mandates:
Tis a complete type. -
Effects: If
*thisis not valueless, destroys the owned object usingallocator_traits<Allocator>::destroyand then the storage is deallocated.
constexpr indirect& operator=(const indirect& other);-
Mandates:
is_copy_assignable_v<T>istrue, andis_copy_constructible_v<T>istrue.
-
Effects: If
addressof(other) == thisistrue, there are no effects.
Otherwise:2.1. The allocator needs updating if
allocator_traits<Allocator>::propagate_on_container_copy_assignment::value
istrue.2.2. If
otheris valueless,*thisbecomes valueless and the owned object in*this, if any, is destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.2.3. Otherwise, if
alloc == other.allocistrueand*thisis not valueless, equivalent to**this = *other.2.4. Otherwise a new owned object is constructed in
*thisusingallocator_traits<Allocator>::constructwith the owned object fromotheras the argument, using either the allocator in*thisor the allocator inotherif the allocator needs updating.2.5. The previously owned object in
*this, if any, is destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.2.6. If the allocator needs updating, the allocator in
*thisis replaced with a copy of the allocator inother. -
Returns: A reference to
*this. -
Remarks: If any exception is thrown, the result of the expression
this->valueless_after_move()remains unchanged. If an exception is thrown during the call toT's selected copy constructor, no effect. If an exception is thrown during the call toT's copy assignment, the state of its contained value is as defined by the exception safety guarantee ofT's copy assignment.
constexpr indirect& operator=(indirect&& other) noexcept(
allocator_traits<Allocator>::propagate_on_container_move_assignment::value ||
allocator_traits<Allocator>::is_always_equal::value);-
Mandates:
is_copy_constructible_t<T>istrue. -
Effects: If
addressof(other) == thisistrue, there are no effects. Otherwise:6.1. The allocator needs updating if
allocator_traits<Allocator>::propagate_on_container_move_assignment::value
istrue.6.2. If
otheris valueless,*thisbecomes valueless and the owned object in*this, if any, is destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.6.3. Otherwise, if
alloc == other.allocistrue, swaps the owned objects in*thisandother; the owned object inother, if any, is then destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.6.4. Otherwise constructs a new owned object with the owned object of
otheras the argument as an rvalue, using either the allocator in*thisor the allocator inotherif the allocator needs updating.6.5. The previously owned object in
*this, if any, is destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.6.6. If the allocator needs updating, the allocator in
*thisis replaced with a copy of the allocator inother. -
Postconditions:
otheris valueless. -
Returns: A reference to
*this. -
Remarks: If any exception is thrown, there are no effects on
*thisorother.
template <class U=T>
constexpr indirect& operator=(U&& u);-
Constraints:
is_same_v<remove_cvref_t<U>, indirect>isfalse,is_constructible_v<T, U>istrue, andis_assignable_v<T&, U>istrue.
-
Effects: If
*thisis valueless then constructs an owned object of typeTwithstd::forward<U>(u)using the allocatoralloc. Otherwise, equivalent to
**this = std::forward<U>(u). -
Returns: A reference to
*this.
constexpr const T& operator*() const & noexcept;
constexpr T& operator*() & noexcept;-
Preconditions:
*thisis not valueless. -
Returns:
*p.
constexpr const T&& operator*() const && noexcept;
constexpr T&& operator*() && noexcept;-
Preconditions:
*thisis not valueless. -
Returns:
std::move(*p).
constexpr const_pointer operator->() const noexcept;
constexpr pointer operator->() noexcept;-
Preconditions:
*thisis not valueless. -
Returns:
p.
constexpr bool valueless_after_move() const noexcept;- Returns:
trueif*thisis valueless, otherwisefalse.
constexpr allocator_type get_allocator() const noexcept;- Returns:
alloc.
constexpr void swap(indirect& other) noexcept(
allocator_traits<Allocator>::propagate_on_container_swap::value
|| allocator_traits<Allocator>::is_always_equal::value);-
Preconditions: If
allocator_traits<Allocator>::propagate_on_container_swap::value
istrue, thenAllocatormeets the Cpp17Swappable requirements. Otherwiseget_allocator() == other.get_allocator()istrue. -
Effects: Swaps the states of
*thisandother, exchanging owned objects or valueless states. If
allocator_traits<Allocator>::propagate_on_container_swap::value
istrue, then the allocators of*thisandotherare exchanged by callingswapas described in [swappable.requirements]. Otherwise, the allocators are not swapped. [Note: Does not callswapon the owned objects directly. --end note]
constexpr void swap(indirect& lhs, indirect& rhs) noexcept(
noexcept(lhs.swap(rhs)));- Effects: Equivalent to
lhs.swap(rhs).
template <class U, class AA>
constexpr bool operator==(const indirect& lhs, const indirect<U, AA>& rhs)
noexcept(noexcept(*lhs == *rhs));-
Mandates: The expression
*lhs == *rhsis well-formed and its result is convertible to bool. -
Returns: If
lhsis valueless orrhsis valueless,
lhs.valueless_after_move() == rhs.valueless_after_move(); otherwise*lhs == *rhs.
template <class U, class AA>
constexpr synth-three-way-result<T, U> operator<=>(const indirect& lhs,
const indirect<U, AA>& rhs);- Returns: If
lhsis valueless orrhsis valueless,
!lhs.valueless_after_move() <=> !rhs.valueless_after_move(); otherwise
synth-three-way(*lhs, *rhs).
template <class U>
constexpr bool operator==(const indirect& lhs, const U& rhs)
noexcept(noexcept(*lhs == rhs));-
Mandates: The expression
*lhs == rhsis well-formed and its result is convertible to bool. -
Returns: If
lhsis valueless, false; otherwise*lhs == rhs.
template <class U>
constexpr synth-three-way-result<T, U> operator<=>(const indirect& lhs,
const U& rhs);- Returns: If
lhsis valueless,strong_ordering::less; otherwisesynth-three-way(*lhs, rhs).
template <class T, class Allocator>
struct hash<indirect<T, Allocator>>;- The specialization
hash<indirect<T, Allocator>>is enabled ([unord.hash]) if and only ifhash<T>is enabled. When enabled for an objectiof typeindirect<T, Allocator>, thenhash<indirect<T, Allocator>>()(i)evaluates to either the same value ashash<T>()(*i), ifiis not valueless; otherwise to an implementation-defined value. The member functions are not guaranteed to be noexcept.
[Drafting note: The member alloc should be formatted as an exposition only identifier,
but limitations of the processor used to prepare this paper mean not all uses are italicised.]
-
A polymorphic object manages the lifetime of an owned object. A polymorphic object may own objects of different types at different points in its lifetime. A polymorphic object is valueless if it has no owned object. A polymorphic object may become valueless only after it has been moved from.
-
In every specialization
polymorphic<T, Allocator>, if the typeallocator_traits<Allocator>::value_typeis not the same type asT, the program is ill-formed. Every object of typepolymorphic<T, Allocator>uses an object of typeAllocatorto allocate and free storage for the owned object as needed. -
Constructing an owned object of type
Uwithargs...using the allocatorameans callingallocator_traits<Allocator>::construct(a, p, args...)whereargsis an expression pack,ais an allocator,ppoints to storage suitable for an owned object of typeU. -
The member
allocis used for any memory allocation and element construction performed by member functions during the lifetime of each polymorphic value object, or until the allocator is replaced. The allocator may be replaced only via assignment orswap(). Allocator replacement is performed by copy assignment, move assignment, or swapping of the allocator only if (see [container.reqmts]):
allocator_traits<Allocator>::propagate_on_container_copy_assignment::value,
or
allocator_traits<Allocator>::propagate_on_container_move_assignment::value,
or
allocator_traits<Allocator>::propagate_on_container_swap::valueis true within the implementation of the corresponding polymorphic operation. -
A program that instantiates the definition of polymorphic for a non-object type, an array type,
in_place_t, a specialization ofin_place_type_t, or a cv-qualified type is ill-formed. -
The template parameter
Tofpolymorphicmay be an incomplete type. -
The template parameter
Allocatorofpolymorphicshall meet the requirements of Cpp17Allocator. -
If a program declares an explicit or partial specialization of
polymorphic, the behavior is undefined.
template <class T, class Allocator = allocator<T>>
class polymorphic {
public:
using value_type = T;
using allocator_type = Allocator;
using pointer = typename allocator_traits<Allocator>::pointer;
using const_pointer = typename allocator_traits<Allocator>::const_pointer;
explicit constexpr polymorphic();
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a);
constexpr polymorphic(const polymorphic& other);
constexpr polymorphic(allocator_arg_t, const Allocator& a,
const polymorphic& other);
constexpr polymorphic(polymorphic&& other) noexcept;
constexpr polymorphic(allocator_arg_t, const Allocator& a,
polymorphic&& other) noexcept(see below);
template <class U=T>
explicit constexpr polymorphic(U&& u);
template <class U=T>
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a,
U&& u);
template <class U, class... Ts>
explicit constexpr polymorphic(in_place_type_t<U>, Ts&&... ts);
template <class U, class... Ts>
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a,
in_place_type_t<U>, Ts&&... ts);
template <class U, class I, class... Us>
explicit constexpr polymorphic(in_place_type_t<U>,
initializer_list<I> ilist, Us&&... us);
template <class U, class I, class... Us>
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a,
in_place_type_t<U>,
initializer_list<I> ilist, Us&&... us);
constexpr ~polymorphic();
constexpr polymorphic& operator=(const polymorphic& other);
constexpr polymorphic& operator=(polymorphic&& other) noexcept(see below);
constexpr const T& operator*() const noexcept;
constexpr T& operator*() noexcept;
constexpr const_pointer operator->() const noexcept;
constexpr pointer operator->() noexcept;
constexpr bool valueless_after_move() const noexcept;
constexpr allocator_type get_allocator() const noexcept;
constexpr void swap(polymorphic& other) noexcept(see below);
friend constexpr void swap(polymorphic& lhs,
polymorphic& rhs) noexcept(see below);
private:
Allocator alloc = Allocator(); // exposition only
};The following element applies to all functions in [polymorphic.ctor]:
Throws: Nothing unless allocator_traits<Allocator>::allocate
or allocator_traits<Allocator>::construct throws.
explicit constexpr polymorphic();-
Constraints:
is_default_constructible_v<Allocator>istrue. -
Mandates:
is_default_constructible_v<T>istrue, andis_copy_constructible_v<T>istrue.
-
Effects: Constructs an owned object of type
Twith an empty argument list using the allocatoralloc.
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a);-
Mandates:
is_default_constructible_v<T>istrue, andis_copy_constructible_v<T>istrue.
-
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeTwith an empty argument list using the allocatoralloc.
constexpr polymorphic(const polymorphic& other);- Effects:
allocis direct-non-list-initialized with
allocator_traits<Allocator>::select_on_container_copy_construction(other.alloc). Ifotheris valueless,*thisis valueless. Otherwise, constructs an owned object of typeU, whereUis the type of the owned object inother, with the owned object inotherusing the allocatoralloc.
constexpr polymorphic(allocator_arg_t, const Allocator& a,
const polymorphic& other);- Effects:
allocis direct-non-list-initialized witha. Ifotheris valueless,*thisis valueless. Otherwise, constructs an owned object of typeU, whereUis the type of the owned object inother, with the owned object inotherusing the allocatoralloc.
constexpr polymorphic(polymorphic&& other) noexcept;- Effects:
allocis direct-non-list-initialized withstd::move(other.alloc). Ifotheris valueless,*thisis valueless. Otherwise, either*thistakes ownership of the owned object ofotheror, owns an object of the same type constructed from the owned object ofotherconsidering that owned object as an rvalue, using the allocatoralloc.
[Drafting note: The above is intended to permit a small-buffer-optimization and handle the case where allocators compare equal but we do not want to swap pointers.]
constexpr polymorphic(allocator_arg_t, const Allocator& a,
polymorphic&& other)
noexcept(allocator_traits<Allocator>::is_always_equal::value);- Effects:
allocis direct-non-list-initialized witha. Ifotheris valueless,*thisis valueless. Otherwise, ifalloc == other.allocistrue, either constructs an object of typepolymorphicthat owns the owned object of other, makingothervalueless; or, owns an object of the same type constructed from the owned object ofotherconsidering that owned object as an rvalue. Otherwise, ifalloc != other.allocistrue, constructs an object of typepolymorphic, considering the owned object inotheras an rvalue, using the allocatoralloc.
[Drafting note: The above is intended to permit a small-buffer-optimization and handle the case where allocators compare equal but we do not want to swap pointers.]
template <class U=T>
explicit constexpr polymorphic(U&& u);-
Constraints: Where
UUisremove_cvref_t<U>,is_same_v<UU, polymorphic>isfalse,derived_from<UU, T>istrue,is_constructible_v<UU, U>istrue,is_copy_constructible_v<UU>istrue,UUis not a specialization ofin_place_type_t, andis_default_constructible_v<Allocator>istrue.
-
Effects: Constructs an owned object of type
Uwithstd::forward<U>(u)using the allocatoralloc.
template <class U=T>
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a, U&& u);-
Constraints: Where
UUisremove_cvref_t<U>,is_same_v<UU, polymorphic>isfalse,derived_from<UU, T>istrue,is_constructible_v<UU, U>istrue,is_copy_constructible_v<UU>istrue, andUUis not a specialization ofin_place_type_t.
-
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeUwithstd::forward<U>(u)using the allocatoralloc.
template <class U, class... Ts>
explicit constexpr polymorphic(in_place_type_t<U>, Ts&&... ts);-
Constraints:
is_same_v<remove_cvref_t<U>, U>istrue,derived_from<U, T>istrue,is_constructible_v<U, Ts...>istrue,is_copy_constructible_v<U>istrue, andis_default_constructible_v<Allocator>istrue.
-
Effects: Constructs an owned object of type
Uwithstd::forward<Ts>(ts)...using the allocatoralloc.
template <class U, class... Ts>
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a,
in_place_type_t<U>, Ts&&... ts);-
Constraints:
is_same_v<remove_cvref_t<U>, U>istrue,derived_from<U, T>istrue,is_constructible_v<U, Ts...>istrue, andis_copy_constructible_v<U>istrue.
-
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeUwithstd::forward<Ts>(ts)...using the allocatoralloc.
template <class U, class I, class... Us>
explicit constexpr polymorphic(in_place_type_t<U>,
initializer_list<I> ilist, Us&&... us);-
Constraints:
is_same_v<remove_cvref_t<U>, U>istrue,derived_from<U, T>istrue,is_constructible_v<U, initializer_list<I>&, Us...>istrue,is_copy_constructible_v<U>istrue, andis_default_constructible_v<Allocator>istrue.
-
Effects: Constructs an owned object of type
Uwith the argumentsilist,std::forward<Us>(us)...using the allocatoralloc.
template <class U, class I, class... Us>
explicit constexpr polymorphic(allocator_arg_t, const Allocator& a,
in_place_type_t<U>,
initializer_list<I> ilist, Us&&... us);-
Constraints:
is_same_v<remove_cvref_t<U>, U>istrue,derived_from<U, T>istrue,is_constructible_v<U, initializer_list<I>&, Us...>istrue, andis_copy_constructible_v<U>istrue.
-
Effects:
allocis direct-non-list-initialized witha. Constructs an owned object of typeUwith the argumentsilist,std::forward<Us>(us)...using the allocatoralloc.
constexpr ~polymorphic();-
Mandates:
Tis a complete type. -
Effects: If
*thisis not valueless, destroys the owned object usingallocator_traits<Allocator>::destroyand then the storage is deallocated.
constexpr polymorphic& operator=(const polymorphic& other);-
Mandates:
Tis a complete type. -
Effects: If
addressof(other) == thisistrue, there are no effects. Otherwise:2.1. The allocator needs updating if
allocator_traits<Allocator>::propagate_on_container_copy_assignment::value
istrue.2.2. If
otheris not valueless, a new owned object is constructed in*thisusing
allocator_traits<Allocator>::constructwith the owned object fromotheras the argument, using either the allocator in*thisor the allocator inotherif the allocator needs updating.2.3 The previously owned object in
*this, if any, is destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.2.4 If the allocator needs updating, the allocator in
*thisis replaced with a copy of the allocator inother. -
Returns: A reference to
*this. -
Remarks: If any exception is thrown, there are no effects on
*this.
constexpr polymorphic& operator=(polymorphic&& other) noexcept(
allocator_traits<Allocator>::propagate_on_container_move_assignment::value ||
allocator_traits<Allocator>::is_always_equal::value);-
Mandates: If
allocator_traits<Allocator>::is_always_equal::valueisfalse,Tis a complete type. -
Effects: If
addressof(other) == thisistrue, there are no effects. Otherwise:6.1. The allocator needs updating if
allocator_traits<Allocator>::propagate_on_container_move_assignment::value
istrue.6.2. If
alloc == other.allocistrue, swaps the owned objects in*thisandother; the owned object inother, if any, is then destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.6.3. Otherwise, if
alloc != other.allocistrue; ifotheris not valueless, a new owned object is constructed in*thisusingallocator_traits<Allocator>::constructwith the owned object fromotheras the argument as an rvalue, using either the allocator in*thisor the allocator inotherif the allocator needs updating.6.4. The previously owned object in
*this, if any, is destroyed usingallocator_traits<Allocator>::destroyand then the storage is deallocated.6.5. If the allocator needs updating, the allocator in
*thisis replaced with a copy of the allocator inother. -
Returns: A reference to
*this. -
Remarks: If any exception is thrown, there are no effects on
*thisorother.
constexpr const T& operator*() const noexcept;
constexpr T& operator*() noexcept;-
Preconditions:
*thisis not valueless. -
Returns: A reference to the owned object.
constexpr const_pointer operator->() const noexcept;
constexpr pointer operator->() noexcept;-
Preconditions:
*thisis not valueless. -
Returns: A pointer to the owned object.
constexpr bool valueless_after_move() const noexcept;- Returns:
trueif*thisis valueless, otherwisefalse.
constexpr allocator_type get_allocator() const noexcept;- Returns:
alloc.
constexpr void swap(polymorphic& other) noexcept(
allocator_traits<Allocator>::propagate_on_container_swap::value
|| allocator_traits<Allocator>::is_always_equal::value);-
Preconditions: If
allocator_traits<Allocator>::propagate_on_container_swap::value
istrue, thenAllocatormeets the Cpp17Swappable requirements. Otherwiseget_allocator() == other.get_allocator()istrue. -
Effects: Swaps the states of
*thisandother, exchanging owned objects or valueless states. If
allocator_traits<Allocator>::propagate_on_container_swap::value
istrue, then the allocators of*thisandotherare exchanged by callingswapas described in [swappable.requirements]. Otherwise, the allocators are not swapped. [Note: Does not callswapon the owned objects directly. --end note]
constexpr void swap(polymorphic& lhs, polymorphic& rhs) noexcept(
noexcept(lhs.swap(rhs)));- Effects: Equivalent to
lhs.swap(rhs).
A C++20 reference implementation of this proposal is available on GitHub at https://www.github.com/jbcoe/value_types.
The authors would like to thank Andrew Bennieston, Bengt Gustafsson, Casey Carter, Daniel Krugler, David Krauss, David Stone, Ed Catmur, Geoff Romer, German Diago, Jan Moeller, Jonathan Wakely, Josh Berne, Kilian Henneberger, LanguageLawyer, Lewis Baker, Louis Dionne, Maciej Bogus, Malcolm Parsons, Matthew Calabrese, Nathan Myers, Neelofer Banglawala, Nevin Liber, Nina Ranns, Patrice Roy, Roger Orr, Rostislav Khlebnikov, Stephan T. Lavavej, Stephen Kelly, Thomas Koeppe, Thomas Russell, Tom Hudson, Tomasz Kaminski, Tony van Eerd and Ville Voutilainen for suggestions and useful discussion.
A Preliminary Proposal for a Deep-Copying Smart Pointer
W. E. Brown, 2012
http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2012/n3339.pdf
A polymorphic value-type for C++
J. B. Coe, S. Parent 2019
https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p0201r6.html
A Free-Store-Allocated Value Type for C++
J. B. Coe, A. Peacock 2022
https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p1950r2.html
An allocator-aware optional type
P. Halpern, N. D. Ranns, V. Voutilainen, 2024
https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2047r7.html
MISRA Language Guidelines
https://ldra.com/misra/
High Integrity C++
https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard
We discuss some of the decisions that were made in the design of indirect and
polymorphic. Where there are multiple options, we discuss the advantages and
disadvantages of each.
It is conceivable that a single class template could be used as a vocabulary type for an indirect value type supporting polymorphism. However, implementing this would impose efficiency costs on the copy constructor when the owned object is the same type as the template type. When the owned object is a derived type, the copy constructor uses type erasure to perform dynamic dispatch and call the derived type copy constructor. The overhead of indirection and a virtual function call is not tolerable where the owned object type and template type match.
One potential solution would be to use a std::variant to store the owned type
or the control block used to manage the owned type. This would allow the copy
constructor to be implemented efficiently when the owned type and template type
match. This would increase the object size beyond that of a single pointer as
the discriminant must be stored.
For the sake of minimal size and efficiency, we opted to use two class templates.
The older types indirect_value and polymorphic_value had constructors that
take a pointer, copier, and deleter. The copier and deleter could be used to
specify how the object should be copied and deleted. The existence of a pointer
constructor introduces undesirable properties into the design of
polymorphic_value, such as allowing the possibility of object slicing on copy
when the dynamic and static types of a derived-type pointer do not match.
We decided to remove the copier, delete, and pointer constructor in favour of adding allocator support. A pointer constructor and support for custom copiers and deleters are not core to the design of either class template; both could be added in a later revision of the standard if required.
We have been advised that allocator support must be a part of the initial
implementation and cannot be added retrospectively. As indirect and
polymorphic are intended to be used alongside other C++ standard library
types, such as std::map and std::vector, it is important that they have
allocator support in contexts where allocators are used.
Earlier revisions of polymorphic_value had helper functions to get access to
the underlying pointer. These were removed under the advice of the Library
Evolution Working Group as they were not core to the design of the class
template, nor were they consistent with value-type semantics.
Pointer-like accessors like dynamic_pointer_cast and static_pointer_cast,
which are provided for std::shared_ptr, could be added in a later revision of
the standard if required.
We decided not to conditionally enable the default constructor, copy constructor and
comparison operators for indirect, and not to conditionally enable the default
constructor for polymorphic.
Both indirect and polymorphic must support incomplete types at class instantiation time.
Similar to vector, they may falsely advertise support (through type traits or concepts) for
functions that would make a program ill-formed if they were used.
struct Copyable {
Copyable() = default;
Copyable(const Copyable&) = default;
};
struct NonCopyable {
NonCopyable() = default;
NonCopyable(const NonCopyable&) = delete;
};
struct Incomplete;
static_assert(std::is_copy_constructible_v<std::vector<Copyable>>); // Passes.
static_assert(std::is_copy_constructible_v<std::vector<NonCopyable>>); // Passes.
static_assert(std::is_copy_constructible_v<std::vector<Incomplete>>); // Passes.
static_assert(std::is_copy_constructible_v<indirect<Copyable>>); // Passes.
static_assert(std::is_copy_constructible_v<indirect<NonCopyable>>); // Passes.
static_assert(std::is_copy_constructible_v<indirect<Incomplete>>); // Passes.
static_assert(std::is_copy_constructible_v<polymorphic<Copyable>>); // Passes.
static_assert(std::is_copy_constructible_v<polymorphic<NonCopyable>>); // Passes.
static_assert(std::is_copy_constructible_v<polymorphic<Incomplete>>); // Passes.It is possible to avoid misleading type trait information by using deferred constraints: constraint evaluation can be deferred to function instantiation time by applying constraints to a deduced template argument.
template <typename T>
class incomplete_wrapper {
T* t; // Use a pointer for incomplete type support.
public:
template <typename TT=T>
incomplete_wrapper()
requires std::is_default_constructible_v<TT>;
incomplete_wrapper(const incomplete_wrapper&) requires false;
template <typename TT=T>
incomplete_wrapper(const incomplete_wrapper&)
requires std::is_copy_constructible_v<TT>;
};Whilst appealing, this approach is problematic when used in composition with other types.
To illustrate, consider the following class template TaggedType:
template<typename T>
class TaggedType {
T t;
public:
TaggedType() requires std::is_default_constructible_v<T>;
TaggedType(const TaggedType&) requires std::is_copy_constructible_v<T>;
};We cannot instantiate the class TaggedType<incomplete_wrapper<T>> when T is an incomplete type
as the constraints on TaggedType are evaluated at class instantiation time. This will force
the evaluation of the constraints on incomplete_wrapper<T>, which cannot be evaluated as T is incomplete.
To support incomplete_wrapper with an incomplete type, TaggedType must also use deferred constraints.
Any type with constraints that might be templated on TaggedType must then also use deferred constraints,
and so on. The viral nature of this requirement makes incomplete_wrapper unusable with other library
components if it is intended to support incomplete types.
We decided not to impose deferred constraints on indirect and polymorphic, as it would make the types
unusable in composition with other types.
indirect and polymorphic use static assertions (mandates clauses) which are
evaluated at function instantiation time to provide better compiler errors.
For example, the code sample below:
indirect<NonCopyable> copy(const indirect<NonCopyable>& i) {
return i;
}gives the following errors:
indirect.h:LINE:COLUMN: error: static assertion failed
LINE | static_assert(std::copy_constructible<T>);
note: in instantiation of member function 'indirect<NonCopyable>::indirect' requested here
LINE | return i;Arthur O'Dwyer has written a blog post on the topic of constraints and incomplete types https://quuxplusone.github.io/blog/2020/02/05/vector-is-copyable-except-when-its-not.
We decided that there should be no implicit conversion of a value T to an
indirect<T> or polymorphic<T>. An implicit conversion would require using
a memory resource and memory allocation, which is best made explicit by the user.
Rectangle r(w, h);
polymorphic<Shape> s = r; // errorTo transform a value into indirect or polymorphic, the user must use the
appropriate constructor.
Rectangle r(w, h);
polymorphic<Shape> s(std::in_place_type<Rectangle>, r);
assert(dynamic_cast<Rectangle*>(&*s) != nullptr);The older class template polymorphic_value had explicit conversions, allowing
construction of a polymorphic_value<T> from a polymorphic_value<U>, where
T was a base class of U.
polymorphic_value<Quadrilateral> q(std::in_place_type<Rectangle>, w, h);
polymorphic_value<Shape> s = q;
assert(dynamic_cast<Rectangle*>(&*s) != nullptr);Similar code cannot be written with polymorphic as it does not allow
conversions between derived types:
polymorphic<Quadrilateral> q(std::in_place_type<Rectangle>, w, h);
polymorphic<Shape> s = q; // errorThis is a deliberate design decision. polymorphic is intended to be used for
ownership of member data in composite classes where compiler-generated special
member functions will be used.
There is no motivating use case for explicit conversion between derived types outside of tests.
A converting constructor could be added in a future version of the C++ standard.
We implement comparisons for indirect in terms of operator== and
operator<=> returning bool and auto respectively.
The alternative would be to implement the full suite of comparison operators,
forwarding them to the underlying type and allowing non-boolean return types.
Support for non-boolean return types would support unusual (non-regular)
user-defined comparison operators which could be helpful when the underlying
type is part of a domain-specific-language (DSL) that uses comparison operators
for a different purpose. However, this would be inconsistent with other standard
library types like optional, variant and reference_wrapper. Moreover, we'd
likely give only partial support for a theoretical DSL which may well make use
of other operators like operator+ and operator- which are not supported for
indirect.
There is no need for indirect or polymorphic to provide a function call or
an indexing operator. Users who wish to do that can simply access the value and
call its operator. Furthermore, unlike comparisons, function calls or indexing
operators do not compose further; for example, a composite would not be able to
automatically generate a composited operator() or an operator[].
While we could provide support for arithmetic operators, +, - ,*, /, to
indirect in the same way that we support comparisons, we have chosen not to do
so. The arithmetic operators would need to support a valueless state for which
there is no precedent in the standard library.
Support for arithmetic operators could be added in a future version of the C++
standard. If support for arithmetic operators for valueless or empty objects is
later added to the standard library in a coherent way, it could be added for
indirect at that time.
Neither indirect nor polymorphic support emplace as a member function. The
member function emplace could be added as :
template <typename ...Ts>
indirect::emplace(Ts&& ...ts);template <typename U, typename ...Ts>
polymorphic::emplace(in_place_type<U>, Ts&& ...ts);This would be API noise. It offers no efficiency improvement over:
some_indirect = indirect(/* arguments */);some_polymorphic = polymorphic(in_place_type<U>, /* arguments */);Support for an emplace member function could be added in a future version of the C++ standard.
It is possible to implement polymorphic with a small buffer optimisation,
similar to that used in std::function. This would allow polymorphic to store
small objects without allocating memory. Like std::function, the size of the
small buffer is left to be specified by the implementation.
The authors are sceptical of the value of a small buffer optimisation for
objects from a type hierarchy. If the buffer is too small, all instances of
polymorphic will be larger than needed. This is because they will allocate
memory in addition to having the memory from the (empty) buffer as part of the
object size. If the buffer is too big, polymorphic objects will be larger than
necessary, potentially introducing the need for indirect<polymorphic<T>>.
We could add a non-type template argument to polymorphic to specify the size
of the small buffer:
template <typename T, typename Alloc, size_t BufferSize>
class polymorphic;However, we opt not to do this to maintain consistency with other standard
library types. Both std::function and std::string leave the buffer size as
an implementation detail. Including an additional template argument in a later
revision of the standard would be a breaking change. With usage experience,
implementers will be able to determine if a small buffer optimisation is
worthwhile, and what the optimal buffer size might be.
A small buffer optimisation makes little sense for indirect as the sensible
size of the buffer would be dictated by the size of the stored object. This
removes support for incomplete types and locates storage for the object locally,
defeating the purpose of indirect.
We include some minimal, illustrative examples of how indirect and
polymorphic can be used to simplify composite class design.
Without indirect, we use std::unique_ptr to manage the lifetime of the
implementation object. All const-qualified methods of the composite will need to
be manually checked to ensure that they are not calling non-const qualified
methods of component objects.
// Class.h
class Class {
class Impl;
std::unique_ptr<Impl> impl_;
public:
Class();
~Class();
Class(const Class&);
Class& operator=(const Class&);
Class(Class&&) noexcept;
Class& operator=(Class&&) noexcept;
void do_something();
};// Class.cpp
class Impl {
public:
void do_something();
};
Class::Class() : impl_(std::make_unique<Impl>()) {}
Class::~Class() = default;
Class::Class(const Class& other) : impl_(std::make_unique<Impl>(*other.impl_)) {}
Class& Class::operator=(const Class& other) {
if (this != &other) {
Class tmp(other);
using std::swap;
swap(*this, tmp);
}
return *this;
}
Class(Class&&) noexcept = default;
Class& operator=(Class&&) noexcept = default;
void Class::do_something() {
impl_->do_something();
}// Class.h
class Class {
indirect<class Impl> impl_;
public:
Class();
~Class();
Class(const Class&);
Class& operator=(const Class&);
Class(Class&&) noexcept;
Class& operator=(Class&&) noexcept;
void do_something();
};// Class.cpp
class Impl {
public:
void do_something();
};
Class::Class() : impl_(indirect<Impl>()) {}
Class::~Class() = default;
Class::Class(const Class&) = default;
Class& Class::operator=(const Class&) = default;
Class(Class&&) noexcept = default;
Class& operator=(Class&&) noexcept = default;
void Class::do_something() {
impl_->do_something();
}Without polymorphic, we use std::unique_ptr to manage the lifetime of
component objects. All const-qualified methods of the composite will need to be
manually checked to ensure that they are not calling non-const qualified methods
of component objects.
class Canvas;
class Shape {
public:
virtual ~Shape() = default;
virtual std::unique_ptr<Shape> clone() = 0;
virtual void draw(Canvas&) const = 0;
};
class Picture {
std::vector<std::unique_ptr<Shape>> shapes_;
public:
Picture(const std::vector<std::unique_ptr<Shape>>& shapes) {
shapes_.reserve(shapes.size());
for (auto& shape : shapes) {
shapes_.push_back(shape->clone());
}
}
Picture(const Picture& other) {
shapes_.reserve(other.shapes_.size());
for (auto& shape : other.shapes_) {
shapes_.push_back(shape->clone());
}
}
Picture& operator=(const Picture& other) {
if (this != &other) {
Picture tmp(other);
using std::swap;
swap(*this, tmp);
}
return *this;
}
void draw(Canvas& canvas) const;
};
class Canvas;
class Shape {
protected:
~Shape() = default;
public:
virtual void draw(Canvas&) const = 0;
};
class Picture {
std::vector<polymorphic<Shape>> shapes_;
public:
Picture(const std::vector<polymorphic<Shape>>& shapes)
: shapes_(shapes) {}
// Picture(const Picture& other) = default;
// Picture& operator=(const Picture& other) = default;
void draw(Canvas& canvas) const;
};The table below shows the main design components considered, the key design
decisions made, and the cost and impact of alternative design choices. As
presented in this paper, the design of class templates indirect and
polymorphic has been approved by the LEWG. The authors have until C++26 is
standardized to consider making any breaking changes; after C++26, whilst
breaking changes will still be possible, the impact of these changes on users
could be potentially significant and unwelcome.
| Component | Decision | Alternative | Change impact | Breaking change? |
|---|---|---|---|---|
Member emplace |
No member emplace |
Add member emplace |
Pure addition | No |
operator bool |
No operator bool |
Add operator bool |
Changes semantics | No |
indirect comparsion preconditions |
Allow comparison of valueless objects | indirect must not be valueless |
Previously valid code would invoke undefined behaviour | Yes |
indirect hash preconditions |
Allow hash of valueless objects | indirect must not be valueless |
Previously valid code would invoke undefined behaviour | Yes |
| Copy and copy assign preconditions | Object can be valueless | Forbids copying of valueless objects | Previously valid code would invoke undefined behaviour | Yes |
| Move and move assign preconditions | Object can be valueless | Forbids moving of valueless objects | Previously valid code would invoke undefined behaviour | Yes |
Requirements on T in polymorphic<T> |
No requirement that T has virtual functions |
Add Mandates to require T to have virtual functions |
Code becomes ill-formed | Yes |
| State of default-constructed object | Default-constructed object (where valid) has a value | Make default-constructed object valueless | Changes semantics; necessitates adding operator bool and allowing move, copy and compare of valueless (empty) objects |
Yes |
| Small buffer optimisation for polymorphic | SBO is not required, settings are hidden | Add buffer size and alignment as template parameters | Breaks ABI; forces implementers to use SBO | Yes |
noexcept for accessors |
Accessors are noexcept like unique_ptr and optional |
Remove noexcept from accessors |
User functions marked noexcept could be broken |
Yes |
| Specialization of optional | No specialization of optional | Specialize optional to use valueless state | Breaks ABI; engaged but valueless optional would become indistinguishable from a disengaged optional | Yes |
| Permit user specialization | No user specialization is permitted | Permit specialization for user-defined types | Previously ill-formed code would become well-formed | No |
| Explicit constructors | Constructors are marked explicit |
Non-explicit constructors | Conversion for single arguments or braced initializers becomes valid | No |
| Support comparisons for indirect | Comparisons are supported when the owned type supports them | No support for comparisons | Previously valid code would become ill-formed | Yes |
Support arithmetic operations for indirect |
No support for arithmetic operations | Forward arithemtic operations to the owned type when it supports them | Previously ill-formed code would become well-formed | No |
Support operator () for indirect |
No support for operator () |
Forward operator() to the owned type when it is supported |
Previously ill-formed code would become well-formed | No |
Support operator [] for indirect |
No support for operator [] |
Forward operator[] to the owned type when it is supported |
Previously ill-formed code would become well-formed | No |