std::ranges:: contains, std::ranges:: contains_subrange

From cppreference.net

Definiert im Header `<algorithm>`
Aufrufsignatur
	(1)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T, class Proj = std:: identity > requires std:: indirect_binary_predicate < ranges:: equal_to , std :: projected < I, Proj > , const T * > constexpr bool contains ( I first, S last, const T & value, Proj proj = { } ) ;			(seit C++23) (bis C++26)
template < std:: input_iterator I, std:: sentinel_for < I > S, class Proj = std:: identity , class T = std :: projected_value_t < I, Proj > > requires std:: indirect_binary_predicate < ranges:: equal_to , std :: projected < I, Proj > , const T * > constexpr bool contains ( I first, S last, const T & value, Proj proj = { } ) ;			(seit C++26)
		(2)
template < ranges:: input_range R, class T, class Proj = std:: identity > requires std:: indirect_binary_predicate < ranges:: equal_to , std :: projected < ranges:: iterator_t < R > , Proj > , const T * > constexpr bool contains ( R && r, const T & value, Proj proj = { } ) ;				(seit C++23) (bis C++26)
template < ranges:: input_range R, class Proj = std:: identity , class T = std :: projected_value_t < ranges:: iterator_t < R > , Proj > > requires std:: indirect_binary_predicate < ranges:: equal_to , std :: projected < ranges:: iterator_t < R > , Proj > , const T * > constexpr bool contains ( R && r, const T & value, Proj proj = { } ) ;				(seit C++26)
template < std:: forward_iterator I1, std:: sentinel_for < I1 > S1, std:: forward_iterator I2, std:: sentinel_for < I2 > S2, class Pred = ranges:: equal_to , class Proj1 = std:: identity , class Proj2 = std:: identity > requires std:: indirectly_comparable < I1, I2, Pred, Proj1, Proj2 > constexpr bool contains_subrange ( I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = { } , Proj1 proj1 = { } , Proj2 proj2 = { } ) ;			(3)	(seit C++23)
template < ranges:: forward_range R1, ranges:: forward_range R2, class Pred = ranges:: equal_to , class Proj1 = std:: identity , class Proj2 = std:: identity > requires std:: indirectly_comparable < ranges:: iterator_t < R1 > , ranges:: iterator_t < R2 > , Pred, Proj1, Proj2 > constexpr bool contains_subrange ( R1 && r1, R2 && r2, Pred pred = { } , Proj1 proj1 = { } , Proj2 proj2 = { } ) ;			(4)	(seit C++23)

1,2) Überprüft, ob ein gegebener Bereich den Wert value enthält oder nicht.

1) Der Quellbereich ist

first

last

2) Der Quellbereich ist

ranges:: begin ( r )

ranges:: end ( r )

3) Überprüft, ob ein gegebener Bereich ein Teilbereich eines anderen Bereichs ist.

3) Der erste Quellbereich ist

first1

last1

, und der zweite Quellbereich ist

first2

last2

4) Der erste Quellbereich ist

ranges:: begin ( r1 )

ranges:: end ( r1 )

, und der zweite Quellbereich ist

ranges:: begin ( r2 )

ranges:: end ( r2 )

Die auf dieser Seite beschriebenen funktionsähnlichen Entitäten sind Algorithm Function Objects (informell bekannt als Niebloids ), das heißt:

Explizite Template-Argumentlisten können beim Aufruf keiner von ihnen angegeben werden.
Keiner von ihnen ist sichtbar für argument-dependent lookup .
Wenn einer von ihnen durch normal unqualified lookup als Name links vom Funktionsaufrufoperator gefunden wird, wird argument-dependent lookup unterdrückt.

Inhaltsverzeichnis

Parameter

first, last	-	das Iterator-Sentinel-Paar, das den Bereich der zu untersuchenden Elemente definiert
r	-	der Bereich der zu untersuchenden Elemente
value	-	Wert, mit dem die Elemente verglichen werden
pred	-	Prädikat, das auf die projizierten Elemente angewendet wird
proj	-	Projektion, die auf die Elemente angewendet wird

Rückgabewert

1) ranges:: find ( std :: move ( first ) , last, value, proj ) ! = last

2) ranges:: find ( std :: move ( ranges:: begin ( r ) ) , ranges:: end ( r ) , Wert, Proj ) ! = ranges:: end ( r )

3) first2 == last2 || ! ranges:: search ( first1, last1, first2, last2, pred, proj1, proj2 ) . empty ( )

4) ranges:: begin ( r2 ) == ranges:: end ( r2 ) ||
! ranges:: search ( ranges:: begin ( r1 ) , ranges:: end ( r1 ) ,
ranges:: begin ( r2 ) , ranges:: end ( r2 ) , pred, proj1, proj2 ) . empty ( )

Komplexität

1) Höchstens ranges:: distance ( first, last ) Vergleiche.

2) Höchstens ranges:: distance ( r ) Vergleiche.

3) Höchstens ranges:: distance ( first1, last1 ) * ranges:: distance ( first2, last2 ) Vergleiche.

4) Höchstens ranges:: distance ( r1 ) * ranges:: distance ( r2 ) Vergleiche.

Hinweise

In C++20 kann man eine contains -Funktion mit ranges:: find ( haystack, needle ) ! = ranges:: end ( haystack ) oder contains_subrange mit ! ranges:: search ( haystack, needle ) . empty ( ) implementieren.

ranges::contains_subrange , ähnlich wie ranges::search , und im Gegensatz zu std::search , bietet keine Unterstützung für Searcher (wie std::boyer_moore_searcher ).

Feature-Test Makro	Wert	Std	Funktion
`__cpp_lib_ranges_contains`	`202207L`	(C++23)	`ranges::contains` und `ranges::contains_subrange`
`__cpp_lib_algorithm_default_value_type`	`202403L`	(C++26)	Listeninitialisierung für Algorithmen ( 1,2 )

Mögliche Implementierung

enthält (1,2)

struct __contains_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S,
             class Proj = std::identity,
             class T = std::projected_value_t<I, Proj>>
    requires std::indirect_binary_predicate<ranges::equal_to, std::projected<I, Proj>,
                                            const T*>
    constexpr bool operator()(I first, S last, const T& value, Proj proj = {}) const
    {
        return ranges::find(std::move(first), last, value, proj) != last;
    }
    template<ranges::input_range R,
             class Proj = std::identity,
             class T = std::projected_value_t<ranges::iterator_t<R>, Proj>>
    requires std::indirect_binary_predicate<ranges::equal_to,
                                            std::projected<ranges::iterator_t<R>, Proj>,
                                            const T*>
    constexpr bool operator()(R&& r, const T& value, Proj proj = {}) const
    {
        return ranges::find(std::move(ranges::begin(r)),
                            ranges::end(r), value, proj) != ranges::end(r);
    }
};
inline constexpr __contains_fn contains{};

contains_subrange (3,4)

struct __contains_subrange_fn
{
    template<std::forward_iterator I1, std::sentinel_for<I1> S1,
             std::forward_iterator I2, std::sentinel_for<I2> S2,
             class Pred = ranges::equal_to,
             class Proj1 = std::identity, class Proj2 = std::identity>
    requires std::indirectly_comparable<I1, I2, Pred, Proj1, Proj2>
    constexpr bool operator()(I1 first1, S1 last1, I2 first2, S2 last2, Pred pred = {},
                              Proj1 proj1 = {}, Proj2 proj2 = {}) const
    {
        return (first2 == last2) ||
                   !ranges::search(first1, last1, first2, last2,
                                   pred, proj1, proj2).empty();
    }
    template<ranges::forward_range R1, ranges::forward_range R2,
             class Pred = ranges::equal_to,
             class Proj1 = std::identity, class Proj2 = std::identity>
    requires std::indirectly_comparable<ranges::iterator_t<R1>,
                                        ranges::iterator_t<R2>, Pred, Proj1, Proj2>
    constexpr bool operator()(R1&& r1, R2&& r2, Pred pred = {},
                              Proj1 proj1 = {}, Proj2 proj2 = {}) const
    {
        return (first2 == last2) ||
                   !ranges::search(ranges::begin(r1), ranges::end(r1),
                                   ranges::begin(r2), ranges::end(r2),
                                   pred, proj1, proj2).empty();
    }
};
inline constexpr __contains_subrange_fn contains_subrange{};

Beispiel

Diesen Code ausführen

#include <algorithm>
#include <array>
#include <complex>
namespace ranges = std::ranges;
int main()
{
    constexpr auto haystack = std::array{3, 1, 4, 1, 5};
    constexpr auto needle = std::array{1, 4, 1};
    constexpr auto bodkin = std::array{2, 5, 2};
    static_assert
    (
        ranges::contains(haystack, 4) &&
       !ranges::contains(haystack, 6) &&
        ranges::contains_subrange(haystack, needle) &&
       !ranges::contains_subrange(haystack, bodkin)
    );
    constexpr std::array<std::complex<double>, 3> nums{{{1, 2}, {3, 4}, {5, 6}}};
    #ifdef __cpp_lib_algorithm_default_value_type
        static_assert(ranges::contains(nums, {3, 4}));
    #else
        static_assert(ranges::contains(nums, std::complex<double>{3, 4}));
    #endif
}

**Änderungen:** - "Run this code" → "Diesen Code ausführen" - Alle HTML-Tags, Attribute und Code-Blöcke wurden unverändert beibehalten - C++-spezifische Begriffe (wie Funktionsnamen, Namespaces, Typen) wurden nicht übersetzt - Die Formatierung und Struktur der HTML-Elemente bleibt vollständig erhalten

Siehe auch

ranges::find ranges::find_if ranges::find_if_not (C++20) (C++20) (C++20)	findet das erste Element, das bestimmte Kriterien erfüllt (Algorithmus-Funktionsobjekt)
ranges::search (C++20)	sucht nach dem ersten Vorkommen eines Elementbereichs (Algorithmus-Funktionsobjekt)
ranges::binary_search (C++20)	bestimmt, ob ein Element in einem teilweise geordneten Bereich existiert (Algorithmus-Funktionsobjekt)
ranges::includes (C++20)	gibt true zurück, wenn eine Sequenz eine Teilsequenz einer anderen ist (Algorithmus-Funktionsobjekt)
ranges::all_of ranges::any_of ranges::none_of (C++20) (C++20) (C++20)	prüft, ob ein Prädikat für alle, irgendein oder keines der Elemente in einem Bereich true ist (Algorithmus-Funktionsobjekt)

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

cppreference.net

Namespaces

Variants