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

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Algorithmenbibliothek

Beschränkte Algorithmen und Algorithmen für Bereiche (C++20)
Beschränkte Algorithmen, z.B. ranges::copy, ranges::sort, ...
Ausführungsrichtlinien (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
Nicht-modifizierende Sequenzoperationen Stapeloperationen for_each for_each_n (C++17) Suchoperationen all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n Modifizierende Sequenzoperationen Kopieroperationen copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) Tauschoperationen swap iter_swap swap_ranges Transformationsoperationen replacereplace_if transform replace_copyreplace_copy_if Generierungsoperationen fill fill_n generate generate_n Entfernungsoperationen removeremove_if unique remove_copyremove_copy_if unique_copy Ordnungsändernde Operationen reverse reverse_copy rotate rotate_copy random_shuffleshuffle (bis C++17)(C++11) shift_leftshift_right (C++20)(C++20) Stichprobenoperationen sample (C++17)	Sortier- und verwandte Operationen Partitionierungsoperationen partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) Sortieroperationen sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element Binäre Suchoperationen (auf partitionierten Bereichen) lower_bound upper_bound equal_range binary_search Mengenoperationen (auf sortierten Bereichen) includes set_union set_intersection set_difference set_symmetric_difference Zusammenführungsoperationen (auf sortierten Bereichen) merge inplace_merge Heapoperationen push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) Minimum/Maximum-Operationen max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) Lexikographische Vergleichsoperationen lexicographical_compare lexicographical_compare_three_way (C++20) Permutationsoperationen next_permutation prev_permutation is_permutation (C++11) C-Bibliothek qsort bsearch
Numerische Operationen
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
Operationen auf uninitialisiertem Speicher
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

Eingeschränkte Algorithmen

Alle Namen in diesem Menü gehören zum Namespace std::ranges

Nicht-modifizierende Sequenzoperationen

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

Modifizierende Sequenzoperationen

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

Partitionierungsoperationen

is_partitioned    partition_point    partition    partition_copy    stable_partition

Sortieroperationen

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

Binäre Suchoperationen (auf sortierten Bereichen)

lower_bound         upper_bound         binary_search      equal_range

Mengenoperationen (auf sortierten Bereichen)

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

Heapoperationen

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

Minimum/Maximum-Operationen

max max_element         min min_element         minmax minmax_element     clamp

Permutationsoperationen

is_permutation      next_permutation    prev_permutation

Faltoperationen

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

Numerische Operationen iota (C++23)             Zufallszahlengenerierung generate_random (C++26)

Operationen auf uninitialisiertem Speicher

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

Rückgabetypen

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

Definiert in Header <algorithm>
Aufruf-Signatur
	(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) Suchalgorithmus, der prüft, ob ein gegebener Bereich einen Wert mit Iterator-Sentinel-Paaren enthält.

2) Dasselbe wie in (1), verwendet jedoch r als Quellbereich, als ob ranges::begin(r) als first und ranges::end(r) als last verwendet werden.

3) Suchalgorithmus, der prüft, ob ein gegebener Bereich ein Teilbereich eines anderen Bereichs mit Iterator-Sentinel-Paaren ist.

4) Dasselbe wie in (3), verwendet jedoch r1 als ersten Quellbereich und r2 als zweiten Quellbereich, als ob ranges::begin(r1) als first1, ranges::end(r1) als last1, ranges::begin(r2) als first2 und ranges::end(r2) als last2 verwendet werden.

Die auf dieser Seite beschriebenen funktionsähnlichen Entitäten sind Algorithmus-Funktionsobjekte (informell als niebloids bekannt), d.h.

• Können explizite Template-Argumentlisten bei keinem von ihnen angegeben werden.
• Keiner von ihnen ist für Argument-abhängige Suche sichtbar.
• Wenn einer von ihnen durch normale unqualifizierte Suche als Name links vom Funktionsaufrufoperator gefunden wird, wird die Argument-abhängige Suche unterdrückt.

Parameter

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

Rückgabewert

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

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

Komplexität

Maximal last - first Anwendungen des Prädikats und der Projektion.

Anmerkungen

Bis C++20 mussten wir std::ranges::find(r, value) != std::ranges::end(r) verwenden, um zu prüfen, ob ein einzelner Wert in einem Bereich enthalten ist. Und um zu prüfen, ob ein Bereich einen Teilbereich von Interesse enthält, verwenden wir not std::ranges::search(haystack, needle).empty(). Dies ist zwar korrekt, aber nicht unbedingt praktisch und drückt die Absicht kaum aus (insbesondere im letzteren Fall). Die Möglichkeit, std::ranges::contains(r, value) zu sagen, adressiert beide Punkte.

ranges::contains_subrange, wie ranges::search, aber im Gegensatz zu std::search bietet es keinen Zugriff auf Searcher (wie Boyer-Moore).

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

Mögliche Implementierung

contains (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 (*this)(ranges::begin(r), ranges::end(r), std::move(value), proj); } };   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 (*this)(ranges::begin(r1), ranges::end(r1), ranges::begin(r2), ranges::end(r2), std::move(pred), std::move(proj1), std::move(proj2)); } };   inline constexpr __contains_subrange_fn contains_subrange {};

Beispiel

Führen Sie diesen Code aus

#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
}

Siehe auch

ranges::findranges::find_ifranges::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)	Stellt fest, ob ein Element in einem teilweise geordneten Bereich vorhanden ist (Algorithmus-Funktionsobjekt)
ranges::includes (C++20)	Gibt true zurück, wenn eine Sequenz eine Untersequenz einer anderen ist (Algorithmus-Funktionsobjekt)
ranges::all_ofranges::any_ofranges::none_of (C++20)(C++20)(C++20)	Prüft, ob eine Bedingung für alle, einige oder keine Elemente in einem Bereich wahr ist (Algorithmus-Funktionsobjekt)