Difference between revisions of "cpp/memory/ranges/uninitialized move n"
m (→Parameters: ~) |
(LWG3870) |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
{{cpp/memory/navbar}} | {{cpp/memory/navbar}} | ||
{{dcl begin}} | {{dcl begin}} | ||
− | {{dcl header | memory}} | + | {{dcl header|memory}} |
− | {{dcl h | Call signature}} | + | {{dcl h|Call signature}} |
− | {{dcl | num=1 | since=c++20 |1= | + | {{dcl|num=1|since=c++20|1= |
− | template <std::input_iterator I, no-throw-forward-iterator O, | + | template< std::input_iterator I, no-throw-forward-iterator O, |
− | + | no-throw-sentinel-for<O> S > | |
requires std::constructible_from<std::iter_value_t<O>, | requires std::constructible_from<std::iter_value_t<O>, | ||
std::iter_rvalue_reference_t<I>> | std::iter_rvalue_reference_t<I>> | ||
Line 12: | Line 12: | ||
uninitialized_move_n( I ifirst, std::iter_difference_t<I> n, O ofirst, S olast ); | uninitialized_move_n( I ifirst, std::iter_difference_t<I> n, O ofirst, S olast ); | ||
}} | }} | ||
− | {{dcl h | Helper types}} | + | {{dcl h|Helper types}} |
− | {{dcl | num=2 | since=c++20 |1= | + | {{dcl|num=2|since=c++20|1= |
− | template<class I, class O> | + | template< class I, class O > |
using uninitialized_move_n_result = ranges::in_out_result<I, O>; | using uninitialized_move_n_result = ranges::in_out_result<I, O>; | ||
}} | }} | ||
{{dcl end}} | {{dcl end}} | ||
− | Moves {{c|N}} elements from the input range beginning at {{ | + | Moves {{c|N}} elements from the input range beginning at {{c|ifirst}} to the uninitialized storage designated by the range {{range|ofirst|olast}}, where {{c|N}} is {{c|min(n, ranges::distance(ofirst, olast))}}. |
The effect is equivalent to: | The effect is equivalent to: | ||
{{source|1= | {{source|1= | ||
for (; n-- > 0 && ofirst != olast; ++ifirst, ++ofirst) | for (; n-- > 0 && ofirst != olast; ++ifirst, ++ofirst) | ||
− | ::new | + | ::new (static_cast<void*>(std::addressof(*first))) |
std::remove_reference_t<std::iter_reference_t<O>>(ranges::iter_move(ifirst)); | std::remove_reference_t<std::iter_reference_t<O>>(ranges::iter_move(ifirst)); | ||
}} | }} | ||
− | If an exception is thrown during the initialization then the objects that already constructed in {{ | + | If an exception is thrown during the initialization then the objects that already constructed in {{range|ofirst|olast}} are destroyed in an unspecified order. Also, the objects in the input range beginning at {{c|ifirst}}, that were already moved, are left in a valid but unspecified state. |
{{cpp/ranges/niebloid}} | {{cpp/ranges/niebloid}} | ||
Line 34: | Line 34: | ||
===Parameters=== | ===Parameters=== | ||
{{par begin}} | {{par begin}} | ||
− | {{par | ifirst | the beginning of the input range of elements to move from}} | + | {{par|ifirst|the beginning of the input range of elements to move from}} |
− | {{par | ofirst, olast | iterator-sentinel pair denoting the output range of elements to initialize}} | + | {{par|ofirst, olast|iterator-sentinel pair denoting the output range of elements to initialize}} |
− | {{par | n | the number of elements to move | + | {{par|n|the number of elements to move}} |
{{par end}} | {{par end}} | ||
Line 43: | Line 43: | ||
===Complexity=== | ===Complexity=== | ||
− | Linear in | + | Linear in {{c|N}}. |
===Exceptions=== | ===Exceptions=== | ||
Line 52: | Line 52: | ||
===Possible implementation=== | ===Possible implementation=== | ||
− | {{eq fun | 1= | + | {{eq fun|1= |
− | struct uninitialized_move_n_fn { | + | struct uninitialized_move_n_fn |
− | template <std::input_iterator I, no-throw-forward-iterator O, | + | { |
+ | template<std::input_iterator I, no-throw-forward-iterator O, | ||
no-throw-sentinel-for<O> S> | no-throw-sentinel-for<O> S> | ||
requires std::constructible_from<std::iter_value_t<O>, | requires std::constructible_from<std::iter_value_t<O>, | ||
std::iter_rvalue_reference_t<I>> | std::iter_rvalue_reference_t<I>> | ||
ranges::uninitialized_move_n_result<I, O> | ranges::uninitialized_move_n_result<I, O> | ||
− | operator()( I ifirst, std::iter_difference_t<I> n, O ofirst, S olast ) const { | + | operator()(I ifirst, std::iter_difference_t<I> n, O ofirst, S olast) const |
− | O current {ofirst}; | + | { |
− | try { | + | O current{ofirst}; |
+ | try | ||
+ | { | ||
for (; n-- > 0 && current != olast; ++ifirst, ++current) | for (; n-- > 0 && current != olast; ++ifirst, ++current) | ||
::new (const_cast<void*>(static_cast<const volatile void*> | ::new (const_cast<void*>(static_cast<const volatile void*> | ||
Line 67: | Line 70: | ||
std::iter_reference_t<O>>(ranges::iter_move(ifirst)); | std::iter_reference_t<O>>(ranges::iter_move(ifirst)); | ||
return {std::move(ifirst), std::move(current)}; | return {std::move(ifirst), std::move(current)}; | ||
− | } catch (...) | + | } |
+ | catch (...) // rollback: destroy constructed elements | ||
+ | { | ||
for (; ofirst != current; ++ofirst) | for (; ofirst != current; ++ofirst) | ||
ranges::destroy_at(std::addressof(*ofirst)); | ranges::destroy_at(std::addressof(*ofirst)); | ||
Line 87: | Line 92: | ||
#include <string> | #include <string> | ||
− | void print(auto rem, auto first, auto last) { | + | void print(auto rem, auto first, auto last) |
+ | { | ||
for (std::cout << rem; first != last; ++first) | for (std::cout << rem; first != last; ++first) | ||
std::cout << std::quoted(*first) << ' '; | std::cout << std::quoted(*first) << ' '; | ||
Line 93: | Line 99: | ||
} | } | ||
− | int main() { | + | int main() |
− | std::string in[] { "No", "Diagnostic", "Required", }; | + | { |
+ | std::string in[]{ "No", "Diagnostic", "Required", }; | ||
print("initially, in: ", std::begin(in), std::end(in)); | print("initially, in: ", std::begin(in), std::end(in)); | ||
Line 100: | Line 107: | ||
constexpr auto sz = std::size(in); | constexpr auto sz = std::size(in); | ||
void* out = std::aligned_alloc(alignof(std::string), sizeof(std::string) * sz) | void* out = std::aligned_alloc(alignof(std::string), sizeof(std::string) * sz) | ||
− | ) { | + | ) |
− | try { | + | { |
− | auto first {static_cast<std::string*>(out)}; | + | try |
− | auto last {first + sz}; | + | { |
+ | auto first{static_cast<std::string*>(out)}; | ||
+ | auto last{first + sz}; | ||
std::ranges::uninitialized_move_n(std::begin(in), sz, first, last); | std::ranges::uninitialized_move_n(std::begin(in), sz, first, last); | ||
Line 111: | Line 120: | ||
std::ranges::destroy(first, last); | std::ranges::destroy(first, last); | ||
} | } | ||
− | catch (...) { | + | catch (...) |
+ | { | ||
std::cout << "Exception!\n"; | std::cout << "Exception!\n"; | ||
} | } | ||
Line 117: | Line 127: | ||
} | } | ||
} | } | ||
− | | p=true <!-- the result of move is unspecified --> | + | |p=true <!-- the result of move is unspecified --> |
− | | output= | + | |output= |
initially, in: "No" "Diagnostic" "Required" | initially, in: "No" "Diagnostic" "Required" | ||
after move, in: "" "" "" | after move, in: "" "" "" | ||
after move, out: "No" "Diagnostic" "Required" | after move, out: "No" "Diagnostic" "Required" | ||
}} | }} | ||
+ | |||
+ | ===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/ranges/dsc uninitialized_move}} | + | {{dsc inc|cpp/memory/ranges/dsc uninitialized_move}} |
− | {{dsc inc | cpp/memory/dsc uninitialized_move_n}} | + | {{dsc inc|cpp/memory/dsc uninitialized_move_n}} |
{{dsc end}} | {{dsc end}} | ||
{{langlinks|de|es|fr|it|ja|pt|ru|zh}} | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} |
Latest revision as of 19:15, 25 July 2023
Defined in header <memory>
|
||
Call signature |
||
template< std::input_iterator I, no-throw-forward-iterator O, no-throw-sentinel-for<O> S > |
(1) | (since C++20) |
Helper types |
||
template< class I, class O > using uninitialized_move_n_result = ranges::in_out_result<I, O>; |
(2) | (since C++20) |
Moves N elements from the input range beginning at ifirst to the uninitialized storage designated by the range [
ofirst,
olast)
, where N is min(n, ranges::distance(ofirst, olast)).
The effect is equivalent to:
for (; n-- > 0 && ofirst != olast; ++ifirst, ++ofirst) ::new (static_cast<void*>(std::addressof(*first))) std::remove_reference_t<std::iter_reference_t<O>>(ranges::iter_move(ifirst));
If an exception is thrown during the initialization then the objects that already constructed in [
ofirst,
olast)
are destroyed in an unspecified order. Also, the objects in the input range beginning at ifirst, that were already moved, are left in a valid but unspecified state.
The function-like entities described on this page are niebloids, that is:
- Explicit template argument lists cannot be specified when calling any of them.
- None of them are visible to argument-dependent lookup.
- When any of them are found by normal unqualified lookup as the name to the left of the function-call operator, argument-dependent lookup is inhibited.
In practice, they may be implemented as function objects, or with special compiler extensions.
Contents |
[edit] Parameters
ifirst | - | the beginning of the input range of elements to move from |
ofirst, olast | - | iterator-sentinel pair denoting the output range of elements to initialize |
n | - | the number of elements to move |
[edit] Return value
{ifirst + N, ofirst + N}.
[edit] Complexity
Linear in N.
[edit] Exceptions
The exception thrown on construction of the elements in the destination range, if any.
[edit] Notes
An implementation may improve the efficiency of the ranges::uninitialized_move_n
, e.g. by using ranges::copy_n, if the value type of the output range is TrivialType.
[edit] Possible implementation
struct uninitialized_move_n_fn { template<std::input_iterator I, no-throw-forward-iterator O, no-throw-sentinel-for<O> S> requires std::constructible_from<std::iter_value_t<O>, std::iter_rvalue_reference_t<I>> ranges::uninitialized_move_n_result<I, O> operator()(I ifirst, std::iter_difference_t<I> n, O ofirst, S olast) const { O current{ofirst}; try { for (; n-- > 0 && current != olast; ++ifirst, ++current) ::new (const_cast<void*>(static_cast<const volatile void*> (std::addressof(*current)))) std::remove_reference_t< std::iter_reference_t<O>>(ranges::iter_move(ifirst)); return {std::move(ifirst), std::move(current)}; } catch (...) // rollback: destroy constructed elements { for (; ofirst != current; ++ofirst) ranges::destroy_at(std::addressof(*ofirst)); throw; } } }; inline constexpr uninitialized_move_n_fn uninitialized_move_n{}; |
[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[]{ "No", "Diagnostic", "Required", }; 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::ranges::uninitialized_move_n(std::begin(in), sz, first, last); print("after move, in: ", std::begin(in), std::end(in)); print("after move, out: ", first, last); std::ranges::destroy(first, last); } catch (...) { std::cout << "Exception!\n"; } std::free(out); } }
Possible output:
initially, in: "No" "Diagnostic" "Required" after move, in: "" "" "" after move, out: "No" "Diagnostic" "Required"
[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
(C++20) |
moves a range of objects to an uninitialized area of memory (niebloid) |
(C++17) |
moves a number of objects to an uninitialized area of memory (function template) |