bsearch

[アーティクル]
08/09/2011

並べ替えられた配列のバイナリ検索を実行します。この関数のセキュリティが強化されたバージョンについては、「bsearch_s」を参照してください。

void *bsearch( 
   const void *key,
   const void *base,
   size_t num,
   size_t width,
   int ( __cdecl *compare ) (const void *key, const void *datum) 
);

パラメーター

key
検索するオブジェクト。
base
検索するデータ配列のベースへのポインター。
num
要素の数。
width
要素の大きさ。
compare
2 つの要素を比較するコールバック関数。最初の要素は検索キーへのポインターで、2 番目の要素はキーと比較される配列要素へのポインターです。

戻り値

bsearch は、base が指す配列内で key が検出された位置へのポインターを返します。 key が見つからない場合は、NULL を返します。配列が昇順に並べ替えられていない場合、または同じキーを持つ重複したレコードがある場合、結果は予測できません。

解説

bsearch 関数は、並べ替えられた配列のバイナリサーチを実行します。配列の要素は num 個で、それぞれのサイズは width バイトです。 base 値は、検索する配列のベースへのポインターです。key は、検索されている値です。 compare パラメーターはユーザーが指定したルーチンへのポインターです。このルーチンは、要求されたキーを配列要素と比較し、その関係を示す次のいずれかの値を返します。

compareルーチンから返される値	説明
< 0	キーは配列要素より小さい。
0	キーは配列要素と等しい。
> 0	キーは配列要素より大きい。

この関数は、パラメーターを検証します。 compare、key、または num が NULL の場合、base が NULL で *num が 0 以外の値の場合、あるいは width が 0 の場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、errno が EINVAL に設定され、関数から NULL が返されます。

必要条件

ルーチン	必須ヘッダー
bsearch	<stdlib.h> および <search.h>

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

次のプログラムでは、qsort を使用して文字列配列を並べ替え、bsearch を使用して "cat" という語を検索します。

// crt_bsearch.c
#include <search.h>
#include <string.h>
#include <stdio.h>

int compare( char **arg1, char **arg2 )
{
   /* Compare all of both strings: */
   return _strcmpi( *arg1, *arg2 );
}

int main( void )
{
   char *arr[] = {"dog", "pig", "horse", "cat", "human", "rat", "cow", "goat"};
   char **result;
   char *key = "cat";
   int i;

   /* Sort using Quicksort algorithm: */
   qsort( (void *)arr, sizeof(arr)/sizeof(arr[0]), sizeof( char * ), (int (*)(const 
   void*, const void*))compare );

   for( i = 0; i < sizeof(arr)/sizeof(arr[0]); ++i )    /* Output sorted list */
      printf( "%s ", arr[i] );

   /* Find the word "cat" using a binary search algorithm: */
   result = (char **)bsearch( (char *) &key, (char *)arr, sizeof(arr)/sizeof(arr[0]),
                              sizeof( char * ), (int (*)(const void*, const void*))compare );
   if( result )
      printf( "\n%s found at %Fp\n", *result, result );
   else
      printf( "\nCat not found!\n" );
}