std::nth_element

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

アルゴリズムライブラリ

制約付きアルゴリズムとRangeアルゴリズム (C++20)
制約付きアルゴリズム、例: ranges::copy, ranges::sort, ...
実行ポリシー (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
シーケンスを変更しない操作 一括操作 for_each for_each_n (C++17) 検索操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n シーケンスを変更する操作 コピー操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) スワップ操作 swap iter_swap swap_ranges 変換操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 削除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 順序変更操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17まで)(C++11) shift_leftshift_right (C++20)(C++20) サンプリング操作 sample (C++17)	ソートおよび関連操作 パーティション操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) ソート操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分探索操作 (パーティション化された範囲) lower_bound upper_bound equal_range binary_search 集合操作 (ソート済み範囲) includes set_union set_intersection set_difference set_symmetric_difference マージ操作 (ソート済み範囲) merge inplace_merge ヒープ操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 辞書順比較操作 lexicographical_compare lexicographical_compare_three_way (C++20) 順列操作 next_permutation prev_permutation is_permutation (C++11) Cライブラリ qsort bsearch
数値演算
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
未初期化メモリに対する操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

ヘッダー <algorithm> で定義
template< class RandomIt > void nth_element( RandomIt first, RandomIt nth, RandomIt last );	(1)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class RandomIt > void nth_element( ExecutionPolicy&& policy,                   RandomIt first, RandomIt nth, RandomIt last );	(2)	(C++17以降)
template< class RandomIt, class Compare > void nth_element( RandomIt first, RandomIt nth, RandomIt last,                   Compare comp );	(3)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class RandomIt, class Compare > void nth_element( ExecutionPolicy&& policy,                   RandomIt first, RandomIt nth, RandomIt last,                   Compare comp );	(4)	(C++17以降)

nth_element は、[first, last) の範囲の要素を並べ替えます。並べ替え後、

• nth が指す要素は、[first, last) がソートされていた場合にその位置に現れる要素に変更されます。
• [first, nth) のすべてのイテレータ i と、[nth, last) のすべてのイテレータ j について、次の条件が満たされます。

1,2) bool(*j < *i)(until C++20)std::less{}(*j, *i)(since C++20) は false です。

3,4) bool(comp(*j, *i)) は false です。

1) 要素は、operator<(until C++20)std::less{}(since C++20) に対して、仮想的にソートされます。

3) 要素は、comp に対して、仮想的にソートされます。

2,4) (1,3)と同じだが、policyに従って実行される。

これらのオーバーロードは、以下のすべての条件が満たされた場合にのみオーバーロード解決に参加する。

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が true である。	(C++20まで)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> は true です。	(C++20以降)

次のいずれかの条件が満たされる場合、動作は未定義です。

• [first, nth) または [nth, last) は有効な範囲ではありません。

*first の型は Swappable ではありません。	(C++11まで)
RandomIt は ValueSwappable ではありません。 *first の型は MoveConstructible ではありません。 *first の型が MoveAssignable ではありません。	(C++11以降)

パラメータ

first, last	-	部分ソートする要素の範囲を定義するイテレータのペア
nth	-	ソートのパーティションポイントを定義するランダムアクセス イテレータ
policy	-	使用する 実行ポリシー
comp	-	比較関数オブジェクト（つまり、Compare の要件を満たすオブジェクト）。最初の引数が2番目の引数より小さい（つまり、前に順序付けられる）場合に true を返します。 比較関数のシグネチャは、以下と同等でなければならない。 bool cmp(const Type1& a, const Type2& b); シグネチャは const& を持つ必要はありませんが、関数は渡されたオブジェクトを変更してはならず、値カテゴリ に関係なく、(おそらく const の) Type1 と Type2 のすべての値を受け入れられる必要があります (したがって、Type1& は許可されません。また、Type1 のムーブがコピーと同等でない限り、Type1 も許可されません(C++11以降))。 Type1 および Type2 の型は、RandomIt 型のオブジェクトを間接参照してから、両方に暗黙的に変換できる必要があります。 ​
型要件
- RandomItはLegacyRandomAccessIteratorの要件を満たす必要がある。
- CompareはCompareの要件を満たす必要がある。

計算量

\(\scriptsize N\)N を last - first とした場合

1) 平均して \(\scriptsize O(N)\)O(N) 回の比較（operator<(until C++20)std::less{}(since C++20) を使用）。

2) \(\scriptsize O(N)\)O(N) 回の比較（operator<(until C++20)std::less{}(since C++20) を使用）および \(\scriptsize O(N \cdot \log(N))\)O(N·log(N)) 回のスワップ。

3) 平均して \(\scriptsize O(N)\)O(N) 回のコンパレータ comp の適用。

4) \(\scriptsize O(N)\)O(N) 回のコンパレータ comp の適用、および \(\scriptsize O(N \cdot \log(N))\)O(N·log(N)) 回のスワップ。

例外

ExecutionPolicy というテンプレートパラメータを持つオーバーロードは、次のようにエラーを報告します。

• アルゴリズムの一部として呼び出された関数の実行が例外をスローし、ExecutionPolicy が 標準ポリシー のいずれかである場合、std::terminate が呼び出されます。その他の ExecutionPolicy の場合、動作は実装定義です。
• アルゴリズムがメモリの割り当てに失敗した場合、std::bad_alloc がスローされます。

実装例

libstdc++、libc++、および MSVC STL の実装も参照してください。

注記

通常、使用されるアルゴリズムはIntroselectですが、他の選択アルゴリズムで適切な平均計算量を持つものも許可されています。

例

このコードを実行

#include <algorithm>
#include <cassert>
#include <functional>
#include <iostream>
#include <numeric>
#include <vector>
 
void printVec(const std::vector<int>& vec)
{
    std::cout << "v = {";
    for (char sep[]{0, ' ', 0}; const int i : vec)
        std::cout << sep << i, sep[0] = ',';
    std::cout << "};\n";
}
 
int main()
{
    std::vector<int> v{5, 10, 6, 4, 3, 2, 6, 7, 9, 3};
    printVec(v);
 
    auto m = v.begin() + v.size() / 2;
    std::nth_element(v.begin(), m, v.end());
    std::cout << "\nThe median is " << v[v.size() / 2] << '\n';
    // The consequence of the inequality of elements before/after the Nth one:
    assert(std::accumulate(v.begin(), m, 0) < std::accumulate(m, v.end(), 0));
    printVec(v);
 
    // Note: comp function changed
    std::nth_element(v.begin(), v.begin() + 1, v.end(), std::greater{});
    std::cout << "\nThe second largest element is " << v[1] << '\n';
    std::cout << "The largest element is " << v[0] << '\n';
    printVec(v);
}

実行結果の例

v = {5, 10, 6, 4, 3, 2, 6, 7, 9, 3};
 
The median is 6
v = {3, 2, 3, 4, 5, 6, 10, 7, 9, 6};
 
The second largest element is 9
The largest element is 10
v = {10, 9, 6, 7, 6, 3, 5, 4, 3, 2};

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2150	C++98	nth の前には、並べ替え後、1つの要素のみが nth の後にある1つの要素以下であることが必要でした。	修正されました。 要件
LWG 2163	C++98	オーバーロード (1) は要素の比較に operator> を使用していました。	operator< に変更されました。
P0896R4	C++98	[first, nth) および [nth, last) は有効な範囲である必要はありませんでした。	未定義の動作 それらのいずれかが無効な場合。

関連項目

max_element	範囲内で最大の要素を返す (関数テンプレート)
min_element	範囲内で最小の要素を返す (関数テンプレート)
partial_sort_copy	要素の範囲をコピーして部分的にソートする (関数テンプレート)
stable_sort	等しい要素間の順序を維持しながら要素の範囲をソートする (関数テンプレート)
sort	範囲を昇順にソートする (関数テンプレート)
ranges::nth_element (C++20)	与えられた範囲を部分的にソートし、指定された要素によってパーティション化されるようにする (アルゴリズム関数オブジェクト)