std::forwar...::operator=(3)

✨ NAME ✨

okay bestie, welcome to std::forwar...::operator=(3), straight out of the C++ Standard Libary manual. The page name is std::forward_list::operator= — as in std::forward_list::operator= — and it’s the assignment operator for std::forward_list. It replaces the contents of the container, no cap.

---

🌸 SYNOPSIS 🌸

Three overloads, all doing the “replace my whole contents” thing. Vibe check:

forward_list& operator=( const forward_list& other );                      (1) (since C++11)
forward_list& operator=( forward_list&& other );                           (2) (since C++11) (until C++17)
forward_list& operator=( forward_list&& other ) noexcept(/* see below */); (2) (since C++17)
forward_list& operator=( std::initializer_list<value_type> ilist );        (3) (since C++11)

Replaces the contents of the container.

1. (1) Copy assignment operator. Replaces the contents with a copy of the contents of other. If std::allocator_traits<allocator_type>::propagate_on_container_copy_assignment::value is true, the allocator of *this is replaced by a copy of other. If the allocator of *this after assignment would compare unequal to its old value, the old allocator is used to deallocate the memory, then the new allocator is used to allocate it before copying the elements. Otherwise, the memory owned by *this may be reused when possible. In any case, the elements originally belonging to *this may be either destroyed or replaced by element-wise copy-assignment.
2. (2) Move assignment operator. Replaces the contents with those of other using move semantics (i.e. the data in other is moved from other into this container). other is in a valid but unspecified state afterwards. If std::allocator_traits<allocator_type>::propagate_on_container_move_assignment::value is true, the allocator of *this is replaced by a copy of that of other. If it is false and the allocators of *this and other do not compare equal, *this cannot take ownership of the memory owned by other and must move-assign each element individually, allocating additional memory using its own allocator as needed. In any case, all elements originally belonging to *this are either destroyed or replaced by element-wise move-assignment.
3. (3) Replaces the contents with those identified by initializer list ilist.

---

🎀 PARAMETERS 🎀

• other — another container to use as data source
• ilist — initializer list to use as data source

---

💖 RETURN VALUE 💖

*this periodt — that’s the whole return value, bestie.

---

🦋 COMPLEXITY 🦋

1. Linear in the size of *this and other.
2. Linear in the size of *this unless the allocators do not compare equal and do not propagate, in which case linear in the size of *this and other.
3. Linear in the size of *this and ilist.

---

🔥 EXCEPTIONS 🔥

• (until C++17) 1-3) May throw implementation-defined exceptions.
• (since C++17) 1,3) May throw implementation-defined exceptions.
• (since C++17) For overload 2) the noexcept specification is: noexcept(std::allocator_traits<Allocator>::is_always_equal::value)

---

🧚 NOTES 🧚

After container move assignment (overload (2)), unless element-wise move assignment is forced by incompatible allocators, references, pointers, and iterators (other than the end iterator) to other remain valid, but refer to elements that are now in *this. The current standard makes this guarantee via the blanket statement in [container.reqmts]/67, and a more direct guarantee is under consideration via LWG issue 2321.

---

⭐ EXAMPLE ⭐

The following code uses operator= to assign one std::forward_list to another:

// Run this code

#include <initializer_list>
#include <iostream>
#include <iterator>
#include <forward_list>

void print(auto const comment, auto const& container)
{
    auto size = std::ranges::distance(container);
    std::cout << comment << "{ ";
    for (auto const& element : container)
        std::cout << element << (--size ? ", " : " ");
    std::cout << "}\n";
}

int main()
{
    std::forward_list<int> x{1, 2, 3}, y, z;
    const auto w = {4, 5, 6, 7};

    std::cout << "Initially:\n";
    print("x = ", x);
    print("y = ", y);
    print("z = ", z);

    std::cout << "Copy assignment copies data from x to y:\n";
    y = x;
    print("x = ", x);
    print("y = ", y);

    std::cout << "Move assignment moves data from x to z, modifying both x and z:\n";
    z = std::move(x);
    print("x = ", x);
    print("z = ", z);

    std::cout << "Assignment of initializer_list w to z:\n";
    z = w;
    print("w = ", w);
    print("z = ", z);
}

Output

Initially:
x = { 1, 2, 3 }
y = { }
z = { }
Copy assignment copies data from x to y:
x = { 1, 2, 3 }
y = { 1, 2, 3 }
Move assignment moves data from x to z, modifying both x and z:
x = { }
z = { 1, 2, 3 }
Assignment of initializer_list w to z:
w = { 4, 5, 6, 7 }
z = { 4, 5, 6, 7 }

---

👑 SEE ALSO 👑

• constructor — constructs the forward_list (public member function)
• assign — assigns values to the container (public member function)

---

💅 CATEGORY 💅

Category: * conditionally noexcept

---

and that’s the whole page, bestie — source is http://cppreference.com, date/version is 2024.06.10, and the page is std::forwar...::operator=(3) 💖✨🎀