C# vNext (12 候補)紹介シリーズ。

今日はリスト パターンがらみ。

提案ドキュメント:

• List patterns on enumerables (この当時から、リスト パターンの文法には結構変更あり)
• 直近の Language Design Meeting ノート

C# 11 のときの話

C# 11 でリスト パターンが入りました。

is [] みたいに、[] を使って配列とか List<T> に対するパターン マッチを行います。 ただ、C# 11 時点では、

• countable: Length もしくは Count で長さを取れる
• indexable: [int index] (整数引数のインデクサー)で i 番目の要素を取れる
• sliceable: [Range range] や Slice(int start, int length) でスライスを作れる

みたいな割と厳し目な条件を満たす型に対してだけリスト パターンを使えました。 以下の例ではリスト パターンとその展開結果をコメントに書いていますが、 見ての通り、 Length や [] を使ったコードと等価です。

using static System.Console;

static void m(int[] x)
{
    WriteLine(x is []); // x.Length == 0
    WriteLine(x is [1]); // x.Length == 1 && x[0] == 1
    WriteLine(x is [1, ..]); // x.Length >= 1 && x[0] == 1
    WriteLine(x is [_, .. var y]); // y = x[1..]
    WriteLine(x is [_, .. var z, _, _]); // y = x[1..^2]
}

対 IEnumerable

提案当初(コミュニティ提案だったりします)では、 リスト パターンは IEnumerable に対しても使える提案がありました。 別にリジェクトされたわけでもないんですが、countable, indexable, sliceable に対するものと比べると課題が多いので「後回し」にされています。

まあ、元々提案にあったものなので、引き続き検討しようかという感じで C# vNext 候補です。 元々の提案では、何らかのヘルパー クラスを間に挟んで、 x is [0, 1, ..] みたいなコードを以下のような感じで展開することを考えています。

var helper = new ListPatternHelper(x, 2, 0);

helper.TryGetStartElement(index: 0, out var element0) && element0 is 0 &&
helper.TryGetStartElement(1, out var element1) && element1 is 1

課題

リスト パターンを IEnumerable でも使えるようにしようとすると、スライスが絡むときが難しそうです。 例えば、 x is [0, 1] だとそんなに問題はなくて、 「最初の2個分 MoveNext → Current するだけ」になるんですが。 一方で x is [.., 1] だと、 LINQ でいうところの Last になるわけで、 LINQ でもそうなんですけども、無限シーケンスで困ります。

// 普通、無限シーケンスは Take(有限の値) とかで一部分だけ取り出して使う。
var x = m().Take(100);

// 無限なものの Last があるわけなく、永久ループになる。まずい。
var y = m().Last();

static IEnumerable<int> m()
{
    var i = 0;
    while (true) yield return i++; // whiel(true) なので永久に途切れない
}

この辺りを中心に、LDMで検討:

スライスの後ろにパターンがある場合

前述のように x is [.., 1, 2] とかになっているパターンをどうするか:

• 展開結果がちょっと複雑
  • → 手書きするよりはコンパイラーに頑張ってもらう方がマシ
• 無限シーケンスとかみたいに footgun (勢い余って自分の足を打ち抜いちゃいそうな道具)になりそう
  • → 元から。LINQ もそうだし、なんだったら .NET Framework 1.0 の頃からこの手の footgun はある
• LINQ よりもパフォーマンスが落ちる可能性
  • LINQ to Object の場合、内部的に is IList 分岐とかで「indexable ならそれ前提のコードを使う」みたいな最適化をしてる
  • この問題は大きいと思っている。「パターンを使うとパフォーマンスが悪くなる」という状況は避けたい
  • IEnumerable 向けリスト パターンでもその手の最適化がかかるようにしないといけない

まあとりあえず、最初の実装としては x is [1, 2, ..] みたいな「スライスの前」だけを認めて、 x is [.., 1, 2] みたいな「スライスの後」は後々改めて検討するのでもいいかも見たいな雰囲気です。

「スライスの後」の方は、 結局は、「最初に紹介した ListPatternHelper みたいなヘルパー クラスの中で、LINQ と比べてパフォーマンス悪化させないような最適化がかかってほしい」ということになるんですが、「BCL チームと連携して作る」とのこと。

.. 部分をキャプチャ

リスト パターンでは、x is [1, 2, ..var y] みたいに書いて、y = x[2..] みたいなスライスをキャプチャすることもできます。 とうことで、「スライスをキャプチャ」は、「配列とかリストのスライス」と密接に紐づいています。

で、このスライスなんですが、推奨としては「Slice メソッドの戻り値は元の型と同じにするべき」ということになっています。 配列であれば x[i..j] の結果も配列、 List<T> であれば x[i..j] の結果も List<T>、 Span<T> であれば x[i..j] の結果も Span<T> ということです。

(その結果、配列や List<T> に対して [..] を使うとコピーが発生してパフォーマンスはそんなによくないですが、「型が同じ」の方が驚きは少ないだろう、パフォーマンスが必要なら Span を使えばいいだろうということになっています。)

ところが、IEnumerable の場合、スライスを具体的に何の型にすればいいのかが決まらないので困ると。

これも結局、「よいヘルパー クラスができてから改めて考える」みたいな空気感で終わっています。