投稿者: takatoh

任意のリストの合計を計算する sum メソッドを作ったときには、「足すことのできる」型クラスとして Additive という型クラスと、そのインスタンス IntAdditive、StringAdditive を作った。

今回は、リストの平均を求める average メソッドを作ってみよう。Int に限れば次のように定義することができる。要素を合計して要素数で割っているだけだ。

scala> def average(lst: List[Int]): Int = lst.foldLeft(0)((x, y) => x + y) / lst.length
average: (lst: List[Int])Int

使い方も簡単。

scala> average(List(1, 3, 5))
res0: Int = 3

さて、この average メソッドを、Int でも Double でも使えるようにしたい。

合計を求めるのには Additive を使えばいいだろう。だけどそれだけじゃ足りない。1つには、要素数で割る必要があるので割り算もできなければならない。もう1つは、要素数を求める length メソッドは Int を返すので、これを合計の型（Int か Double）に合わせてやる必要がある。

そこで、Additive をもっと一般化して、四則演算とゼロを持つ Num という型クラスを考えよう。で、Int と Double にそれぞれ対応する IntNum と DoubleNum というインスタンスを作る。ファイルは Num.scala。

trait Num[A] {
    def plus(a: A, b: A): A
    def minus(a: A, b: A): A
    def multiply(a: A, b: A): A
    def divide(a: A, b: A): A
    def zero: A
}

object Num {
    implicit object IntNum extends Num[Int] {
        def plus(a: Int, b: Int): Int = a + b
        def minus(a: Int, b: Int): Int = a - b
        def multiply(a: Int, b: Int): Int = a * b
        def divide(a: Int, b: Int): Int = a / b
        def zero: Int = 0
    }
    implicit object DoubleNum extends Num[Double] {
        def plus(a: Double, b: Double): Double = a + b
        def minus(a: Double, b: Double): Double = a - b
        def multiply(a: Double, b: Double): Double = a * b
        def divide(a: Double, b: Double): Double = a / b
        def zero: Double = 0.0
    }
}

それから、Int から変換する FromInt という型クラスと、FromIntToInt、FromIntToDoubleというインスタンスを作る。ファイルは FromInt.scala。

trait FromInt[A] {
    def to(from: Int): A
}

object FromInt {
    implicit object FromIntToInt extends FromInt[Int] {
        def to(from: Int): Int = from
    }
    implicit object FromIntToDouble extends FromInt[Double] {
        def to(from: Int): Double = from
    }
}

sbt console を起動して2つのファイルを読み込めば、準備は完了。

average メソッドの定義は次のようになる。

scala> def average[A](lst: List[A])(implicit a: Num[A], b: FromInt[A]): A = {
     |     val length: Int = lst.length
     |     val sum: A = lst.foldLeft(a.zero)((x, y) => a.plus(x, y))
     |     a.divide(sum, b.to(length))
     | }
average: [A](lst: List[A])(implicit a: Num[A], implicit b: FromInt[A])A

ここで1つ勘違いをしていたのを白状しよう。「implicit キーワードは引数リストの先頭にしか付けられない」というので、てっきり先頭の引数だけが implicit になるのだと思っていた。実際には引数リスト全体が implicit になるんだね。というわけで、ここでは a と b が implicit parameter になっている。言い換えると Num と FromInt という2つの型クラスを使っている。

さあ、最後に試してみよう。

scala> average(List(1, 3, 5))
res0: Int = 3

scala> average(List(1.5, 2.5, 3.5))
res1: Double = 2.5

このとおり、Int にも Double にも対応した average メソッドができた。

Implicit Conversion や Implicit Parameter が探索される範囲には、次のような範囲がある。

• ローカルで定義されたもの
• import で指定されたもの
• スーパークラスで定義されたもの
• コンパニオンオブジェクトで定義されたもの

ここでは、コンパニオンオブジェクトに Implicit を定義するパターンを見てみる。

新しく Rational （有理数）型を定義するとして、次のように定義する。ここでは Rational.scala ファイルに書いた。

trait Additive[A] {
    def plus(a: A, b: A): A
    def zero: A
}

case class Rational(num: Int, den: Int)

object Rational {
    implicit object RationaAdditive extends Additive[Rational] {
        def plus(a: Rational, b: Rational): Rational = {
            if (a == zero) {
                b
            } else if (b == zero) {
                a
            } else {
                Rational(a.num * b.den + b.num * a.den, a.den * b.den)
            }
        }
        def zero: Rational = Rational(0, 0)
    }
}

同じディレクトリで sbt console を起動すると自動的に読み込まれる。

で、sum メソッドを定義。なんでファイルに書かないかというと、クラスやトレイトに属さないメソッドはファイルには書けない（たぶん）から。

scala> def sum[A](lst: List[A])(implicit m: Additive[A]) = lst.foldLeft(m.zero)((x, y) => m.plus(x, y))
sum: [A](lst: List[A])(implicit m: Additive[A])A

さて、これで準備は完了。有理数の合計を求めてみる。

scala> sum(List(Rational(1, 2), Rational(1, 3)))
res0: Rational = Rational(5,6)

ちゃんと計算できた。

コンパニオンオブジェクトに Implicit を定義しておくのはわかりやすいかもしれないな。覚えておこう。

前回のエントリで見たような Implicit Parameter の使い方を、「型クラス（を使った計算）」という。

これは Haskell から持ってきたもので、Haskell の用語では Additive を型クラス、StringAdditive や IntAdditive をそのインスタンスと呼ぶ。

と、ここまで研修資料の通りに書いたところで違和感を覚えた。型クラスとインスタンスは Haskell をやったことがあるので覚えている。Implicit Parameter の使い方というよりは、型パラメータを持った Additive と具体的な型について実装した StringAdditive や IntAdditive の使いかたを型クラスとインスタンスとよび、Implicit Parameter を使うと簡潔に書ける、といったほうが正解だろう（と思う）。

いずれにしても Scala において型クラスとインスタンスは重要な位置を占めているらしいので、次回からもう少し見ていく。

Implicit Parameter のもう1つの使い方。順を追ってみていく。

何らかのリストの合計を求めるメソッド sum を考える。ポイントは何のリストかわからない（あるいは何のリストでもいいように）、というところだ。

Scala は静的型付け言語なので単純にはいかない。ではどうするかというと、まず、「足し合わせることができる」型を考える。Additive としよう。

scala> trait Additive[A] {
     |     def plus(a: A, b: A): A
     |     def zero: A
     | }
defined trait Additive

Additive は型パラメータを持っていて、これが目的のリストに要素の型になる。また、実装はしていないがメソッドを2つ宣言している。

• plus ：2つの値を足し合わせる
• zero ：ゼロに相当する値を返す

だ。

次に、この型を継承して、具体的な型についてメソッドを実装する。String と Int について実装しよう。

scala> object StringAdditive extends Additive[String] {
     |     def plus(a: String, b: String): String = a + b
     |     def zero: String = ""
     | }
defined object StringAdditive

scala> object IntAdditive extends Additive[Int] {
     |     def plus(a: Int, b: Int): Int = a + b
     |     def zero: Int = 0
     | }
defined object IntAdditive

そして最後に sum メソッド。Additive を使って、足し合わせるように実装する。

scala> def sum[A](lst: List[A])(m: Additive[A]) = lst.foldLeft(m.zero)((x, y) => m.plus(x, y))
sum: [A](lst: List[A])(m: Additive[A])A

これで出来上がり。2つ目の引数リストで Additive を受け取るところがポイント。使い方はこうする。

scala> sum(List(1, 2, 3))(IntAdditive)
res0: Int = 6

scala> sum(List("abc", "def", "ghi"))(StringAdditive)
res1: String = abcdefghi

うまく「合計」を計算できた。

さて、ここからが本題。何のリストを合計するのかはリストを見ればわかるのだから、StringAdditive とか IntAdditive を明示的に渡さなくてもうまくやってほしい。Implicit Parameter を使うとそれができる。

次のように、StringAdditive を IntAdditive の定義の前と、sum メソッドの最後に引数リストの m の前に implicit キーワードをつける。

scala> trait Additive[A] {
     |     def plus(a: A, b: A): A
     |     def zero: A
     | }
defined trait Additive

scala> implicit object StringAdditive extends Additive[String] {
     |     def plus(a: String, b: String): String = a + b
     |     def zero: String = ""
     | }
defined object StringAdditive

scala> implicit object IntAdditive extends Additive[Int] {
     |     def plus(a: Int, b: Int): Int = a + b
     |     def zero: Int = 0
     | }
defined object IntAdditive

scala> def sum[A](lst: List[A])(implicit m: Additive[A]) = lst.foldLeft(m.zero)((x, y) => m.plus(x, y))
sum: [A](lst: List[A])(implicit m: Additive[A])A

これで StringAdditive や IntAdditive を明示的に渡さなくてもよくなる。

scala> sum(List(1, 2, 3))
res0: Int = 6

scala> sum(List("abc", "def", "ghi"))
res1: String = abcdefghi

このとおり。

Implicit Parameter は暗黙の引数だ。2つの使い方があるようだけど、今日はその1つ、あちこちで共通に使われる引数を、いちいち明示的に渡すのを省略するための使い方を見ていこう。

参考にしている Dwango の研修資料では、データベースのコネクションの例が示されているけど、ここではもっと簡単な例を示す。

scala> def add(x: Int)(implicit y: Int): Int = x + y
add: (x: Int)(implicit y: Int)Int

scala> def sub(x: Int)(implicit y: Int): Int = x - y
sub: (x: Int)(implicit y: Int)Int

scala> def mul(x: Int)(implicit y: Int): Int = x * y
mul: (x: Int)(implicit y: Int)Int

Implicit Parameter を使うには、引数宣言に implicit キーワードをつけるだけだ。ただし、implicit キーワードをつけられるのは引数リストの最初に引数だけ、という制約があるので、通常は複数の引数リストを持つメソッドにして最後に Implicit Parameter を持ってくるようだ。

さて、これらのメソッドを呼び出すと、Scala は現在のスコープで直近にある implicit とマークされた変数の値を、Implicit Parameter としてメソッドに引き渡す。具体的には次のようにする。

scala> implicit val z: Int = 2
z: Int = 2

scala> add(3)
res0: Int = 5

scala> sub(3)
res1: Int = 1

scala> mul(3)
res2: Int = 6

implicit val で宣言された変数 z が、メソッド呼び出しの時に暗黙に引き渡されている。

ここで、新しい変数を implicit で宣言したらどうなるだろう。

scala> implicit val z1: Int = 5
z1: Int = 5

scala> add(3)
<console>:15: error: ambiguous implicit values:
 both value z of type => Int
 and value z1 of type => Int
 match expected type Int
       add(3)
          ^

おや、エラーになった。どうやら、期待する Implicit Parameter にマッチする値が2つあるせいのようだ。こういう使い方はできないらしい。

明示的に渡してやったらどうだろう。

scala> add(3)(z1)
res4: Int = 8

ああ、これは普通にいけるのね。

というかさあ、こういうあちこちで使いまわす変数っていうのは、オブジェクト指向的にはオブジェクトのメンバー変数にしておくんだろうけど、Scala では違うんだろうか。