QSORT(3)

名前
qsort, qsort_r - 配列を並べ変える

書式
#include <stdlib.h>

void qsort(void *base, size_t nmemb, size_t size,
           int (*compar)(const void *, const void *));

void qsort_r(void *base, size_t nmemb, size_t size,
           int (*compar)(const void *, const void *, void *),
           void *arg);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

qsort_r(): _GNU_SOURCE

説明
qsort() 関数は、 nmemb 個の大きさ size の要素をもつ配列を並べ変える。 base 引き数は配列の先頭へのポインタである。

compar をポインタとする比較関数によって、 配列の中身は昇順 (値の大きいものほど後に並ぶ順番) に並べられる。 比較関数の引き数は比較されるふたつのオブジェクトのポインタである。

比較関数は、第一引き数が第二引き数に対して、 1) 小さい、2) 等しい、3) 大きいのそれぞれに応じて、 1) ゼロより小さい整数、2) ゼロ、3) ゼロより大きい整数の いずれかを返さなければならない。 二つの要素の比較結果が等しいとき、 並べ変えた後の配列では、これら二つの順序は規定されていない。

qsort_r() 関数は qsort() と同じだが、比較関数 compar が第 3 引き数を 取る点が異なる。ポインタが arg 経由で比較関数に渡される。 これにより、比較関数は任意の引き数を渡すためにグローバル変数を使う必要がなくなり、 そのため、リエントラント (再入可能) で安全にスレッドで使用できるようになる。

返り値
関数 qsort() と qsort_r() は値を返さない。

バージョン
qsort_r() は glibc バージョン 2.8 で追加された。

準拠
qsort() 関数は SVr4, 4.3BSD, C89, C99 に準拠している。

注意
qsort() の compar 引き数に使用するのに適しているライブラリルーチンと しては alphasort(3), versionsort(3) がある。 C の文字列を比較する場合、 以下の例にあるように比較関数で strcmp(3) を呼び出すこともできる。

例
使用例については、 bsearch(3) にある例を参照すること。 以下のプログラムに別の使用例を示す。このプログラムは、 コマンドライン引き数で指定された文字列の並び換えを行う。

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
static int
cmpstringp(const void *p1, const void *p2)
{
    /* この関数の実際の引き数は "char 型へのポインタのポインタ" だが、
       strcmp(3) の引き数は "char 型へのポインタ" である。
       そこで、以下のようにキャストをしてからポインタの逆参照を行う。*/
    return strcmp(* (char * const *) p1, * (char * const *) p2);
}
int
main(int argc, char *argv[])
{
    int j;
    if (argc < 2) {
	fprintf(stderr, "Usage: %s <string>...\n", argv[0]);
	exit(EXIT_FAILURE);
    }
    qsort(&argv[1], argc - 1, sizeof(char *), cmpstringp);
    for (j = 1; j < argc; j++)
        puts(argv[j]);
    exit(EXIT_SUCCESS);
}

関連項目
sort(1), alphasort(3), strcmp(3), versionsort(3)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。