std::search_n

来自cppreference.com
< cpp‎ | algorithm
 
 
算法库
受约束算法及范围上的算法 (C++20)
受约束算法: std::ranges::copy, std::ranges::sort, ...
执行策略 (C++17)
不修改序列的操作
(C++11)(C++11)(C++11)
(C++17)
修改序列的操作
Partitioning operations
划分操作
排序操作
(C++11)
二分搜索操作
集合操作(在已排序范围上)
堆操作
(C++11)
最小/最大操作
(C++11)
(C++17)

排列
数值运算
未初始化存储上的操作
(C++17)
(C++17)
(C++17)
C 库
 
在标头 <algorithm> 定义
(1)
template< class ForwardIt, class Size, class T >

ForwardIt search_n( ForwardIt first, ForwardIt last,

                    Size count, const T& value );
(C++20 前)
template< class ForwardIt, class Size, class T >

constexpr ForwardIt search_n( ForwardIt first, ForwardIt last,

                              Size count, const T& value );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt, class Size, class T >

ForwardIt search_n( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last,

                    Size count, const T& value );
(2) (C++17 起)
(3)
template< class ForwardIt, class Size, class T, class BinaryPredicate >

ForwardIt search_n( ForwardIt first, ForwardIt last,

                    Size count, const T& value, BinaryPredicate p );
(C++20 前)
template< class ForwardIt, class Size, class T, class BinaryPredicate >

constexpr ForwardIt search_n( ForwardIt first, ForwardIt last,

                              Size count, const T& value, BinaryPredicate p );
(C++20 起)
template< class ExecutionPolicy, class ForwardIt,

          class Size, class T, class BinaryPredicate >
ForwardIt search_n( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last,

                    Size count, const T& value, BinaryPredicate p );
(4) (C++17 起)

在范围 [first, last) 中搜索 count 个等同元素的序列,每个都等于给定的值 value

1)operator== 比较元素。
3) 用给定的二元谓词 p 比较元素。
2,4)(1,3) ,但按照 policy 执行。这些重载只有在

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>

(C++20 前)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>

(C++20 起)
true 时才会参与重载决议。

参数

first, last - 要检验的元素范围
count - 要搜索的序列长度
value - 要搜索的元素值
policy - 所用的执行策略。细节见执行策略
p - 若元素应被当做相等则返回 ​true 的二元谓词。

谓词函数的签名应等价于如下:

 bool pred(const Type1 &a, const Type2 &b);

虽然签名不必有 const & ,函数也不能修改传递给它的对象,而且必须接受(可为 const 的)类型 Type1Type2 的值,无关乎值类别(从而不允许 Type1 & ,亦不允许 Type1 ,除非 Type1 的移动等价于复制 (C++11 起))。
类型 Type1 必须使得 ForwardIt 类型的对象能在解引用后隐式转换到 Type1。类型 Type2 必须使得 T 类型的对象能隐式转换到 Type2。 ​

类型要求
-
ForwardIt 必须符合老式向前迭代器 (LegacyForwardIterator) 的要求。
-
Size 必须可转换整数类型

返回值

如果 count 为正,那么返回指向范围 [first, last) 中找到的序列起始的迭代器。序列中的每个迭代器 it 都要满足以下条件:

1,2) *it == valuetrue
3,4) p(*it, value) != falsetrue

找不到这种序列的情况下返回 last

如果 count 为零或负,那么返回 first

复杂度

给定 Nstd::distance(first, last)

1,2) 最多应用 Noperator==value 进行比较
3,4) 最多应用 N 次谓词 p

异常

拥有名为 ExecutionPolicy 的模板形参的重载按下列方式报告错误:

  • 如果作为算法一部分调用的函数的执行抛出异常,且 ExecutionPolicy标准策略之一,那么调用 std::terminate。对于任何其他 ExecutionPolicy,行为由实现定义。
  • 如果算法无法分配内存,那么抛出 std::bad_alloc

可能的实现

版本一
template<class ForwardIt, class Size, class T>
ForwardIt search_n(ForwardIt first, ForwardIt last, Size count, const T& value)
{
    if (count <= 0)
        return first;
 
    for(; first != last; ++first)
    {
        if (!(*first == value))
            continue;
 
        ForwardIt candidate = first;
 
        for (Size cur_count = 1; true; ++cur_count)
        {
            if (cur_count >= count)
                return candidate; // 成功
 
            ++first;
            if (first == last)
                return last; // 穷尽列表
 
            if (!(*first == value))
                break; // 栏中过少
        }
    }
    return last;
}
版本三
template<class ForwardIt, class Size, class T, class BinaryPredicate>
ForwardIt search_n(ForwardIt first, ForwardIt last, Size count, const T& value,
                   BinaryPredicate p)
{
    if (count <= 0)
        return first;
 
    for(; first != last; ++first)
    {
        if (!p(*first, value))
            continue;
 
        ForwardIt candidate = first;
 
        for (Size cur_count = 1; true; ++cur_count)
        {
            if (cur_count >= count)
                return candidate; // 成功
 
            ++first;
            if (first == last)
                return last; // 穷尽列表
 
            if (!p(*first, value))
                break; // 栏中过少
        }
    }
    return last;
}

示例

#include <iostream>
#include <algorithm>
#include <iterator>
 
template<class Container, class Size, class T>
[[nodiscard]]
bool consecutive_values(const Container& c, Size count, const T& v)
{
    return std::search_n(std::begin(c), std::end(c), count, v) != std::end(c);
}
 
int main()
{
    const char sequence[] = "1001010100010101001010101";
 
    std::cout << std::boolalpha
              << "有 4 个连续的零:"
              << consecutive_values(sequence, 4, '0') << '\n'
              << "有 3 个连续的零:"
              << consecutive_values(sequence, 3, '0') << '\n';
}

输出:

有 4 个连续的零:false
有 3 个连续的零:true

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 283 C++98 T 需要是 可相等比较 (EqualityComparable) 的,但是 InputIt 的值类型不一定是 T 移除该要求
LWG 426 C++98 复杂度上限是 N·count,它在 count 为负时也为负 count 非正时上限是 0
LWG 714 C++98 复杂度上限在 count > 0 时是 N·count,但最差情况下也只会进行 N 次比较/操作 将这种情况下的上限改成 N

参阅

在特定范围中寻找最后出现的元素序列
(函数模板)
寻找首个满足特定判别标准的元素
(函数模板)
搜索一个元素范围
(函数模板)