std::transform

ヘッダー `<algorithm>` で定義
template< class InputIt, class OutputIt, class UnaryOp > OutputIt transform( InputIt first1, InputIt last1, OutputIt d_first, UnaryOp unary_op );	(1)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class UnaryOp > ForwardIt2 transform( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 d_first, UnaryOp unary_op );	(2)	(C++17以降)
template< class InputIt1, class InputIt2, class OutputIt, class BinaryOp > OutputIt transform( InputIt1 first1, InputIt1 last1, InputIt2 first2, OutputIt d_first, BinaryOp binary_op );	(3)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2, class ForwardIt3, class BinaryOp > ForwardIt3 transform( ExecutionPolicy&& policy, ForwardIt1 first1, ForwardIt1 last1, ForwardIt2 first2, ForwardIt3 d_first, BinaryOp binary_op );	(4)	(C++17以降)

std::transformは、与えられた入力範囲（複数可）の要素に指定された関数を適用し、その結果をd_firstから始まる出力範囲に格納します。

1) 単項演算子unary_opは、[first1, last1)の要素に適用されます。

unary_opがイテレータを無効にしたり、以下のいずれかの範囲の要素を変更したりした場合、動作は未定義となります。

[first1, last1].
std::distance(first1, last1) + 1個の要素からなる範囲、d_firstから始まります。

3) 二項演算子binary_opは、2つの範囲からの要素のペアに適用されます：[first1, last1)と、std::distance(first1, last1)個の要素からなる、first2から始まる別の範囲です。

binary_opがイテレータを無効にしたり、以下のいずれかの範囲の要素を変更したりした場合、動作は未定義となります。

[first1, last1].
std::distance(first1, last1) + 1個の要素からなる範囲、first2から始まります。
std::distance(first1, last1) + 1個の要素からなる範囲、d_firstから始まります。

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以降)

first1, last1	-	変換する要素のソース範囲を定義するイテレータのペア
first2	-	変換する2番目の範囲の開始位置。（3,4のみ）
d_first	-	出力範囲の開始位置。first1またはfirst2と等しくても構いません。
policy	-	使用する実行ポリシー
unary_op	-	適用される単項演算関数オブジェクト。関数のシグネチャは以下と同等である必要があります。 Ret fun(const Type &a); シグネチャは const & を持つ必要はありません。型 Typeは、InputIt型のオブジェクトを間接参照して、 Typeに暗黙的に変換できるような型でなければなりません。型Retは、OutputIt型のオブジェクトを間接参照して、Ret型の値に代入できるような型でなければなりません。
binary_op	-	適用される二項演算関数オブジェクト。関数のシグネチャは以下と同等である必要があります。 Ret fun(const Type1 &a, const Type2 &b); シグネチャは const & を持つ必要はありません。型 Type1と Type2は、InputIt1型とInputIt2型のオブジェクトをそれぞれ間接参照して、 Type1と Type2に暗黙的に変換できるような型でなければなりません。型Retは、OutputIt型のオブジェクトを間接参照して、Ret型の値に代入できるような型でなければなりません。
型要件
- `InputIt, InputIt1, InputIt2`は、LegacyInputIteratorの要件を満たす必要があります。
- `OutputIt` は LegacyOutputIterator の要件を満たさなければなりません。
- `ForwardIt1, ForwardIt2, ForwardIt3` は LegacyForwardIterator の要件を満たしている必要があります。

[編集] 戻り値

変換された最後の要素の次の要素を指す出力イテレータ。

[編集] 計算量

$\scriptsize N$ $N$ をstd::distance(first1, last1)とすると

1,2) unary_opの適用はちょうど

N

回。

3,4) binary_opの適用はちょうど

N

回。

[編集] 例外

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

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

[編集] 実装例

transform (1)

template<class InputIt, class OutputIt, class UnaryOp>
constexpr //< since C++20
OutputIt transform(InputIt first1, InputIt last1,
                   OutputIt d_first, UnaryOp unary_op)
{
    for (; first1 != last1; ++d_first, ++first1)
        *d_first = unary_op(*first1);
 
    return d_first;
}

transform (3)

template<class InputIt1, class InputIt2, 
         class OutputIt, class BinaryOp>
constexpr //< since C++20
OutputIt transform(InputIt1 first1, InputIt1 last1, InputIt2 first2,
                   OutputIt d_first, BinaryOp binary_op)
{
    for (; first1 != last1; ++d_first, ++first1, ++first2)
        *d_first = binary_op(*first1, *first2);
 
    return d_first;
}

[編集] 注記

std::transformは、unary_opまたはbinary_opの順序適用を保証しません。シーケンスにインオーダーで関数を適用する場合や、シーケンスの要素を変更する関数を適用する場合は、std::for_eachを使用してください。

[編集] 例

このコードを実行

#include <algorithm>
#include <cctype>
#include <iomanip>
#include <iostream>
#include <string>
#include <utility>
#include <vector>
 
void print_ordinals(const std::vector<unsigned>& ordinals)
{
    std::cout << "ordinals: ";
    for (unsigned ord : ordinals)
        std::cout << std::setw(3) << ord << ' ';
    std::cout << '\n';
}
 
char to_uppercase(unsigned char c)
{
    return std::toupper(c);
}
 
void to_uppercase_inplace(char& c)
{
    c = to_uppercase(c);
}
 
void unary_transform_example(std::string& hello, std::string world)
{
    // Transform string to uppercase in-place
 
    std::transform(hello.cbegin(), hello.cend(), hello.begin(), to_uppercase);
    std::cout << "hello = " << std::quoted(hello) << '\n';
 
    // for_each version (see Notes above)
    std::for_each(world.begin(), world.end(), to_uppercase_inplace);
    std::cout << "world = " << std::quoted(world) << '\n';
}
 
void binary_transform_example(std::vector<unsigned> ordinals)
{
    // Transform numbers to doubled values
 
    print_ordinals(ordinals);
 
    std::transform(ordinals.cbegin(), ordinals.cend(), ordinals.cbegin(),
                   ordinals.begin(), std::plus<>{});
 
    print_ordinals(ordinals);
}
 
int main()
{
    std::string hello("hello");
    unary_transform_example(hello, "world");
 
    std::vector<unsigned> ordinals;
    std::copy(hello.cbegin(), hello.cend(), std::back_inserter(ordinals));
    binary_transform_example(std::move(ordinals));
}

出力

hello = "HELLO"
world = "WORLD"
ordinals:  72  69  76  76  79 
ordinals: 144 138 152 152 158

[編集] 欠陥報告

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

DR	適用対象	公開された動作	正しい動作
LWG 242	C++98	unary_opおよびbinary_opは副作用を持つことはできません。	それらは関係する範囲を変更することはできません。

[編集] 関連項目

for_each	範囲内の要素に単項関数オブジェクトを適用する (関数テンプレート) [編集]
ranges::transform (C++20)	要素の範囲に関数を適用する (アルゴリズム関数オブジェクト)[編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

cppreference.com

名前空間

変種

表示

操作