When should I declare my function as:
void foo(Widget w);
as opposed to
void foo(Widget&& w);
?
Assume this is the only overload (as in, I pick one or the other, not both, and no other overloads). No templates involved. Assume that the function foo
requires ownership of the Widget
(e.g. const Widget&
is not part of this discussion). I'm not interested in any answer outside the scope of these circumstances. See addendum at end of post for why these constraints are part of the question.
The primary difference that my colleagues and I can come up with is that the rvalue reference parameter forces you to be explicit about copies. The caller is responsible for making an explicit copy and then passing it in with std::move
when you want a copy. In the pass by value case, the cost of the copy is hidden:
//If foo is a pass by value function, calling + making a copy: Widget x{}; foo(x); //Implicit copy //Not shown: continues to use x locally //If foo is a pass by rvalue reference function, calling + making a copy: Widget x{}; //foo(x); //This would be a compiler error auto copy = x; //Explicit copy foo(std::move(copy)); //Not shown: continues to use x locally
Other than that difference. Other than forcing people to be explicit about copying and changing how much syntactic sugar you get when calling the function, how else are these different? What do they say differently about the interface? Are they more or less efficient than one another?
Other things that my colleagues and I have already thought of:
Addendum: why am I constraining this problem so much?
foo
requires ownership of Widget
(aka no const Widget&
) - We're not talking about read-only functions. If the function was read-only or didn't need to own or extend the lifetime of the Widget
, then the answer trivially becomes const Widget&
, which again, is well known, and not interesting. I also refer you to why we don't want to talk about overloads.Pass-by-references is more efficient than pass-by-value, because it does not copy the arguments. The formal parameter is an alias for the argument. When the called function read or write the formal parameter, it is actually read or write the argument itself.
Unlike in C, where passing by reference was really just passing a pointer by value, in C++ we can genuinely pass by reference.
Lvalues and rvalues are fundamental to C++ expressions. Put simply, an lvalue is an object reference and an rvalue is a value. The difference between lvalues and rvalues plays a role in the writing and understanding of expressions.
Explanation: If you pass an lvalue T to enqueue , U will deduce to T& , and the forward will pass it along as an lvalue, and you'll get the copy behavior you want. If you pass an rvalue T to enqueue , U will deduce to T , and the forward will pass it along as an rvalue, and you'll get the move behavior you want.
What do rvalue usages say about an interface versus copying? rvalue suggests to the caller that the function both wants to own the value and has no intention of letting the caller know of any changes it has made. Consider the following (I know you said no lvalue references in your example, but bear with me):
//Hello. I want my own local copy of your Widget that I will manipulate, //but I don't want my changes to affect the one you have. I may or may not //hold onto it for later, but that's none of your business. void foo(Widget w); //Hello. I want to take your Widget and play with it. It may be in a //different state than when you gave it to me, but it'll still be yours //when I'm finished. Trust me! void foo(Widget& w); //Hello. Can I see that Widget of yours? I don't want to mess with it; //I just want to check something out on it. Read that one value from it, //or observe what state it's in. I won't touch it and I won't keep it. void foo(const Widget& w); //Hello. Ooh, I like that Widget you have. You're not going to use it //anymore, are you? Please just give it to me. Thank you! It's my //responsibility now, so don't worry about it anymore, m'kay? void foo(Widget&& w);
For another way of looking at it:
//Here, let me buy you a new car just like mine. I don't care if you wreck //it or give it a new paint job; you have yours and I have mine. void foo(Car c); //Here are the keys to my car. I understand that it may come back... //not quite the same... as I lent it to you, but I'm okay with that. void foo(Car& c); //Here are the keys to my car as long as you promise to not give it a //paint job or anything like that void foo(const Car& c); //I don't need my car anymore, so I'm signing the title over to you now. //Happy birthday! void foo(Car&& c);
Now, if Widgets have to remain unique (as actual widgets in, say, GTK do) then the first option cannot work. The second, third and fourth options make sense, because there's still only one real representation of the data. Anyway, that's what those semantics say to me when I see them in code.
Now, as for efficiency: it depends. rvalue references can save a lot of time if Widget has a pointer to a data member whose pointed-to contents can be rather large (think an array). Since the caller used an rvalue, they're saying they don't care about what they're giving you anymore. So, if you want to move the caller's Widget's contents into your Widget, just take their pointer. No need to meticulously copy each element in the data structure their pointer points to. This can lead to pretty good improvements in speed (again, think arrays). But if the Widget class doesn't have any such thing, this benefit is nowhere to be seen.
Hopefully that gets at what you were asking; if not, I can perhaps expand/clarify things.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With