Namensräume
Varianten
Aktionen

std::ranges::borrowed_range, std::ranges::enable_borrowed_range

Von cppreference.com
< cpp‎ | ranges
 
 
Bereichsbibliothek
Range-Adaptoren
 
Definiert in der Header-Datei <ranges>
template< class R >

concept borrowed_range =
    ranges::range<R> &&
    (std::is_lvalue_reference_v<R> ||

     ranges::enable_borrowed_range<std::remove_cvref_t<R>>);
(1) (seit C++20)
template< class R >
constexpr bool enable_borrowed_range = false;
(2) (seit C++20)
1) Das Konzept borrowed_range definiert die Anforderungen an einen Bereich, sodass eine Funktion ihn per Wert übernehmen und daraus abgeleitete Iteratoren gefahrlos zurückgeben kann, ohne dass diese ungültig werden.
2) Das Variablen-Template enable_borrowed_range wird verwendet, um anzuzeigen, ob ein range ein borrowed_range ist. Die primäre Template ist als false definiert.

Inhalt

[bearbeiten] Semantische Anforderungen

Sei U std::remove_reference_t<T>, wenn T ein rvalue-Referenztyp ist, andernfalls T. Bei einer Variablen u vom Typ U modelliert T borrowed_range nur dann, wenn die Gültigkeit von von u abgeleiteten Iteratoren nicht an die Lebensdauer dieser Variablen gebunden ist.

[bearbeiten] Spezialisierungen

Ein Programm darf enable_borrowed_range für cv-unqualifizierte benutzerdefinierte Typen, die borrowed_range modellieren, zu true und für Typen, die dies nicht tun, zu false spezialisieren. Solche Spezialisierungen müssen in Konstanten Ausdrücken verwendbar sein und den Typ const bool haben.

[bearbeiten] Bedingungslos geliehene Bereiche in der Standardbibliothek

Spezialisierungen von enable_borrowed_range für alle Spezialisierungen der folgenden Standard-Templates sind als true definiert:

[bearbeiten] Bedingt geliehene Bereiche in der Standardbibliothek

Spezialisierungen von enable_borrowed_range für die folgenden Standard-Bereichsadapter sind genau dann als true definiert, wenn std::ranges::enable_borrowed_range<V> true ist, wobei V der zugrundeliegende View-Typ ist.

(seit C++23)
(seit C++23)
(seit C++23)
(seit C++26)
  1. Der zugrundeliegende View V muss auch forward_range erfüllen.

Spezialisierungen von enable_borrowed_range für die folgenden Standard-Bereichsadapter sind genau dann als true definiert, wenn (std::ranges::enable_borrowed_range<Vs> && ...) true ist, wobei Vs... alle View-Typen sind, die sie adaptieren.

(seit C++23)

[bearbeiten] Beispiel

Demonstriert die Spezialisierungen von enable_borrowed_range für benutzerdefinierte Typen. Solche Spezialisierungen schützen vor potenziell ungültigen Ergebnissen.

#include <algorithm>
#include <array>
#include <cstddef>
#include <iostream>
#include <ranges>
#include <span>
#include <type_traits>
 
template<typename T, std::size_t N>
struct MyRange : std::array<T, N> {};
 
template<typename T, std::size_t N>
constexpr bool std::ranges::enable_borrowed_range<MyRange<T, N>> = false;
 
template<typename T, std::size_t N>
struct MyBorrowedRange : std::span<T, N> {};
 
template<typename T, std::size_t N>
constexpr bool std::ranges::enable_borrowed_range<MyBorrowedRange<T, N>> = true;
 
int main()
{
    static_assert(std::ranges::range<MyRange<int, 8>>);
    static_assert(std::ranges::borrowed_range<MyRange<int, 8>> == false);
    static_assert(std::ranges::range<MyBorrowedRange<int, 8>>);
    static_assert(std::ranges::borrowed_range<MyBorrowedRange<int, 8>> == true);
 
    auto getMyRangeByValue = []{ return MyRange<int, 4>{{1, 2, 42, 3}}; };
    auto dangling_iter = std::ranges::max_element(getMyRangeByValue());
    static_assert(std::is_same_v<std::ranges::dangling, decltype(dangling_iter)>);
    // *dangling_iter; // compilation error (i.e. dangling protection works.)
 
    auto my = MyRange<int, 4>{{1, 2, 42, 3}};
    auto valid_iter = std::ranges::max_element(my);
    std::cout << *valid_iter << ' '; // OK: 42
 
    auto getMyBorrowedRangeByValue = []
    {
        static int sa[4]{1, 2, 42, 3};
        return MyBorrowedRange<int, std::size(sa)>{sa};
    };
    auto valid_iter2 = std::ranges::max_element(getMyBorrowedRangeByValue());
    std::cout << *valid_iter2 << '\n'; // OK: 42
}

Ausgabe

42 42

[bearbeiten] Siehe auch

ein Platzhaltertyp, der anzeigt, dass ein Iterator oder ein subrange nicht zurückgegeben werden sollte, da er hängen würde
(Klasse) [edit]