Namensräume
Varianten
Aktionen

std::optional<T>::transform

Von cppreference.com
< cpp‎ | utility‎ | optional
 
 
Dienstprogramm-Bibliotheken
Sprachunterstützung
Typunterstützung (Basistypen, RTTI)
Bibliotheks-Feature-Test-Makros (C++20)
Programm-Dienstprogramme
Variadische Funktionen
Coroutine-Unterstützung (C++20)
Vertragsunterstützung (C++26)
Drei-Wege-Vergleich
(C++20)
(C++20)(C++20)(C++20)  
(C++20)(C++20)(C++20)

Allgemeine Hilfsmittel
Relationale Operatoren (in C++20 veraltet)
 
 
template< class F >
constexpr auto transform( F&& f ) &;
(1) (seit C++23)
template< class F >
constexpr auto transform( F&& f ) const&;
(2) (seit C++23)
template< class F >
constexpr auto transform( F&& f ) &&;
(3) (seit C++23)
template< class F >
constexpr auto transform( F&& f ) const&&;
(4) (seit C++23)

Wenn *this einen Wert enthält, wird f mit dem enthaltenen Wert als Argument aufgerufen, und es wird ein std::optional zurückgegeben, das das Ergebnis dieses Aufrufs enthält; andernfalls wird ein leeres std::optional zurückgegeben.

Der Typ des enthaltenen Werts im Ergebnis (im Folgenden als U bezeichnet) muss ein Nicht-Array-Objekttyp sein und darf nicht std::in_place_t oder std::nullopt_t sein. Andernfalls ist das Programm schlecht formuliert.

1) Sei U std::remove_cv_t<std::invoke_result_t<F, T&>>. Wenn *this einen Wert enthält, wird ein std::optional<U> zurückgegeben, dessen enthaltener Wert durch direkte Initialisierung aus std::invoke(std::forward<F>(f), **this) initialisiert wird (im Gegensatz zu and_then(), das direkt ein std::optional zurückgeben muss). Andernfalls wird ein leeres std::optional<U> zurückgegeben.
Das Programm ist schlecht formuliert, wenn die Variablendefinition U x(std::invoke(std::forward<F>(f), **this)); schlecht formuliert ist.
2) Gleiches wie in (1), außer dass U std::remove_cv_t<std::invoke_result_t<F, const T&>> ist.
3) Sei U std::remove_cv_t<std::invoke_result_t<F, T>>. Wenn *this einen Wert enthält, wird ein std::optional<U> zurückgegeben, dessen enthaltener Wert durch direkte Initialisierung aus std::invoke(std::forward<F>(f), std::move(**this)) initialisiert wird. Andernfalls wird ein leeres std::optional<U> zurückgegeben.
Das Programm ist schlecht formuliert, wenn die Variablendefinition U x(std::invoke(std::forward<F>(f), std::move(**this))); schlecht formuliert ist.
4) Gleiches wie in (3), außer dass U std::remove_cv_t<std::invoke_result_t<F, const T>> ist.

Inhalt

[edit] Parameter

f - ein geeignetes aufrufbares Objekt oder eine geeignete Callable, dessen Aufrufsignatur einen Nicht-Referenztyp zurückgibt

[edit] Rückgabewert

Ein std::optional, das das Ergebnis von f enthält, oder ein leeres std::optional, wie oben beschrieben.

[edit] Hinweise

Da transform ein U-Objekt direkt am richtigen Ort konstruiert, anstatt es an einen Konstruktor zu übergeben, kann std::is_move_constructible_v<U> false sein.

Da der aufrufbare Parameter f keinen Referenztyp zurückgeben kann, kann er kein Zeiger auf ein Datenelement sein.

Einige Sprachen nennen diese Operation map.

Feature-Test-Makro Wert Std Feature
__cpp_lib_optional 202110L (C++23) Monadische Operationen in std::optional

[edit] Beispiel

#include <iostream>
#include <optional>
 
struct A { /* ... */ };
struct B { /* ... */ };
struct C { /* ... */ };
struct D { /* ... */ };
 
auto A_to_B(A) -> B { /* ... */ std::cout << "A => B \n"; return {}; }
auto B_to_C(B) -> C { /* ... */ std::cout << "B => C \n"; return {}; }
auto C_to_D(C) -> D { /* ... */ std::cout << "C => D \n"; return {}; }
 
void try_transform_A_to_D(std::optional<A> o_A)
{
    std::cout << (o_A ? "o_A has a value\n" : "o_A is empty\n");
 
    std::optional<D> o_D = o_A.transform(A_to_B)
                              .transform(B_to_C)
                              .transform(C_to_D);
 
    std::cout << (o_D ? "o_D has a value\n\n" : "o_D is empty\n\n");
};
 
int main()
{
    try_transform_A_to_D( A{} );
    try_transform_A_to_D( {} );
}

Ausgabe

o_A has a value
A => B
B => C
C => D
o_D has a value
 
o_A is empty
o_D is empty

[edit] Siehe auch

gibt den enthaltenen Wert zurück, falls vorhanden, sonst einen anderen Wert
(public member function) [edit]
(C++23)
gibt das Ergebnis der gegebenen Funktion auf dem enthaltenen Wert zurück, falls dieser existiert, andernfalls ein leeres optional
(public member function) [edit]
(C++23)
gibt das optional selbst zurück, wenn es einen Wert enthält, andernfalls das Ergebnis der gegebenen Funktion
(public member function) [edit]