インターフェイス

インターフェイスとは、異なる型の構造体を同じ型として扱うための抽象型のようなものだ。Java のインターフェイスと同様らしいけど Java のことはよく知らない。インターフェイスにはメソッドの型だけが定義されていて、そのメソッドすべてを実装した構造体はインターフェイスの型として扱えるようになる。

次の例では、インターフェイス Point を定義している。Point 型は distance0 というメソッドを持っている。Point2dPoint3d というのが具体的な構造体で、そのどちらもが distance0 メソッドを実装しているので、Point 型として1つのスライスに格納されている。

package main

import (
    "fmt"
    "math"
)

type Point interface {
    distance0() float64
}

type Point2d struct {
    x, y float64
}

func newPoint2d(x, y float64) *Point2d {
    p := new(Point2d)
    p.x, p.y = x, y
    return p
}

func (p *Point2d) distance0() float64 {
    return math.Sqrt(p.x * p.x + p.y * p.y)
}

type Point3d struct {
    x, y, z float64
}

func newPoint3d(x, y, z float64) *Point3d {
    p := new(Point3d)
    p.x, p.y, p.z = x, y, z
    return p
}

func (p *Point3d) distance0() float64 {
    return math.Sqrt(p.x * p.x + p.y * p.y + p.z * p.z)
}

func sumOfDistance0(ary []Point) float64 {
    sum := 0.0
    for _, p := range ary {
        sum += p.distance0()
    }
    return sum
}

func main() {
    a := []Point{
        newPoint2d(0, 0),
        newPoint2d(10, 10),
        newPoint3d(0, 0, 0),
        newPoint3d(10, 10, 10),
    }

    fmt.Println(a[0].distance0())
    fmt.Println(a[1].distance0())
    fmt.Println(a[2].distance0())
    fmt.Println(a[3].distance0())
    fmt.Println(sumOfDistance0(a))
}
^o^ > go run interface.go
0
14.142135623730951
0
17.320508075688775
31.462643699419726

構造体の埋め込み

Go はオブジェクト指向言語ではないけど、「構造体の埋め込み」という機能によって、似たようなことができる。
例を見てみよう。構造体 Bar にはフィールド foo として構造体 Foo が指定されている。これは単に、フィールドが構造体なだけであって、埋め込みとは言わない。一方、構造体 Baz にはフィールド名を省略して Foo が指定されている。これを匿名フィールドと言って、Baz には Foo のフィールドやメソッドが引き継がれる。これを構造体の埋め込みという。

package main

import "fmt"

type Foo struct {
    a, b int
}

func (x Foo) printA() {
    fmt.Println("a =", x.a)
}

func (x Foo) printB() {
    fmt.Println("b =", x.b)
}

type Bar struct {
    foo Foo
    c int
}

func (x Bar) printC() {
    fmt.Println("c =", x.c)
}

type Baz struct {
    Foo
    c int
}

func (x Baz) printB() {
    fmt.Print("Baz:")
    x.Foo.printB()
}

func (x Baz) printC() {
    fmt.Println("c =", x.c)
}

func main() {
    x := Foo{ 1,2 }
    y := Bar{ Foo{ 10,20 }, 30 }
    z := Baz{ Foo{ 100,200 }, 300 }

    x.printA()
    x.printB()
    y.foo.printA()
    // y.printA() エラー
    y.foo.printB()
    // y.printB() エラー
    y.printC()
    z.printA()
    z.printB()
    z.printC()
}

変数 y は構造体 Bar で、Foo を埋め込んでいないので、y.printA() のようなメソッド呼び出しはできない。一方、変数 zFoo を埋め込んでいるので、z.printA() のように Foo のメソッドを呼び出すことができる。

o^ > go run struct_embed.go
a = 1
b = 2
a = 10
b = 20
c = 30
a = 100
Baz:b = 200
c = 300

複数の構造体を埋め込むこともできる。ただし、埋め込んだ構造体同士でフィールド名やメソッド名が重複すると、やや面倒になる。次の例では、構造体 Baz には FooBar が埋め込んであるけど、フィールド a とメソッド printA が重複している。こういう時は構造体名を明示して呼び出さなければならない。

package main

import "fmt"

type Foo struct {
    a, b int
}

func (p *Foo) printA() {
    fmt.Println(p.a)
}

func (p *Foo) printB() {
    fmt.Println(p.b)
}

type Bar struct {
    a, c int
}

func (p *Bar) printA() {
    fmt.Println(p.a)
}

func (p *Bar) printC() {
    fmt.Println(p.c)
}

type Baz struct {
    Foo
    Bar
}

func main() {
    x := new(Baz)
    x.Bar.a = 10
    x.b = 20
    x.c = 30
    x.Foo.printA()
    x.printB()
    x.printC()
}
^o^ > go run struct_embed2.go
0
20
30

連結リスト

連結リストとは、値を保持するセルが数珠つなぎになった構造、つまり Scheme のリストと同じ構造だ。
今日は構造体やメソッドの練習として、連結リストのプログラムを写経してみる。
書き忘れていたけど、Go の一連の勉強は↓このページに沿ってやっている。

cf. お気楽 Go 言語プログラミング入門 – M.Hiroi’s Home Page

連結リストがあるのはこのページの中ほど。

cf. お気楽 Go 言語プログラミング入門 構造体 – M.Hiroi’s Home Page

それじゃ、行ってみよう。

package main

import (
    "fmt"
)

type Cell struct {
    item int
    next *Cell
}

type List struct {
    top *Cell
}

func newCell(x int, cp *Cell) *Cell {
    c := new(Cell)
    c.item, c.next = x, cp
    return c
}

func newList() *List {
    lst := new(List)
    lst.top = new(Cell)
    return lst
}

func (cp *Cell) nthCell(n int) *Cell {
    i := -1
    for cp != nil {
        if i == n { return cp }
        i++
        cp = cp.next
    }
    return nil
}

func (lst *List) nth(n int) (int, bool) {
    cp := lst.top.nthCell(n)
    if cp == nil {
        return 0, false
    } else {
        return cp.item, true
    }
}

func (lst *List) insertNth(n, x int) bool {
    cp := lst.top.nthCell(n - 1)
    if cp == nil {
        return false
    } else {
        cp.next = newCell(x, cp.next)
        return true
    }
}

func (lst *List) deleteNth(n int) bool {
    cp := lst.top.nthCell(n - 1)
    if cp == nil || cp.next == nil {
        return false
    } else {
        cp.next = cp.next.next
        return true
    }
}

func (lst *List) isEmpty() bool {
    return lst.top.next == nil
}

func (lst *List) printList() {
    cp := lst.top.next
    for ; cp != nil; cp = cp.next {
        fmt.Print(cp.item, " ")
    }
    fmt.Println("")
}

func main() {
    a := newList()
    for i := 0; i < 4; i++ {
        fmt.Println(a.insertNth(i, i))
    }
    a.printList()
    for i := 0; i < 5; i++ {
        n, ok := a.nth(i)
        fmt.Println(n, ok)
    }
    for !a.isEmpty() {
        a.deleteNth(0)
        a.printList()
    }
}

それほど難しくはない。ちょっと注意が必要なのは、List 構造体の top フィールドに入っている Cell 構造体はダミーで、その次の Cell が0番目の Cell になってるってところかな。
実行結果:

^o^ > go run linkedlist.go
true
true
true
true
0 1 2 3
0 true
1 true
2 true
3 true
0 false
1 2 3
2 3
3

うまくいった。

メソッド

メソッドは、構造体(の型)と結びつけられた関数だ。Go はオブジェクト指向プログラミング言語ではないけど、このメソッドや構造体の埋め込み(これについては後で書くつもり)によって、オブジェクト指向的なプログラミングができるようになっている。
例を挙げよう。
前のエントリでは平面上の点を表す Point 構造体と、2点間の距離を求める distance 関数を作った。ここでもう一つ、3次元空間の点を表す Point3d 構造体を作る。この2点間の距離を求める関数を考えたとき、distance という名前は使えない。すでに名前を使ってしまっているからだ。
ところが、これらをそれぞれの構造体のメソッドにすれば、両方とも distance という名前にできる。
メソッドの一般亭な定義は次の通り。

func (仮引数 *型) 関数名(仮引数, ...) {
    処理
}

ここで、関数名の前のカッコの中にある仮引数をレシーバと言い、このメソッドはレシーバの型と結びつけられる。これで、PointPoint3d の両方の構造体に、同じ distance という名前のメソッドが定義できるわけだ。
実際に書いてみよう。

package main

import (
    "fmt"
    "math"
)

type Point struct {
    x, y float64
}

type Point3d struct {
    x, y, z float64
}

func newPoint(x, y float64) *Point {
    p := new(Point)
    p.x, p.y = x, y
    return p
}

func newPoint3d(x, y, z float64) *Point3d {
    p := new(Point3d)
    p.x, p.y, p.z = x, y, z
    return p
}

func (p *Point) distance(q *Point) float64 {
    dx := p.x - q.x
    dy := p.y - q.y
    return math.Sqrt(dx * dx + dy * dy)
}

func (p *Point3d) distance(q *Point3d) float64 {
    dx := p.x - q.x
    dy := p.y - q.y
    dz := p.z - q.z
    return math.Sqrt(dx * dx + dy * dy + dz * dz)
}

func main() {
    p1 := newPoint(0.0, 0.0)
    p2 := newPoint(10.0, 10.0)
    q1 := newPoint3d(0.0, 0.0, 0.0)
    q2 := newPoint3d(10.0, 10.0, 10.0)

    fmt.Println(p1.distance(p2))
    fmt.Println(q1.distance(q2))
}
^o^ > go run method.go
14.142135623730951
17.320508075688775

構造体

構造体は、既存の型を組み合わせて新しい型を作る機能だ。とりあえずは C の構造体を同じようなものだと考えればいい。
構造体の定義は type キーワードを使って次のようにする。

type 型名 struct {
    フィールド1 型1
    フィールド2 型2
    ...
}

構造体を構成するデータは、フィールドと呼ばれる。上のようにフィールドとその型を列記すればいい。

構造体の初期化は、構造体名{フィールド1, フィールド2, …} のようにフィールドを順に並べるほか、フィールド名とそのデータを組みにして渡す方法がある。後者では定義と順番が異なってもいい。また、フィールドへのアクセスは . 演算子を使う。例を示そう。

package main

import (
    "fmt"
    "math"
)

type Point struct {
    x float64
    y float64
}

func distance(p, q Point) float64 {
    dx := p.x - q.x
    dy := p.y - q.y
    return math.Sqrt(dx * dx + dy * dy)
}

func main() {
    var o Point
    var p Point = Point{ 10.0, 10.0 }
    var q Point = Point{ y: 200.0, x: 100.0 }

    fmt.Println(o)
    fmt.Println(p)
    fmt.Println(q)

    fmt.Println(o.x)
    fmt.Println(o.y)
    fmt.Println(p.x)
    fmt.Println(p.y)
    fmt.Println(q.x)
    fmt.Println(q.y)

    fmt.Println(distance(o, p))
    fmt.Println(distance(o, q))
    fmt.Println(distance(p, q))
}

ここでは Point という名前の構造体を使っている。構造体の初期化は、main 関数の冒頭で行っている。変数 pq は上に書いたように初期化している。変数 o は初期化していないので、自動的にゼロ値に初期化される。
distance 関数の中で、構造体のフィールドにアクセスしている。

^o^ > go run struct.go
{0 0}
{10 10}
{100 200}
0
0
10
10
100
200
14.142135623730951
223.60679774997897
210.23796041628637

次は、構造体のポインタの例を示そう。構造体の場合も普通の型のように、アドレスを取得するには & を、値にアクセスするには * を使えばいい。ただし、フィールドにアクセスするときは、C のように -> を使うのではなく、. を使う。このへんは構造体の変数なのかポインタなのかを気にしなくていいので楽だな。

package main

import (
    "fmt"
    "math"
)

type Point struct {
    x float64
    y float64
}

func distance(p, q *Point) float64 {
    dx := p.x - q.x
    dy := p.y - q.y
    return math.Sqrt(dx * dx + dy * dy)
}

func main() {
    var o *Point = &Point{}
    var p *Point = &Point{ 10.0, 10.0 }
    var q *Point = new(Point)
    q.x, q.y = 100.0, 200.0

    fmt.Println(o)
    fmt.Println(p)
    fmt.Println(q)

    fmt.Println(o.x)
    fmt.Println(o.y)
    fmt.Println(p.x)
    fmt.Println(p.y)
    fmt.Println(q.x)
    fmt.Println(q.y)

    fmt.Println(distance(o, p))
    fmt.Println(distance(o, q))
    fmt.Println(distance(p, q))
}
^o^ > go run struct2.go
&{0 0}
&{10 10}
&{100 200}
0
0
10
10
100
200
14.142135623730951
223.60679774997897
210.23796041628637

構造体をポインタとして使うときは、初期化用の関数を使うのが通例のようだ。次の例では、newPoint 関数がそれにあたる。この関数は、ポインタのフィールドになる値を引数にとって、構造体のポインタを返す。

package main

import (
    "fmt"
    "math"
)

type Point struct {
    x float64
    y float64
}

func newPoint(x, y float64) *Point {
    p := new(Point)
    p.x, p.y = x, y
    return p
}

func distance(p, q *Point) float64 {
    dx := p.x - q.x
    dy := p.y - q.y
    return math.Sqrt(dx * dx + dy * dy)
}

func main() {
    var p *Point = newPoint(0.0, 0.0)
    var q *Point = newPoint(10.0, 10.0)

    fmt.Println(p)
    fmt.Println(q)

    fmt.Println(p.x)
    fmt.Println(p.y)
    fmt.Println(q.x)
    fmt.Println(q.y)

    fmt.Println(distance(p, q))
}
^o^ > go run struct3.go
&{0 0}
&{10 10}
0
0
10
10
14.142135623730951

最後に、構造体をスライスに格納する例を示して今日は終わりにしよう。構造体だからと言って何も特別なことはない。

package main

import "fmt"

type Point struct {
    x, y float64
}

func newPoint(x, y float64) *Point {
    p := new(Point)
    p.x, p.y = x, y
    return p
}

func main() {
    var a []Point = []Point{
        { x: 0.0, y: 0.0 },
        { 10.0, 10.0 },
        { 100.0, 100.0 },
    }
    var b []*Point = make([]*Point, 8)

    fmt.Println(a)
    fmt.Println(b)

    for i := 0; i < 8; i++ {
        b[i] = newPoint(float64(i), float64(i))
    }
    fmt.Println(b)
    for i := 0; i < 8; i++ {
        fmt.Println(b[i])
    }
}
^o^ > go run struct_slice.go
[{0 0} {10 10} {100 100}]
[       ]
[0xc042008270 0xc042008280 0xc042008290 0xc0420082a0 0xc0420082b0 0xc0420082c0 0xc0420082d0 0xc0420082e0]
&{0 0}
&{1 1}
&{2 2}
&{3 3}
&{4 4}
&{5 5}
&{6 6}
&{7 7}

メモリの動的割り当て

new 関数は、動的にメモリを割り当ててそのアドレス、つまりポインタを返す。

var 変数名 *型 = new(型)

例を示そう。

package main

import "fmt"

func main() {
    var p *int = new(int)
    var q *float64 = new(float64)
    var a *[8]int = new([8]int)

    fmt.Println(p)
    fmt.Println(*p)
    fmt.Println(q)
    fmt.Println(*q)
    fmt.Println(a)
    fmt.Println(*a)

    *p = 100
    *q = 1.2345
    a[0] = 10
    a[7] = 80

    fmt.Println(*p)
    fmt.Println(*q)
    fmt.Println(*a)
}
^o^ > go run dynamic_alloc.go
0xc042008210
0
0xc042008218
0
&[0 0 0 0 0 0 0 0]
[0 0 0 0 0 0 0 0]
100
1.2345
[10 0 0 0 0 0 0 80]

本題と関係ないけど、配列(と、たぶんスライスも)を指すポインタから要素へのアクセスは * をつけなくてできるんだな。

ポインタ

Go のポインタは C のポインタに似ている。変数のアドレスを得るためには & を使い、ポインタのさす値を参照するには * を使う。宣言するのに * を使うのも一緒だけど、Go の場合には変数名ではなく型の前につける。

package main

import "fmt"

func main() {
    var n int = 10
    var p *int = &n

    fmt.Println(n)
    fmt.Println(*p)

    *p = 100

    fmt.Println(n)
    fmt.Println(*p)

    fmt.Println(p)

    fmt.Println(p == &n)
}
^o^ > go run pointer.go
10
10
100
100
0xc042008210
true

C と違う点はほかにもある。Go のポインタは、整数値の代入や加減算はできないようになっている。配列のアドレスもそうだ。C では配列へのポインタはその配列の先頭要素へのポインタになっていて、各要素にアクセスするにはポインタをインクリメントしたりとかする。Go ではこういうことはできない。配列へのポインタは配列そのものへのポインタであって、配列の要素へのアクセスはできないようだ。もちろん、配列の要素へのポインタは作れる。

package main

import "fmt"

func main() {
    var a [4]int = [4]int{ 1,2,3,4 }
    var b [4]int = [4]int{ 10,20,30,40 }
    var p *[4]int = &a
    p0, p1 := &a[0], &a[1]

    fmt.Println(p)
    fmt.Println(*p)
    fmt.Println(a[0])
    // fmt.Println(*p[0]) // error

    fmt.Println(p0)
    fmt.Println(*p0)

    fmt.Println(p1)
    fmt.Println(*p1)
    fmt.Println(a[1])

    *p0 = 10
    *p1 = 20
    fmt.Println(a)

    p = &b
    fmt.Println(*p)
}
^o^ > go run pointer_array.go
&[1 2 3 4]
[1 2 3 4]
1
0xc042002700
1
0xc042002708
2
2
[10 20 3 4]
[10 20 30 40]

以前に、関数の呼び出しは値渡しだと書いた。関数のポインタを渡してやると、ポインタは仮引数にコピーされるけど、そのさしている値は呼び出し元と同じ値だ。つまり、ポインタを使えば参照渡しと同等のことかできる。

package main

import "fmt"

func swap(x *int, y *int) {
    tmp := *x
    *x = *y
    *y = tmp
}

func timesArray(n int, ary *[4]int) {
    for i := 0; i < len(*ary); i++ {
        ary[i] *= n
    }
}

func main() {
    var a int = 10
    var b int = 20
    var c [4]int = [4]int{ 1,2,3,4 }

    fmt.Println(a)
    fmt.Println(b)
    fmt.Println(c)

    swap(&a, &b)
    timesArray(10, &c)

    fmt.Println(a)
    fmt.Println(b)
    fmt.Println(c)
}
^o^ > go run pointer_call.go
10
20
[1 2 3 4]
20
10
[10 20 30 40]

さて、ポインタの基本はこんなところ。

クロージャ

昨日、一昨日のエントリで、関数を引数にとる高階関数を見てきた。今度は関数を返す関数を考えよう。
関数を返すには、return で関数を返してやればいいだけだ。それだけだと芸がないので、もう一ひねりしてみる。Go では、関数を定義した環境の変数を保持することができる。クロージャだ。
例を示そう。

package main

import "fmt"

func genCounter(init int) func() int {
    i := init
    return func() int {
        i += 1
        return i
    }
}

func main() {
    count := genCounter(0)

    fmt.Println(count())
    fmt.Println(count())
    fmt.Println(count())
}

genCounter の中で定義している匿名関数(これが genCounter の返り値になる)は、その外側にある変数 i を覚えている。なので、返り値の関数は呼び出されるごとに i をインクリメントしてから値を返す。

^o^ > go run closure.go
1
2
3

この通り。

mapcarとfilter

高階関数の練習に、mapcarfilter を作ってみた。

まずは mapcar から。

package main

import "fmt"

func mapcar(f func(int) int, a []int) []int {
    b := make([]int, 0)
    for _, x := range a {
        b = append(b, f(x))
    }
    return b
}

func square(x int) int {
    return x * x
}

func main() {
    a := []int{ 1,2,3,4,5 }
    fmt.Println(a)

    b := mapcar(square, a)
    fmt.Println(b)

    cube := func(x int) int { return x * x * x }
    c := mapcar(cube, a)
    fmt.Println(c)
}
^o^ > go run mapcar.go
[1 2 3 4 5]
[1 4 9 16 25]
[1 8 27 64 125]

つぎは filter

package main

import "fmt"

func filter(f func(int) bool, a []int) []int {
    b := make([]int, 0)
    for _, x := range a {
        if f(x) {
            b = append(b, x)
        }
    }
    return b
}

func even(i int) bool {
    return i % 2 == 0
}

func main() {
    a := []int{ 1,2,3,4,5,6,7,8,9 }
    b := filter(even, a)
    fmt.Println(b)
}
^o^ > go run filter.go
[2 4 6 8]

高階関数と匿名関数

Go では高階関数もサポートされている。
引数の型のところに関数の型を書けばいい。関数の型は func(引数の型のリスト) 返り値の型 というふうに書く。説明するより、例を見たほうが早いだろう。

package main

import "fmt"

func square(x int) int {
    return x * x
}

func cube(x int) int {
    return x * x * x
}

func sumOf(f func(int) int, m, n int) int {
    a := 0
    for ; m <= n; m++ {
        a += f(m)
    }
    return a
}

func main() {
    fmt.Println("SUm of squares:", sumOf(square, 1, 5))
    fmt.Println("SUm of cubes: ", sumOf(cube, 1, 5))
}

sumOf が高階関数。最初の引数が関数になっていて、f func(int) int と書いてあるのがそれだ。
実行すると:

^o^ > go run sumof.go
SUm of squares: 55
SUm of cubes:   225

あたりまえだけど、きちんと動く。

さて、上の例にある squarecube みたいな短い関数ならわざわざ定義してから使わなくても、使う場所、つまり sumOf の引数のところに書いてしまうこともできる。匿名関数、または無名関数ってやつだね。こんどはこの匿名関数を使ってみよう。

package main

import "fmt"

func sumOf(f func(int) int, m, n int) int {
    a := 0
    for ; m <= n; m++ {
        a += f(m)
    }
    return a
}

func main() {
    fmt.Println("Sum of squares:", sumOf(func(x int) int { return x * x }, 1, 5))
    fmt.Println("SUm of cubes: ", sumOf(func(x int) int { return x * x * x }, 1, 5))
}
^o^ > go run sumof2.go
Sum of squares: 55
SUm of cubes:   225

この通り、匿名関数をつかっても期待通りに動く。とはいえ、匿名関数も型を明示的に書かなきゃいけないのはちょっとお手軽感がないなぁ。