std:: bsearch

key が指す要素と等しい要素を、 ptr が指す配列内から検索します。配列は count 個の要素を持ち、各要素のサイズは size バイトです。配列は key が指すオブジェクトに対して分割されていなければなりません。つまり、キーオブジェクトより小さいと比較されるすべての要素は、等しいと比較されるすべての要素の前に現れ、それらはキーオブジェクトより大きいと比較されるすべての要素の前に現れる必要があります。完全にソートされた配列はこれらの要件を満たします。要素は comp が指す関数を使用して比較されます。

配列が昇順で分割されていない場合の動作は未定義です。これは、 comp が使用するのと同じ基準に従います。

配列に検索対象の要素と comp によって等価と判定される複数の要素が含まれている場合、関数が結果としてどの要素を返すかは未規定です。

パラメータ

戻り値

見つかった要素へのポインタ、または要素が見つからなかった場合は null ポインタ。

注記

名前にもかかわらず、C言語およびPOSIX標準は、この関数が二分探索を用いて実装されることや、複雑性に関する保証を一切要求していません。

C++標準ライブラリが提供する2つのオーバーロードは、パラメータ comp の型が異なるため区別されます（ language linkage はその型の一部です）。

例

#include <array>
#include <cstdlib>
#include <iostream>
template<typename T>
int compare(const void *a, const void *b)
{
    const auto &arg1 = *(static_cast<const T*>(a));
    const auto &arg2 = *(static_cast<const T*>(b));
    const auto cmp = arg1 <=> arg2;
    return cmp < 0 ? -1
        :  cmp > 0 ? +1
        :  0;
}
int main()
{
    std::array arr{1, 2, 3, 4, 5, 6, 7, 8};
    for (const int key : {4, 8, 9})
    {
        const int* p = static_cast<int*>(
            std::bsearch(&key,
                arr.data(),
                arr.size(),
                sizeof(decltype(arr)::value_type),
                compare<int>));
        std::cout << "value " << key;
        if (p)
            std::cout << " found at position " << (p - arr.data()) << '\n';
        else
            std::cout << " not found\n";
    }
}

value 4 found at position 3
value 8 found at position 7
value 9 not found

関連項目