ベタなforよりbetterなfor

最近リファクタしたコードを紹介します。

unsigned int login_user_id_list[MAX_USER_ID_COUNT];
int i = 0;
for (i < MAX_USER_ID_COUNT; i++)
{
    if (login_user_id_list[i] == INVALID_USER_ID)
    {
        continue;
    }
    if (login_user_id_list[i] == user_id)
    {
        break;
    }
}

if (i == MAX_USER_ID_COUNT)
{
    // ユーザーがログインしていないケース
}
else
{
    // ユーザーがログインしているケース
}

コメントを付けたのは私です。本当はコメントもなかったので、初めて見た時に一瞬「...?」ってなって、理解するまでちょっと時間かかりました。
最終的に私が提案したコードは以下のようになっていました。

#include <algorithm>

const auto found = std::find(std::begin(login_user_id_list), std::end(login_user_id_list), user_id);
if (found == std::end(login_user_id_list) || *found == INVALID_USER_ID)
{
    // ユーザーがログインしていないケース
}
else
{
    // ユーザーがログインしているケース
}

std::findの引数はイテレータになっていって、生配列の場合はstd::begin()とstd::end()で作成していますが、本当はbegin()とend()というメンバー関数が用意されてあるコンテナとセットで使うのがお勧めします。
例えば、std::listを使った場合は、std::findのコールが以下のようになります。

std::list<unsigned int> login_user_id_list(MAX_USER_ID_COUNT);
const auto found = std::find(login_user_id_list.begin()), login_user_id_list.end(), user_id);

別にforループを使っても問題はないですが、std::findのような特化した関数がある場合は、そちらを使った方がコードが分かりやすくなると思います。
forループは万能で何にでも使えるからこそ、実際に何をやっているかを理解するまで全部一通り読まないといけないため、時間がかかります。

でもコードを書いている時は、まずforループを書きたくなる気持ちはよく分かります。私も大体forループから始めると思います。プログラマーはみんなforループに慣れているので、こういうコードは追いやすいかもしれないですが、場合によって分かりづらかったりします。
それに、forループはインデックスを扱ったりするため、ミスの余地もそれになりにあります。まずはforループを書いて、これはいけるなって分かったら、次のステップで、コードをもうちょっと分かりやすくしてみるという順番でもいいと思います。

stdライブラリは<algorithm>というヘッダーによくあるforループのパターンの代わりに使える関数をたくさん用意しています。

std::findの他にも

• std::for_each
  • 全ての要素に対して処理を行う
• std::all_of
  • 全ての要素が条件を満たしているかを調べる
• std::any_of
  • どれかの要素が条件を満たしているかを調べる
• std::none_of
  • 全ての要素が条件を満たしていないかを調べる
• std::count
  • 指定された値である要素の数を数える
• std::count_if
  • 条件を満たしている要素の数を数える
• std::replace
  • 指定された値と一致する要素を指定された値に置き換える
• std::fill
  • 指定された値で出力の範囲に書き込む

などあります。

全部はここで紹介できないですが、std::for_eachを代表として紹介しておきます。
std::for_eachはforループをイテレータと関数で再現している関数です。std::for_eachのためにわざわざ関数を定義するのは手間なので、大体ラムダ式関数とセットで使います。

一番最初のリファクタしたforループをstd::for_eachで再現しようとすると、forとstd::for_eachの違いが分かりやすくなります。

std::for_each(std::begin(login_user_id_list), std::end(login_user_id_list), [&](unsigned int current_id) {
    if (current_id == -1)
    {
        return;
    }
    if (current_id == user_id)
    {
        i = current_id;
    }
});

if (i == MAX_USER_ID_COUNT)
{
    // ユーザーがログインしていないケース
}
else
{
    // ユーザーがログインしているケース
}

forループのcontinueはstd::for_eachではreturnになりますが、forループのbreakはstd::for_eachでは再現できないです。
std::for_eachは実際に各要素で同じことを行いたい場合に使うため、早くループからリターンすることはできないです。そのため、このstd::for_eachの使い方では、user_idを見つけたとしても、ループし続けます。
やはりこのforループ場合はstd::find_ifが一番適切だと思います。

forループとstd::for_eachのどちらが読みやすいかってなると好みの問題になりますが、<algorithm>にある関数の大半はラムダ式関数とセットで使うため、こういう書き方になると思います。

よく書いているforループがあったら、<algorithm>にそのユースケースに特化した関数がないかを見てみるといいと思います。

---

|cpp記事一覧へのリンク|