MANA-DOT

PIXEL ART, PROGRAMING, ETC.

このエントリはドワンゴ Advent Calendar 2021 2日目の記事です(夜が明けるまでは2日目！)。

はじめに

TypeScriptにはConditional Types やTemplate Literal Types といったクッソ強力な型機能があります。

これらを用いて、今回は2p3p4p2m3m4m2s3s4s4s5s6s8s8s のような天鳳牌譜形式の文字列を型引数に渡すと、麻雀の役判定をする型(あくまで型です、関数ではありません)を作ってみようとおもいます。

(ただし時間がなかったため断么九と平和のみです)。

Conditional Types, Template Literal Types って何？

それぞれ具体的にどんなものか、マニュアルの例を用いて示すと、以下のような感じです。

// Conditional Types の例interface Animal{  live():void;}interface Dogextends Animal{  woof():void;}// type Example1 = number となるtype Example1= Dogextends Animal ?number :string;// type Example2 = string となるtype Example2=RegExpextends Animal ?number :string;// Template Literal Types の例type World="world";// type Greeting = "hello world" とおなじになるtype Greeting=`hello${World}`;

それぞれ、｢型に応じた型の分岐｣｢動的な文字列型の生成｣を可能にしています。これだけだと｢ふーん｣といった感じかもしれませんが、これとGeneticsやinferによる推論、更に再帰的な型適用をあわせて利用することで、プログラミングに近い表現力で型を定義することが出来てしまいます。

その強力さを示す例として、以下の参考サイトでは、JSONのパーサーを作る例や、SQL文字列からSQL構造の型を作り出す事例が紹介されています(今回非常に参考にさせていただいています)。

これらの事例を参考に、今回麻雀の役判定する型を実装してみたいと思います。

実装

今回成果物となるコードです。順を追って説明していきます。

MahjongTypes/MahjongTypes.ts at main · manaten/MahjongTypes

牌の型の定義

type 数牌の数="1" |"2" |"3" |"4" |"5" |"6" |"7" |"8" |"9";type 数牌の色="s" |"p" |"m";type 字牌の数="1" |"2" |"3" |"4" |"5" |"6" |"7";type 字牌の色="z";type 数牌=`${数牌の数}${数牌の色}`;type 中張牌=`${"2" |"3" |"4" |"5" |"6" |"7" |"8"}${数牌の色}`;type 老頭牌=`${"1" |"9"}${数牌の色}`;type 東="1z";type 南="2z";type 西="3z";type 北="4z";type 白="5z";type 發="6z";type 中="7z";type 字牌= 東 | 南 | 西 | 北 | 白 | 發 | 中;type 么九牌= 老頭牌 | 字牌;type 雀牌= 数牌 | 字牌;

ここまではTypeScriptの型がわかればそんなに難しくない内容です。純粋に共用体を使って麻雀牌の型を定義しています。これはあとで役判定に使う想定です。

ちなみに、大量の型の英名をいちいち考えるのがしんどかったので、ほとんど日本語で型名をつけています。2日まで時間なかったし。

結果となる型の定義

冒頭のスクリーンショットで示したような、判定結果を収納する型の定義です。2p3p4p2m3m4m2s3s4s4s5s6s8s8s のような文字列を最終的にこの型(の配列)に変換することを目指します。

type Result={  雀頭:[雀牌, 雀牌],  面子:[雀牌, 雀牌, 雀牌][],  Rest:(雀牌 |"")[],  役:string[],}

再帰的にResult型を作っていくので、Restプロパティは、処理中の牌を入れておくために用意しています。

文字列を配列にする

ここからTypeScriptの型の本領が発揮されていきます。まずは、処理のために2p3p4p2m3m4m2s3s4s4s5s6s8s8s 形式の文字列を雀牌の配列に変換します

type ToArray<Pextendsstring>=  Pextends"" ?[] :    Pextends`${infer A}${infer B}${infer Rest}` ?`${A}${B}`extends 雀牌 ?[`${A}${B}`, ...ToArray<Rest>]    :never  :never;

inferを使うことで、文字列を3パーツに分割します。先頭2文字が雀牌であれば、先頭2文字を配列要素に入れ、残りを再びToArray型に適用しています。すべて雀牌であれば、最終的に空文字列となり、雀牌の配列型となります。

実際に文字列を適用すると、以下のような結果となります。

きちんと配列になっています。自分はこれが動いたとき感動しました。

雀頭判定

配列になったので、次は配列をResult型に変換する型を書きます。自分は｢まず雀頭だけ埋める｣→｢面子を1つずつ埋める｣というステップを考えました。雀頭だけ埋めたResultの配列をこのステップでは生成します。

type 雀頭判定<Aextends 雀牌, Bextends 雀牌, Restextends 雀牌[]>=  Aextends B ?[{      雀頭:[A, B],      面子:[],      Rest: Rest,      役:[],}]  :[]type 雀頭マッチング<Aextends 雀牌, P0extends 雀牌, P1extends 雀牌, P2extends 雀牌, P3extends 雀牌, P4extends 雀牌, P5extends 雀牌, P6extends 雀牌, P7extends 雀牌, P8extends 雀牌, P9extends 雀牌, P10extends 雀牌, P11extends 雀牌, P12extends 雀牌>=[  ...雀頭判定<A, P0,[P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P1,[P0, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P2,[P0, P1, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P3,[P0, P1, P2, P4, P5, P6, P7, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P4,[P0, P1, P2, P3, P5, P6, P7, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P5,[P0, P1, P2, P3, P4, P6, P7, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P6,[P0, P1, P2, P3, P4, P5, P7, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P7,[P0, P1, P2, P3, P4, P5, P6, P8, P9, P10, P11, P12]>,  ...雀頭判定<A, P8,[P0, P1, P2, P3, P4, P5, P6, P7, P9, P10, P11, P12]>,  ...雀頭判定<A, P9,[P0, P1, P2, P3, P4, P5, P6, P7, P8, P10, P11, P12]>,  ...雀頭判定<A, P10,[P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P11, P12]>,  ...雀頭判定<A, P11,[P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P12]>,  ...雀頭判定<A, P12,[P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11]>,];type 雀頭チェック<Pextends 雀牌[]>= Uniq<[  ...雀頭マッチング<P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[1], P[0], P[2], P[3], P[4], P[5], P[6], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[2], P[0], P[1], P[3], P[4], P[5], P[6], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[3], P[0], P[1], P[2], P[4], P[5], P[6], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[4], P[0], P[1], P[2], P[3], P[5], P[6], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[5], P[0], P[1], P[2], P[3], P[4], P[6], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[6], P[0], P[1], P[2], P[3], P[4], P[5], P[7], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[7], P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[8], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[8], P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[7], P[9], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[9], P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[7], P[8], P[10], P[11], P[12], P[13]>,  ...雀頭マッチング<P[10], P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[7], P[8], P[9], P[11], P[12], P[13]>,  ...雀頭マッチング<P[11], P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[7], P[8], P[9], P[10], P[12], P[13]>,  ...雀頭マッチング<P[12], P[0], P[1], P[2], P[3], P[4], P[5], P[6], P[7], P[8], P[9], P[10], P[11], P[13]>,]>;type Uniq<Aextendsany[]>=  Aextends[ infer H, infer I, ...infer T] ?    Hextends I ?[H, ...Uniq<T>] :[H, I, ...Uniq<T>]  : Atype Ex2= 雀頭チェック<ToArray<"2p3p4p2m3m4m2s3s4s4s5s6s8s8s">>

14個の牌が並ぶ配列型を、力技でマッチングしています。プログラミングならforループを回すところでしょうが、これは型定義なのでそんな高等テクニックは利用できません。おとなしく要素の位置を変えて14回*14回の型を生成し、spread operatorで単一の配列にマージしていきます(型でspread operatorが使えるのも狂ってますね･･･)。最後、雀頭判定 では、注目する2つの牌が一致していれば雀頭扱いにしてResult型を返し、一致しなければ雀頭ではない組み合わせとし空配列を返しています。

この型を適用すると以下のようになります。

きちんと雀頭っぽい部分だけ抜き出され、残りの雀牌がRestに入っていますね！これが動いたとき僕はニ回目の感動をしました。

ちなみに、しれっと Uniq型という配列の連続した重複要素を取り除く型も用意しています。これを適用しないと、雀頭は同じ牌の組み合わせなので、同じResultが2個以上生成されてしまいます。

面子判定

正直雀頭が判定できたら面子も判定できるような気がしませんか？ほぼ同じ発想で出来てしまいますが、今回型引数となるのはResult型の配列なので一工夫が必要です。

type 数<P>= Pextends`${infer N}${数牌の色}` ?`${N}` :never;type 色<P>= Pextends`${数牌の数}${infer C}` ?`${C}` :never;type 隣の牌<P>=  数<P>extends"1" ?`2${色<P>}` :  数<P>extends"2" ?`3${色<P>}` :  数<P>extends"3" ?`4${色<P>}` :  数<P>extends"4" ?`5${色<P>}` :  数<P>extends"5" ?`6${色<P>}` :  数<P>extends"6" ?`7${色<P>}` :  数<P>extends"7" ?`8${色<P>}` :  数<P>extends"8" ?`9${色<P>}` :never;type 面子判定<Rextends Result, A0, A1, A2, Rest>=  A2extendsundefined ?[] :(// 刻子チェック    A0extends A1 ?      A1extends A2 ?[{            雀頭: R["雀頭"],            面子:[...R["面子"],[A0, A1, A2]],            Rest: Rest,            役:[],}]      :[]// 順子チェック    : 隣の牌<A0>extends A1  ?      隣の牌<A1>extends A2 ?[{            雀頭: R["雀頭"],            面子:[...R["面子"],[A0, A1, A2]],            Rest: Rest,            役:[],}]      :[]    :[])type 面子マッチング2<Rextends Result, A0, A1, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9>=  A1extendsundefined ?[] :[    ...面子判定<R, A0, A1, P0,[P1, P2, P3, P4, P5, P6, P7, P8, P9]>,    ...面子判定<R, A0, A1, P1,[P0, P2, P3, P4, P5, P6, P7, P8, P9]>,    ...面子判定<R, A0, A1, P2,[P0, P1, P3, P4, P5, P6, P7, P8, P9]>,// ...くりかえし];type 面子マッチング1<Rextends Result, A0, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10>=  A0extendsundefined ?[] :[    ...面子マッチング2<R, A0, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10>,    ...面子マッチング2<R, A0, P1, P0, P2, P3, P4, P5, P6, P7, P8, P9, P10>,    ...面子マッチング2<R, A0, P2, P0, P1, P3, P4, P5, P6, P7, P8, P9, P10>,// ...くりかえし];type 面子チェック<RSextends Result[]>=  RSextends[ infer R, ...infer T] ?    Rextends Result ? Textends Result[] ?      Uniq<[        ...面子マッチング1<R, R["Rest"][0], R["Rest"][1], R["Rest"][2], R["Rest"][3], R["Rest"][4], R["Rest"][5], R["Rest"][6], R["Rest"][7], R["Rest"][8], R["Rest"][9], R["Rest"][10], R["Rest"][11]>,        ...面子マッチング1<R, R["Rest"][1], R["Rest"][0], R["Rest"][2], R["Rest"][3], R["Rest"][4], R["Rest"][5], R["Rest"][6], R["Rest"][7], R["Rest"][8], R["Rest"][9], R["Rest"][10], R["Rest"][11]>,        ...面子マッチング1<R, R["Rest"][2], R["Rest"][0], R["Rest"][1], R["Rest"][3], R["Rest"][4], R["Rest"][5], R["Rest"][6], R["Rest"][7], R["Rest"][8], R["Rest"][9], R["Rest"][10], R["Rest"][11]>,// ...くりかえし        ...面子チェック<T>]>    :[] :[]  :[];

雰囲気は雀頭判定で伝わったと思うので、一部コードを省略しています。基本的な発想は雀頭判定と一緒で、面子は3つの牌が関わるため3重ループ(力技)を行っています。

ポイントは2箇所あります。1つ目は、引数が配列なので、inferを使ってHeadとTailに分割し、再起でResult配列を1要素ずつ面子マッチング1に食わせています。

もう一つは、面子判定の順子の判定です。刻子は同じ牌の集まりなので、雀頭判定と同じ発想で判定できます。順子は123のような、連続する牌の集まりですので、隣の牌が隣の数字であることを判定する必要があります。このために、1p のような文字列から1 とp を取り出す数<P>色<P> 型と、それらを用いて隣の牌の型を返す隣の牌<P> 型を定義しています。隣の牌<"1p"> は"2p" になるという寸法です。

これらを用いて実装された面子チェック型を4回適用すると次のようになります。

赤線は型適用の回数が爆発してきたことによるVSCodeの悲鳴です(型のインスタンス化は非常に深く、無限である可能性があります。ts(2589) などと言ってきます)。幸い、型のプレビューは出来ているので助かりました。

これをみると、しっかり面子に分けられていることがわかります。省略されてますが、他の組み合わせ(例の手では順番が違うだけ)も判定され、すべてのパターンが配列になっています。

雀頭と面子の分解ができれば、もう役判定はできそうな気がしてきませんか？

役判定

最後に、役判定です。今回時間がなかったため、断么九と平和)のみの判定となります。

type 断么九判定<Rextends Result>=  Rextends{    雀頭:[中張牌, 中張牌],    面子:[[中張牌, 中張牌, 中張牌],[中張牌, 中張牌, 中張牌],[中張牌, 中張牌, 中張牌],[中張牌, 中張牌, 中張牌]],} ?["断么九"] :[]type 平和判定<Rextends Result>=  R["面子"][0][0]extends infer A ?    R["面子"][1][0]extends infer B ?      R["面子"][2][0]extends infer C ?        R["面子"][3][0]extends infer D ?          Rextends{            雀頭:[雀牌, 雀牌],            面子:[[A, 隣の牌<A>, 隣の牌<隣の牌<A>>],[B, 隣の牌<B>, 隣の牌<隣の牌<B>>],[C, 隣の牌<C>, 隣の牌<隣の牌<C>>],[D, 隣の牌<D>, 隣の牌<隣の牌<D>>],],} ?["平和"] :[]        :[]      :[]    :[]  :[]type 役チェック<RSextends Result[]>=  RSextends[ infer R, ...infer T] ?    Rextends Result ? Textends Result[] ?      Uniq<[{          雀頭: R["雀頭"],          面子: R["面子"],          Rest:[],          役:[            ...断么九判定<R>,            ...平和判定<R>,],},        ...役チェック<T>]>    :[] :[]  :[];

雀頭･面子の判定と比べてかなり素直になっています。役チェックではResult配列を面子判定と同じテクニックでループさせています。ループのそれぞれで、役プロパティに各役の判定結果を突っ込んでいます。

役判定の方は、断么九の判定がかなり美しくないでしょうか？

type 断么九判定<Rextends Result>=  Rextends{    雀頭:[中張牌, 中張牌],    面子:[[中張牌, 中張牌, 中張牌],[中張牌, 中張牌, 中張牌],[中張牌, 中張牌, 中張牌],[中張牌, 中張牌, 中張牌]],} ?["断么九"] :[]

冒頭で定義した、中張牌の型を用いて、Resultがこの形になっているかを判定するだけです。ちゃんと雀頭も各メンツも中張牌のみで構成されていれば、Resultはこの型のサブ型になっているはずですので、断么九という文字列が返ります。これをやりたかったがためにこんな苦行をしてきたといっても過言ではない･･･

同じ発想で字一色や緑一色は判定できそうですね。混一色などは複合しない清一色を除くのが難しそうです。

対して平和はやや複雑です。面子がすべて順子であることの判定に、隣の牌型を頑張って利用しています。inferは関数型言語のletのように用いることもできるんですね。

type 平和判定<Rextends Result>=  R["面子"][0][0]extends infer A ?    R["面子"][1][0]extends infer B ?      R["面子"][2][0]extends infer C ?        R["面子"][3][0]extends infer D ?          Rextends{            雀頭:[雀牌, 雀牌],            面子:[[A, 隣の牌<A>, 隣の牌<隣の牌<A>>],[B, 隣の牌<B>, 隣の牌<隣の牌<B>>],[C, 隣の牌<C>, 隣の牌<隣の牌<C>>],[D, 隣の牌<D>, 隣の牌<隣の牌<D>>],],} ?["平和"] :[]        :[]      :[]    :[]  :[]