Namespaces
Variants
Views
Actions

std::uninitialized_value_construct_n

From cppreference.com
< cpp‎ | memory
 
 
Utilities library
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++17)

Elementary string conversions
(C++17)
(C++17)
 
Dynamic memory management
Smart pointers
(C++11)
(C++11)
(C++11)
(until C++17)
(C++11)
Allocators
Memory resources
Uninitialized storage
Uninitialized memory algorithms
uninitialized_value_construct_n
(C++17)
(C++17)
Constrained uninitialized memory algorithms
Garbage collection support
Miscellaneous
(C++20)
(C++11)
(C++11)
C Library
Low level memory management
 
Defined in header <memory>
template< class ForwardIt, class Size >
ForwardIt uninitialized_value_construct_n( ForwardIt first, Size n );
(1) (since C++17)
template< class ExecutionPolicy, class ForwardIt, class Size >
ForwardIt uninitialized_value_construct_n( ExecutionPolicy&& policy, ForwardIt first, Size n );
(2) (since C++17)
1) Constructs n objects of type typename iterator_traits<ForwardIt>::value_type in the uninitialized storage starting at first by value-initialization, as if by
for (; n > 0; (void) ++first, --n)
  ::new (static_cast<void*>(std::addressof(*first)))
      typename std::iterator_traits<ForwardIt>::value_type();
If an exception is thrown during the initialization, the objects already constructed are destroyed in an unspecified order.
2) Same as (1), but executed according to policy. This overload does not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> (until C++20) std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> (since C++20) is true.

Contents

[edit] Parameters

first - the beginning of the range of elements to initialize
n - the number of elements to initialize
policy - the execution policy to use. See execution policy for details.
Type requirements
-
ForwardIt must meet the requirements of LegacyForwardIterator.
-
No increment, assignment, comparison, or indirection through valid instances of ForwardIt may throw exceptions.

[edit] Return value

The end of the range of objects (i.e., std::next(first, n)).

[edit] Complexity

Linear in n.

[edit] Exceptions

The overload with a template parameter named ExecutionPolicy reports errors as follows:

  • If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the standard policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
  • If the algorithm fails to allocate memory, std::bad_alloc is thrown.

[edit] Possible implementation

template<class ForwardIt, class Size>
ForwardIt uninitialized_value_construct_n( ForwardIt first, Size n )
{
    using T = typename std::iterator_traits<ForwardIt>::value_type;
    ForwardIt current = first;
    try {
        for (; n > 0 ; (void) ++current, --n) {
            ::new (static_cast<void*>(std::addressof(*current))) T();
        }
        return current;
    }  catch (...) {
        std::destroy(first, current);
        throw;
    }
}

[edit] Example

[edit] See also

constructs objects by value-initialization in an uninitialized area of memory, defined by a range
(function template) [edit]
constructs objects by default-initialization in an uninitialized area of memory, defined by a start and a count
(function template) [edit]