initializer_list and move semantics
Asked Answered
R

8

125

Am I allowed to move elements out of a std::initializer_list<T>?

#include <initializer_list>
#include <utility>

template<typename T>
void foo(std::initializer_list<T> list)
{
    for (auto it = list.begin(); it != list.end(); ++it)
    {
        bar(std::move(*it));   // kosher?
    }
}

Since std::intializer_list<T> requires special compiler attention and does not have value semantics like normal containers of the C++ standard library, I'd rather be safe than sorry and ask.

Ramon answered 19/11, 2011 at 9:26 Comment(1)
The core language defines that the object referred to by an initializer_list<T> are non-const. Like, initializer_list<int> refers to int objects. But I think that is a defect - it is intended that compilers can statically allocate a list in read only memory.Hotspur
S
122

No, that won't work as intended; you will still get copies. I'm pretty surprised by this, as I'd thought that initializer_list existed to keep an array of temporaries until they were move'd.

begin and end for initializer_list return const T *, so the result of move in your code is T const && — an immutable rvalue reference. Such an expression can't meaningfully be moved from. It will bind to an function parameter of type T const & because rvalues do bind to const lvalue references, and you will still see copy semantics.

Probably the reason for this is so the compiler can elect to make the initializer_list a statically-initialized constant, but it seems it would be cleaner to make its type initializer_list or const initializer_list at the compiler's discretion, so the user doesn't know whether to expect a const or mutable result from begin and end. But that's just my gut feeling, probably there's a good reason I'm wrong.

Update: I've written an ISO proposal for initializer_list support of move-only types. It's only a first draft, and it's not implemented anywhere yet, but you can see it for more analysis of the problem.

Sanford answered 19/11, 2011 at 9:38 Comment(13)
In case it isn't clear, it still means using std::move is safe, if not productive. (Barring T const&& move constructors.)Ivanna
I don't think that you could make the whole argument either const std::initializer_list<T> or just std::initializer_list<T> in a way that does not cause surprises quite often. Consider that each argument in the initializer_list can be either const or not and that is known in the context of the caller, but the compiler must generate just one version of the code in the context of the callee (i.e. inside foo it does not know anything about the arguments that the caller is passing in)Pigg
@David: Good point, but it would still be useful to have a std::initializer_list && overload do something, even if a non-reference overload is also required. I suppose it would be even more confusing than the current situation, which is already bad.Sanford
You may be interested by this article: cpptruths.blogspot.fr/2013/10/…Aitken
@JBJansen It can't be hacked around. I don't see exactly what that code is supposed to accomplish wrt initializer_list, but as the user you do not have the needed permissions to move from it. Safe code will not do so.Sanford
Yes you can hack it with mutable values used correctly. Such haking may be dangerous as forward_as_tuple is if not used correctly. May be you will be interested in this: #13957666Aitken
@Potatoswatter, late comment, but what's the status of the proposal. Is there any remote chance it may make it into C++20?Cigarillo
@Cigarillo I'm not so active in C++ lately (ISO or otherwise), but anything is possible. It's an open standard — if you want, you can promote the idea yourself! C++20 should certainly still be open to new ideas, since C++17 is yet to be ratified.Sanford
Has this proposal made any progress? I'm also fairly surprised that initializer lists force copies.Whipple
I've switched to using std::array<T, N>&& instead of std::initializer_list<T> in my code.Equal
@Sanford Though begin() and end() for initializer_list return const T *. Since the code is written as auto it = list.begin(), it is not const indeed, so I think bar(std::move(*it)); should be compiled. Where am I wrong? I am really confused now. Thanks a lot.Vaughnvaught
@Sanford Can you expand on "ownership is a superset of observation"? I don't think I understand this.Barre
@Vaughnvaught it's const T*, not T* constBo
S
28
bar(std::move(*it));   // kosher?

Not in the way that you intend. You cannot move a const object. And std::initializer_list only provides const access to its elements. So the type of it is const T *.

Your attempt to call std::move(*it) will only result in an l-value. IE: a copy.

std::initializer_list references static memory. That's what the class is for. You cannot move from static memory, because movement implies changing it. You can only copy from it.

Siccative answered 19/11, 2011 at 16:29 Comment(8)
A const xvalue is still an xvalue, and initializer_list references the stack if that is necessary. (If the contents are not constant, it is still thread-safe.)Sanford
@Potatoswatter: You cannot move from a constant object. The initializer_list object itself may be an xvalue, but it's contents (the actual array of values that it points to) are const, because those contents may be static values. You simply cannot move from the contents of an initializer_list.Siccative
See my answer and its discussion. He has moved the dereferenced iterator, producing a const xvalue. move might be meaningless, but it's legal and even possible to declare a parameter that accepts just that. If moving a particular type happens to be a no-op, it might even work correctly.Sanford
@Potatoswatter: The C++11 standard expends a lot of language ensuring that non-temporary objects are not actually moved unless you use std::move. This ensures that you can tell from inspection when a move operation happens, since it affects both the source and the destination (you don't want it to happen implicitly for named objects). Because of that, if you use std::move in a place where a move operation doesn't happen (and no actual movement will happen if you have a const xvalue), then the code is misleading. I think it's a mistake for std::move to be callable on a const object.Siccative
Maybe, but I'll still take fewer exceptions to the rules over the possibility of misleading code. Anyway, that is exactly why I answered "no" even though it's legal, and the result is an xvalue even if it will only bind as a const lvalue. To be honest, I've already had a brief flirtation with const && in a garbage-collected class with managed pointers, where everything relevant was mutable and moving moved the pointer management but didn't affect the contained value. There are always tricky edge cases :v) .Sanford
@NicolBolas So the type of it is const T *.. Sorry, could you please explain that in more detail for me? Though begin() and end() for initializer_list return const T *. Since the code is written as auto it = list.begin(), it is not const indeed, so I think bar(std::move(*it)); should be compiled. Where am I wrong? I am really confused now.Vaughnvaught
@John: "Since the code is written as auto it = list.begin(), it is not const indeed" Incorrect. auto will deduce whatever the type of the expression is. As pointed out, that type is const T*; the const is not optional. Therefore, that is what auto will deduce.Siccative
@NicolBolas As per https://mcmap.net/q/182074/-why-auto-i-same_const_variable-could-not-deduce-quot-const-quot, it seems that the deduction for auto would ignore const indeed, e.g.:const int const_num=0; const i=const_num;, i is int other than const int. And See this code snippet.Vaughnvaught
R
4

This won't work as stated, because list.begin() has type const T *, and there is no way you can move from a constant object. The language designers probably made that so in order to allow initializer lists to contain for instance string constants, from which it would be inappropriate to move.

However, if you are in a situation where you know that the initializer list contains rvalue expressions (or you want to force the user to write those) then there is a trick that will make it work (I was inspired by the answer by Sumant for this, but the solution is way simpler than that one). You need the elements stored in the initialiser list to be not T values, but values that encapsulate T&&. Then even if those values themselves are const qualified, they can still retrieve a modifiable rvalue.

template<typename T>
  class rref_capture
{
  T* ptr;
public:
  rref_capture(T&& x) : ptr(&x) {}
  operator T&& () const { return std::move(*ptr); } // restitute rvalue ref
};

Now instead of declaring an initializer_list<T> argument, you declare aninitializer_list<rref_capture<T> > argument. Here is a concrete example, involving a vector of std::unique_ptr<int> smart pointers, for which only move semantics is defined (so these objects themselves can never be stored in an initializer list); yet the initializer list below compiles without problem.

#include <memory>
#include <initializer_list>
class uptr_vec
{
  typedef std::unique_ptr<int> uptr; // move only type
  std::vector<uptr> data;
public:
  uptr_vec(uptr_vec&& v) : data(std::move(v.data)) {}
  uptr_vec(std::initializer_list<rref_capture<uptr> > l)
    : data(l.begin(),l.end())
  {}
  uptr_vec& operator=(const uptr_vec&) = delete;
  int operator[] (size_t index) const { return *data[index]; }
};

int main()
{
  std::unique_ptr<int> a(new int(3)), b(new int(1)),c(new int(4));
  uptr_vec v { std::move(a), std::move(b), std::move(c) };
  std::cout << v[0] << "," << v[1] << "," << v[2] << std::endl;
}

One question does need an answer: if the elements of the initializer list should be true prvalues (in the example they are xvalues), does the language ensure that the lifetime of the corresponding temporaries extends to the point where they are used? Frankly, I don't think the relevant section 8.5 of the standard addresses this issue at all. However, reading 1.9:10, it would seem that the relevant full-expression in all cases encompasses the use of the initializer list, so I think there is no danger of dangling rvalue references.

Recidivism answered 7/7, 2014 at 11:32 Comment(3)
String constants? Like "Hello world"? If you move from them, you just copy a pointer (or bind a reference).Mitchelmitchell
"One question does need an answer" The initializers inside {..} are bound to references in the function parameter of rref_capture. This does not extend their lifetime, they're still destroyed at the end of the full-expression in which they've been created.Mitchelmitchell
Per T.C.'s comment from another answer: If you have multiple overloads of the constructor, wrap the std::initializer_list<rref_capture<T>> in some transformation trait of your choosing - say, std::decay_t - to block unwanted deduction.Mckibben
M
2

I thought it might be instructive to offer a reasonable starting point for a workaround.

Comments inline.

#include <memory>
#include <vector>
#include <array>
#include <type_traits>
#include <algorithm>
#include <iterator>

template<class Array> struct maker;

// a maker which makes a std::vector
template<class T, class A>
struct maker<std::vector<T, A>>
{
  using result_type = std::vector<T, A>;

  template<class...Ts>
  auto operator()(Ts&&...ts) const -> result_type
  {
    result_type result;
    result.reserve(sizeof...(Ts));
    using expand = int[];
    void(expand {
      0,
      (result.push_back(std::forward<Ts>(ts)),0)...
    });

    return result;
  }
};

// a maker which makes std::array
template<class T, std::size_t N>
struct maker<std::array<T, N>>
{
  using result_type = std::array<T, N>;

  template<class...Ts>
  auto operator()(Ts&&...ts) const
  {
    return result_type { std::forward<Ts>(ts)... };
  }

};

//
// delegation function which selects the correct maker
//
template<class Array, class...Ts>
auto make(Ts&&...ts)
{
  auto m = maker<Array>();
  return m(std::forward<Ts>(ts)...);
}

// vectors and arrays of non-copyable types
using vt = std::vector<std::unique_ptr<int>>;
using at = std::array<std::unique_ptr<int>,2>;


int main(){
    // build an array, using make<> for consistency
    auto a = make<at>(std::make_unique<int>(10), std::make_unique<int>(20));

    // build a vector, using make<> because an initializer_list requires a copyable type  
    auto v = make<vt>(std::make_unique<int>(10), std::make_unique<int>(20));
}
Manlove answered 1/6, 2017 at 12:36 Comment(5)
The question was if an initializer_list can be moved from, not whether anyone had workarounds. Besides, the main selling point of initializer_list is that it is only templated on the element type, not the number of elements, and therefore does not require recipients to also be templated - and this completely loses that.Curvaceous
@Curvaceous you're absolutely right. I take the view that sharing knowledge related to the question is a good thing in itself. In this case, perhaps it helped the OP and perhaps it didn't - he didn't respond. More often than not however, the OP and others welcome extra material related to the question.Manlove
Sure, it may indeed help for readers who want something like initializer_list but aren't subject to all the constraints that make it useful. :)Curvaceous
@Curvaceous which of the constraints have I overlooked?Manlove
All I mean is that initializer_list (via compiler magic) avoids having to template functions on the number of elements, something that is inherently required by alternatives based on arrays and/or variadic functions, thus constraining the range of cases where the latter are usable. By my understanding, this is precisely one of the main rationales for having initializer_list, so it seemed worth mentioning.Curvaceous
G
1

Instead of using a std::initializer_list<T>, you can declare your argument as an array rvalue reference:

template <typename T>
void bar(T &&value);

template <typename T, size_t N>
void foo(T (&&list)[N] ) {
   std::for_each(std::make_move_iterator(std::begin(list)),
                 std::make_move_iterator(std::end(list)),
                 &bar);
}

void baz() {
   foo({std::make_unique<int>(0), std::make_unique<int>(1)});
}

See example using std::unique_ptr<int>: https://gcc.godbolt.org/z/2uNxv6

Gasaway answered 2/6, 2020 at 11:42 Comment(1)
Sadly this seems to break the A{a, b, c} syntax, requiring A({a, b, c}) instead to work.Spiry
N
0

It seems not allowed in the current standard as already answered. Here is another workaround to achieve something similar, by defining the function as variadic instead of taking an initializer list.

#include <vector>
#include <utility>

// begin helper functions

template <typename T>
void add_to_vector(std::vector<T>* vec) {}

template <typename T, typename... Args>
void add_to_vector(std::vector<T>* vec, T&& car, Args&&... cdr) {
  vec->push_back(std::forward<T>(car));
  add_to_vector(vec, std::forward<Args>(cdr)...);
}

template <typename T, typename... Args>
std::vector<T> make_vector(Args&&... args) {
  std::vector<T> result;
  add_to_vector(&result, std::forward<Args>(args)...);
  return result;
}

// end helper functions

struct S {
  S(int) {}
  S(S&&) {}
};

void bar(S&& s) {}

template <typename T, typename... Args>
void foo(Args&&... args) {
  std::vector<T> args_vec = make_vector<T>(std::forward<Args>(args)...);
  for (auto& arg : args_vec) {
    bar(std::move(arg));
  }
}

int main() {
  foo<S>(S(1), S(2), S(3));
  return 0;
}

Variadic templates can handle r-value references appropriately, unlike initializer_list.

In this example code, I used a set of small helper functions to convert the variadic arguments into a vector, to make it similar to the original code. But of course you can write a recursive function with variadic templates directly instead.

Nonsmoker answered 26/3, 2017 at 4:47 Comment(1)
The question was if an initializer_list can be moved from, not whether anyone had workarounds. Besides, the main selling point of initializer_list is that it is only templated on the element type, not the number of elements, and therefore does not require recipients to also be templated - and this completely loses that.Curvaceous
R
0

I have a much simpler implementation that makes use of a wrapper class which acts as a tag to mark the intention of moving the elements. This is a compile-time cost.

The wrapper class is designed to be used in the way std::move is used, just replace std::move with move_wrapper, but this requires C++17. For older specs, you can use an additional builder method.

You'll need to write builder methods/constructors that accept wrapper classes inside initializer_list and move the elements accordingly.

If you need some elements to be copied instead of being moved, construct a copy before passing it to initializer_list.

The code should be self-documented.

#include <iostream>
#include <vector>
#include <initializer_list>

using namespace std;

template <typename T>
struct move_wrapper {
    T && t;

    move_wrapper(T && t) : t(move(t)) { // since it's just a wrapper for rvalues
    }

    explicit move_wrapper(T & t) : t(move(t)) { // acts as std::move
    }
};

struct Foo {
    int x;

    Foo(int x) : x(x) {
        cout << "Foo(" << x << ")\n";
    }

    Foo(Foo const & other) : x(other.x) {
        cout << "copy Foo(" << x << ")\n";
    }

    Foo(Foo && other) : x(other.x) {
        cout << "move Foo(" << x << ")\n";
    }
};

template <typename T>
struct Vec {
    vector<T> v;

    Vec(initializer_list<T> il) : v(il) {
    }

    Vec(initializer_list<move_wrapper<T>> il) {
        v.reserve(il.size());
        for (move_wrapper<T> const & w : il) {
            v.emplace_back(move(w.t));
        }
    }
};

int main() {
    Foo x{1}; // Foo(1)
    Foo y{2}; // Foo(2)

    Vec<Foo> v{Foo{3}, move_wrapper(x), Foo{y}}; // I want y to be copied
    // Foo(3)
    // copy Foo(2)
    // move Foo(3)
    // move Foo(1)
    // move Foo(2)
}
Rearward answered 10/7, 2019 at 17:7 Comment(0)
P
-1

Consider the in<T> idiom described on cpptruths. The idea is to determine lvalue/rvalue at run-time and then call move or copy-construction. in<T> will detect rvalue/lvalue even though the standard interface provided by initializer_list is const reference.

Pestilence answered 18/9, 2013 at 18:27 Comment(4)
Why on earth would you want to determine the value category at runtime when the compiler already knows it?Ramon
Please read the blog and leave me a comment if you disagree or have a better alternative. Even if the compiler knows the value category, initializer_list does not preserve it because it has only const iterators. So you need to "capture" the value category when you construct the initializer_list and pass it through so the function can make use of it as it pleases.Pestilence
This answer is basically useless without following the link, and SO answers should be useful without following links.Ledge
@Pestilence [copying my comment from an identical post elsewhere] Does that humungous mess actually provide any measurable benefits to performance or memory usage, and if so, a sufficiently large amount of such benefits to adequately offset how terrible it looks and the fact that it takes about an hour to figure out what it's trying to do? I kinda doubt it.Curvaceous

© 2022 - 2024 — McMap. All rights reserved.