When should I return by value, as opposed to returning a unique pointer

Question

What I'm wondering is, how does returning by value a Cat actually differ from returning an std::unique_ptr<Cat> in terms of passing them around, memory management and using them in practice.

Memory management wise, aren't they the same? As both a returned by value object and an object wrapped in a unique_ptr will have their destructors triggered once they go out of scope?

So, how would you compare both pieces of code:

Cat catFactory(string catName) {
    return Cat(catName);
}

std::unique_ptr<Cat> catFactory(string catName) {
    return std::unique_ptr(new Cat(catName));
}

Answer 1

Returning by value should be considered the default. (*) Deviating from the default practice, by returning std::unique_ptr<Cat>, should require justification.

There are three main reasons to return a pointer:

1. Polymorphism. This is the best reason to return std::unique_ptr<Cat> instead of Cat: that you might actually be creating an object of a type derived from Cat. If you need this polymorphism, you absolutely need to return a pointer of some sort. This is why factory functions usually return pointers.

2. Cat cannot be moved cheaply or cannot be moved at all. "Inherently" unmovable types are rare; you should usually try to fix Cat by making it cheaply movable. But of course Cat could be a type owned by someone else, to which you cannot add a move constructor (or perhaps even a copy constructor). In that case, there is not much you can do other than use unique_ptr (and complain to the owner).

3. The function has the potential to fail and be unable to construct any valid Cat. In that case, one possibility is return by value anyway but throw an exception if the Cat cannot be constructed; the other, in C++11/C++14, is to make the function return std::unique_ptr<Cat> and have it return a null pointer when no Cat can be constructed. In C++17, however, you should start returning std::optional<Cat> instead of std::unique_ptr<Cat> in that case, to avoid unnecessary heap allocation.

(*) This also applies to passing objects when the function being called needs its own copy of the value, e.g., a constructor that will initialize a class member from one of its arguments. Accept the object by value and move.

Answer 2

Memory-management wise they are completely different.

Sure, these days the actual functional difference between these trivial examples is pretty slim, assuming move semantics can make that by-value return cheap (in the second example they're responsible for moving the pointer, instead). And, sure, both objects will be destroyed at the same time if you just let everything go out of scope right away.

But the code is far less simple with the dynamic allocation, and adds a "why?" factor.

You can't really rationalise about the difference any further without inspecting how the result is going to be used after the function returns. Then all the typical considerations about automatic vs dynamic memory allocation come back into play.

In conclusion, there's really no generic, catch-all way to tell you whether a factory should dynamically-allocate or return by value. However, personally I would prefer the latter for simplicity (unless you know that you can't), especially if your object types are typically moveable (which likely won't have much effect in the function itself due to RVO, but may help you at the callsite).

Answer 3

By default, return by value.

Exceptions to this rule:

1. The Cat needs to exist on the heap, so as to outlast the code triggering its creation... but in this case perhaps it shouldn't really be a unique_ptr that's returned, but rather a shared_ptr.
2. You're not actually constructing the Cat but rather getting access to something which can be interpreted as a Cat; in this case, again, you probably don't want a unique pointer but a regular one (or a unique pointer with a custom deleter).
3. Polymorphism - if it's a factory and Cat is one of its products, you can probably also make a Dog and a Horse, all being Animals, so you'll return a pointer to an Animal. That's definitely a case where you would use a unique pointer.
4. Dark voodoo in your copy, assignment and/or move constructors which makes it important to always make sure you only poke your Cat from afar.

I disagree with @Brian's answer regarding two of the exceptions he suggests:

• I would suggest not to use a pointer return type so as to be able to indicate failure by returning nullptr. Failing to return a valid value is what exceptions are for, and even if you want to avoid them - I'd suggest returning an std::expected (with C++23) or std::optional (earlier C++ versions). Or just throwing an exception on failure if you're allowed to do that.
• You usually don't need a move constructor for return value optimization to kick in - so the lack of a move constructor should not be a reason to return a pointer.