Kernel.map_size/1とEnum.count/1の使い分けについて

Question

私のプロジェクトのElixirバージョンを1.9.1にあげたところ、 Map.size/1 is deprecated. Use Kernel.map_size/1 instead の警告が出ました。
しかし、私はEnum.count/1を使うのが自然ではないかと思っています。（なお、Map.size/1を使用したのは前任者です）

そこで、Mapの要素の数を取得する際のKernel.map_size/1とEnum.count/1との使い分けの基準を教えていただきたいです。

Answer 1

ライブラリの実装を眺めてみましたが両者に決定的な違いはなさそうに思えました。

実行される命令の数でいうとKernel.map_size/1の方が少ないので、実行時間は短くなるはずです。しかしEnum.count/1の実行時間との違いはごくわずかだと思いますので、その違いに気づくことはなさそうです。

Kernel.map_size/1 の実装はErlangのBIF（Built-In Function、組み込み関数）である :erlang.map_size/1 を呼ぶようになっています。

https://github.com/elixir-lang/elixir/blob/v1.9.1/lib/elixir/lib/kernel.ex#L740-L759

  def map_size(map) do
    :erlang.map_size(map)
  end

erlang.map_size/1 はCで書かれており、Mapの内部構造で管理している要素数を返しています。そのため、Mapの要素数に関係なく一定時間（O(1)）で実行できる効率の良いものになっています。

https://github.com/erlang/otp/blob/0699796062861bec095fda747afdcf01bc2f015e/erts/emulator/beam/erl_map.c#L123-L146

次にEnum.count/1の実装です。
https://github.com/elixir-lang/elixir/blob/v1.9.1/lib/elixir/lib/enum.ex#L599-L607

  def count(enumerable) do
    case Enumerable.count(enumerable) do
      {:ok, value} when is_integer(value) ->
        value

      {:error, module} ->
        enumerable |> module.reduce({:cont, 0}, fn _, acc -> {:cont, acc + 1} end) |> elem(1)
    end
  end

これにMapを与えるとMapのEnumerable実装のcount/1が呼ばれることになります。

Mapでは以下のようにKernel.map_size/1を呼んで、タプルを作って返しています。

https://github.com/elixir-lang/elixir/blob/v1.9.1/lib/elixir/lib/enum.ex#L3334-L3337

defimpl Enumerable, for: Map do
  def count(map) do
    {:ok, map_size(map)}
  end

このように、Enum.count/1でも内部的にはKernel.map_size/1が使われることは変わりません。ただ、タプルを作ったりis_integer/1のガード付きのパターンマッチを行ったりと、わずかですが余分な処理を行います。

最初に書いたとおり実行時間の違いはごくわずかでしょうからどちらを使ってもよさそうです。ただ、どちらか1つだけを選ぶなら、効率の面からKernel.map_size/1を選ぶことになるのかなと思います。

Comments

[YamakawaJunichi]

詳しい解説ありがとうございます、パフォーマンス面についてよくわかりました。

その後の調べで、ドキュメントによるとKernel.map_size/1はGuardsの項に書かれておりガード節での使用を想定されているように読み取れました。
パフォーマンスの差がわずかとのことですから、ガード節で使うときはKernel.map_size/1でそれ以外で使うときはEnum.count/1というのはどうでしょうか？

https://hexdocs.pm/elixir/Kernel.html#map_size/1

[tatsuya6502]

なるほど。map_size/1はis_*/1の仲間のような位置付けになっているのですね。それでしたら、ご提案のような使い分けがしっくりきそうです。

[YamakawaJunichi]

丁寧にありがとうございました。