std::flat_multiset<Key,Compare,KeyContainer>::find

 

C++

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)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

Views

span (C++20)

mdspan (C++23)

Tables

Iterator invalidation

Member function table

Non-member function table

 

std::flat_multiset

Member types

Member functions

flat_multiset::flat_multiset   flat_multiset::operator= Iterators flat_multiset::beginflat_multiset::cbegin flat_multiset::endflat_multiset::cend flat_multiset::rbeginflat_multiset::crbegin flat_multiset::rendflat_multiset::crend Capacity flat_multiset::size flat_multiset::max_size flat_multiset::empty Observers flat_multiset::key_comp flat_multiset::value_comp Modifiers flat_multiset::clear flat_multiset::insert flat_multiset::insert_range flat_multiset::emplace flat_multiset::emplace_hint flat_multiset::erase flat_multiset::swap flat_multiset::extract flat_multiset::replace Lookup flat_multiset::count flat_multiset::find flat_multiset::contains flat_multiset::equal_range flat_multiset::lower_bound flat_multiset::upper_bound

Non-member functions

swap(std::flat_multiset) erase_if(std::flat_multiset)    operator==operator<=>

Helper classes

uses_allocator<std::flat_multiset>

Tags

sorted_equivalent         sorted_equivalent_t

Deduction guides

 

iterator find( const Key& key );	(1)	(since C++23)
const_iterator find( const Key& key ) const;	(2)	(since C++23)
template< class K > iterator find( const K& x );	(3)	(since C++23)
template< class K > const_iterator find( const K& x ) const;	(4)	(since C++23)

1,2) Finds an element with key equivalent to key. If there are several elements with the requested key in the container, any of them may be returned.

3,4) Finds an element with key that compares equivalent to the value x. This overload participates in overload resolution only if the qualified-id Compare::is_transparent is valid and denotes a type. It allows calling this function without constructing an instance of Key.

Parameters

key	-	key value of the element to search for
x	-	a value of any type that can be transparently compared with a key

Return value

An iterator to the requested element. If no such element is found, past-the-end (see end()) iterator is returned.

Complexity

Logarithmic in the size of the container.

Example

Run this code

#include <iostream>
#include <flat_set>
 
struct LightKey
{
    int x;
};
 
struct FatKey
{
    int x;
    int data[1000]; // a heavy blob
};
 
// As detailed above, the container must use std::less<> (or other transparent
// Comparator) to access these overloads. This includes standard overloads,
// such as comparison between std::string and std::string_view.
bool operator<(const FatKey& fk, const LightKey& lk) { return fk.x < lk.x; }
bool operator<(const LightKey& lk, const FatKey& fk) { return lk.x < fk.x; }
bool operator<(const FatKey& fk1, const FatKey& fk2) { return fk1.x < fk2.x; }
 
int main()
{
    // Simple comparison demo.
    std::flat_multiset<int> example{1, 2, 3, 4};
 
    if (auto search = example.find(2); search != example.end())
        std::cout << "Found " << (*search) << '\n';
    else
        std::cout << "Not found\n";
 
    // Transparent comparison demo.
    std::flat_multiset<FatKey, std::less<>> example2{{1, {}}, {2, {}}, {3, {}}, {4, {}}};
 
    LightKey lk = {2};
    if (auto search = example2.find(lk); search != example2.end())
        std::cout << "Found " << search->x << '\n';
    else
        std::cout << "Not found\n";
}

Output:

Found 2
Found 2

See also

count	returns the number of elements matching specific key (public member function)
equal_range	returns range of elements matching a specific key (public member function)