Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/memory/uninitialized move n"

From cppreference.com
< cpp‎ | memory
m (Use parallel overload precondition template)
(~)
 
(8 intermediate revisions by 5 users not shown)
Line 2: Line 2:
 
{{cpp/memory/navbar}}
 
{{cpp/memory/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
{{dcl header | memory }}
+
{{dcl header|memory}}
{{dcl | since=c++17 | num= 1 |1=  
+
{{dcl|since=c++17|num=1|1=  
template< class InputIt, class Size, class ForwardIt >
+
template< class InputIt, class Size, class NoThrowForwardIt >
std::pair<InputIt, ForwardIt> uninitialized_move_n( InputIt first, Size count,
+
std::pair<InputIt, NoThrowForwardIt>
                                                    ForwardIt d_first );
+
    uninitialized_move_n( InputIt first, Size count,
 +
                          NoThrowForwardIt d_first );
 +
}}
 +
{{dcl|since=c++17|num=2|1=
 +
template< class ExecutionPolicy, class ForwardIt,
 +
          class Size, class NoThrowForwardIt >
 +
std::pair<ForwardIt, NoThrowForwardIt>
 +
    uninitialized_move_n( ExecutionPolicy&& policy, ForwardIt first,
 +
                          Size count, NoThrowForwardIt d_first );
 
}}
 
}}
{{dcl | since=c++17 | num= 2 |1=
 
template< class ExecutionPolicy, class InputIt, class Size, class ForwardIt >
 
std::pair<InputIt, ForwardIt> uninitialized_move_n( ExecutionPolicy&& policy,
 
                                                    InputIt first, Size count,
 
                                                    ForwardIt d_first );}}
 
 
{{dcl end}}
 
{{dcl end}}
 
                                      
 
                                      
@1@ Moves {{tt|count}} elements from a range beginning at {{tt|first}} to an uninitialized memory area beginning at {{tt|d_first}} as if by
+
@1@ Moves {{c|count}} elements from a range beginning at {{c|first}} to an uninitialized memory area beginning at {{c|d_first}} as if by
{{source|1=
+
{{c multi|
for ( ; n > 0; ++d_first, (void) ++first, --n)
+
for (; n > 0; ++d_first, (void) ++first, --n)|
  ::new (static_cast<void*>(std::addressof(*d_first)))
+
    ::new (static_cast<void*>(std::addressof(*d_first)))|
      typename std::iterator_traits<ForwardIt>::value_type(std::move(*first));
+
        typename std::iterator_traits<NoThrowForwardIt>::value_type(std::move(*first));
 
}}
 
}}
  
@@ If an exception is thrown during the initialization, some objects in the source range are left in a valid but unspecified state, and the objects already constructed are destroyed in an unspecified order.  
+
@@ If an exception is thrown during the initialization, some objects in {{counted range|first|n}} are left in a valid but unspecified state, and the objects already constructed are destroyed in an unspecified order.
 +
{{rrev|since=c++20|
 +
If {{counted range|d_first|n}} overlaps with {{counted range|first|n}}, the behavior is undefined.
 +
}}
  
@2@ Same as {{v|1}}, but executed according to {{tt|policy}}. {{cpp/algorithm/parallel overload precondition}}
+
@2@ Same as {{v|1}}, but executed according to {{c|policy}}. {{cpp/algorithm/parallel overload precondition}}
  
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
{{par | first | the beginning of the range of the elements to move}}
+
{{par|first|the beginning of the range of the elements to move}}
{{par | d_first | the beginning of the destination range}}
+
{{par|d_first|the beginning of the destination range}}
 +
{{par|count|the number of elements to move}}
 
{{par exec pol}}
 
{{par exec pol}}
 
{{par hreq}}
 
{{par hreq}}
{{par req named | InputIt | InputIterator}}
+
{{par req named|InputIt|InputIterator}}
{{par req named | ForwardIt | ForwardIterator}}
+
{{par req named|ForwardIt|ForwardIterator}}
{{par req | No increment, assignment, comparison, or indirection through valid instances of {{tt|ForwardIt}} may throw exceptions.}}
+
{{par req named|NoThrowForwardIt|ForwardIterator}}
 +
{{par req|No increment, assignment, comparison, or indirection through valid instances of {{tt|NoThrowForwardIt}} may throw exceptions.}}
 
{{par end}}
 
{{par end}}
  
Line 41: Line 49:
  
 
===Complexity===
 
===Complexity===
Linear in {{tt|count}}.
+
Linear in {{c|count}}.
  
 
===Exceptions===
 
===Exceptions===
{{cpp/algorithm/parallel_exceptions_reporting_behavior|singular=yes}}
+
{{cpp/algorithm/parallel exceptions reporting behavior|singular=yes}}
  
 
===Possible implementation===
 
===Possible implementation===
{{eq fun | 1=
+
{{eq fun|1=
template<class InputIt, class Size, class ForwardIt>
+
template<class InputIt, class Size, class NoThrowForwardIt>
std::pair<InputIt, ForwardIt> uninitialized_move_n(InputIt first, Size count, ForwardIt d_first)
+
std::pair<InputIt, NoThrowForwardIt>
 +
    uninitialized_move_n(InputIt first, Size count, NoThrowForwardIt d_first)
 
{
 
{
     typedef typename std::iterator_traits<ForwardIt>::value_type Value;
+
     using Value = typename std::iterator_traits<NoThrowForwardIt>::value_type;
     ForwardIt current = d_first;
+
     NoThrowForwardIt current = d_first;
     try {
+
     try
         for (; count > 0; ++first, (void) ++current, --count) {
+
    {
 +
         for (; count > 0; ++first, (void) ++current, --count)
 
             ::new (static_cast<void*>(std::addressof(*current))) Value(std::move(*first));
 
             ::new (static_cast<void*>(std::addressof(*current))) Value(std::move(*first));
        }
+
    }
     } catch (...) {
+
     catch (...)
         for (; d_first != current; ++d_first) {
+
    {
            d_first->~Value();
+
         std::destroy(d_first, current);
        }
+
 
         throw;
 
         throw;
 
     }
 
     }
Line 69: Line 78:
 
===Example===
 
===Example===
 
{{example
 
{{example
| code=
+
|code=
 +
#include <cstdlib>
 +
#include <iomanip>
 +
#include <iostream>
 +
#include <memory>
 +
#include <string>
 +
 
 +
void print(auto rem, auto first, auto last)
 +
{
 +
    for (std::cout << rem; first != last; ++first)
 +
        std::cout << std::quoted(*first) << ' ';
 +
    std::cout << '\n';
 +
}
 +
 
 +
int main()
 +
{
 +
    std::string in[]{"One", "Definition", "Rule"};
 +
    print("initially, in: ", std::begin(in), std::end(in));
 +
   
 +
    if (
 +
        constexpr auto sz = std::size(in);
 +
        void* out = std::aligned_alloc(alignof(std::string), sizeof(std::string) * sz))
 +
    {
 +
        try
 +
        {
 +
            auto first{static_cast<std::string*>(out)};
 +
            auto last{first + sz};
 +
            std::uninitialized_move_n(std::begin(in), sz, first);
 +
           
 +
            print("after move, in: ", std::begin(in), std::end(in));
 +
            print("after move, out: ", first, last);
 +
           
 +
            std::destroy(first, last);
 +
        }
 +
        catch (...)
 +
        {
 +
            std::cout << "Exception!\n";
 +
        }
 +
        std::free(out);
 +
    }
 +
}
 +
|p=true<!-- the result of move is unspecified -->
 +
|output=
 +
initially, in: "One" "Definition" "Rule"
 +
after move, in: "" "" ""
 +
after move, out: "One" "Definition" "Rule"
 
}}
 
}}
 +
 +
===Defect reports===
 +
{{dr list begin}}
 +
{{dr list item|wg=lwg|dr=3870|std=C++20|before=this algorithm might create objects on a {{c/core|const}} storage|after=kept disallowed}}
 +
{{dr list end}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
{{dsc inc | cpp/memory/dsc uninitialized_move}}
+
{{dsc inc|cpp/memory/dsc uninitialized_move}}
{{dsc inc | cpp/memory/dsc uninitialized_copy_n}}
+
{{dsc inc|cpp/memory/dsc uninitialized_copy_n}}
 +
{{dsc inc|cpp/memory/ranges/dsc uninitialized_move_n}}
 
{{dsc end}}
 
{{dsc end}}
  
{{langlinks|ja|zh}}
+
{{langlinks|es|ja|ru|zh}}

Latest revision as of 19:10, 25 July 2023

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Dynamic memory management
Uninitialized memory algorithms
Constrained uninitialized memory algorithms
Allocators
Garbage collection support
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)



 
Defined in header <memory>
template< class InputIt, class Size, class NoThrowForwardIt >

std::pair<InputIt, NoThrowForwardIt>
    uninitialized_move_n( InputIt first, Size count,

                          NoThrowForwardIt d_first );
(1) (since C++17)
template< class ExecutionPolicy, class ForwardIt,

          class Size, class NoThrowForwardIt >
std::pair<ForwardIt, NoThrowForwardIt>
    uninitialized_move_n( ExecutionPolicy&& policy, ForwardIt first,

                          Size count, NoThrowForwardIt d_first );
(2) (since C++17)
1) Moves count elements from a range beginning at first to an uninitialized memory area beginning at d_first as if by for (; n > 0; ++d_first, (void) ++first, --n)
    ::new (static_cast<void*>(std::addressof(*d_first)))
        typename std::iterator_traits<NoThrowForwardIt>::value_type(std::move(*first));
If an exception is thrown during the initialization, some objects in first + [0n) are left in a valid but unspecified state, and the objects already constructed are destroyed in an unspecified order.

If d_first + [0n) overlaps with first + [0n), the behavior is undefined.

(since C++20)
2) Same as (1), but executed according to policy. This overload participates in overload resolution only if

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true.

(until C++20)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> is true.

(since C++20)

Contents

[edit] Parameters

first - the beginning of the range of the elements to move
d_first - the beginning of the destination range
count - the number of elements to move
policy - the execution policy to use. See execution policy for details.
Type requirements
-
InputIt must meet the requirements of LegacyInputIterator.
-
ForwardIt must meet the requirements of LegacyForwardIterator.
-
NoThrowForwardIt must meet the requirements of LegacyForwardIterator.
-
No increment, assignment, comparison, or indirection through valid instances of NoThrowForwardIt may throw exceptions.

[edit] Return value

A pair whose first element is an iterator to the element past the last element moved in the source range, and whose second element is an iterator to the element past the last element moved in the destination range.

[edit] Complexity

Linear in count.

[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 InputIt, class Size, class NoThrowForwardIt>
std::pair<InputIt, NoThrowForwardIt>
    uninitialized_move_n(InputIt first, Size count, NoThrowForwardIt d_first)
{
    using Value = typename std::iterator_traits<NoThrowForwardIt>::value_type;
    NoThrowForwardIt current = d_first;
    try
    {
        for (; count > 0; ++first, (void) ++current, --count)
            ::new (static_cast<void*>(std::addressof(*current))) Value(std::move(*first));
    }
    catch (...)
    {
        std::destroy(d_first, current);
        throw;
    }
    return {first, current};
}

[edit] Example

#include <cstdlib>
#include <iomanip>
#include <iostream>
#include <memory>
#include <string>
 
void print(auto rem, auto first, auto last)
{
    for (std::cout << rem; first != last; ++first)
        std::cout << std::quoted(*first) << ' ';
    std::cout << '\n';
}
 
int main()
{
    std::string in[]{"One", "Definition", "Rule"};
    print("initially, in: ", std::begin(in), std::end(in));
 
    if (
        constexpr auto sz = std::size(in);
        void* out = std::aligned_alloc(alignof(std::string), sizeof(std::string) * sz))
    {
        try
        {
            auto first{static_cast<std::string*>(out)};
            auto last{first + sz};
            std::uninitialized_move_n(std::begin(in), sz, first);
 
            print("after move, in: ", std::begin(in), std::end(in));
            print("after move, out: ", first, last);
 
            std::destroy(first, last);
        }
        catch (...)
        {
            std::cout << "Exception!\n";
        }
        std::free(out);
    }
}

Possible output:

initially, in: "One" "Definition" "Rule" 
after move, in: "" "" "" 
after move, out: "One" "Definition" "Rule"

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 3870 C++20 this algorithm might create objects on a const storage kept disallowed

[edit] See also

moves a range of objects to an uninitialized area of memory
(function template) [edit]
copies a number of objects to an uninitialized area of memory
(function template) [edit]
moves a number of objects to an uninitialized area of memory
(niebloid)[edit]