[Go] スライスのshift関数を実装したい

Question

RubyにおけるArray#shiftと同様の関数を実装したい

素朴に以下のように書いたところ期待とは異なる挙動をしました。

shiftの実装

func shift(ls []int) int {
	x := ls[0]
	ls = ls[1:]
	return x
}

実行結果

もとのスライスが変更されていませんでした。

func main() {
	ls := []int{1, 2, 3}
	x := shift(ls)
	fmt.Println(x, ls)
}

$ go run main.go
1 [1 2 3]

また、こちらの質問を参考にappendを使うようにしても思うような結果が得られませんでした。

appendを使った場合

func shift(ls []int) int {
	x := ls[0]
	ls = append(ls[:0], ls[1:]...)
	return x
}

実行結果

もとのスライスの最後の要素が重複しているようでした。

$ go run main.go
1 [2 3 3]

質問

1. 最初の実装ではなぜもとのスライスが変更されないのでしょうか？
2. appendを使った実装ではなぜ最後の要素が重複しているのでしょうか？
3. 期待する結果を得るにはどのように実装したらいいのでしょうか？

なお、以下のように関数を定義せずに同様のことができることは存じておりますので、この方向性でやるとしたらどのようにしたらよいかをお伺いしたいです。

ls := []int{1,2,3}
x := ls[0]
ls = ls[1:]

環境

$ go version
go version go1.10 linux/amd64

Answer 1

１.

スライスは参照用の値と実体の配列の２段構造です。

ls := []int{1, 2, 3}

とスライスを作ると、[1 2 3]という配列がメモリに確保され、
その参照用の値

Slice{ptr:<配列の参照先ポインタ>,len:3, cap:3}

というのに等価な構造体がスライスなのです。

なので、スライスを引数に載せたり、返値を受け渡す際に
構造体のコピーが発生します。
なので、引数に渡す前と受け取ったものは複製されており別物です。
（指してる配列は同じですが）
別物をいくら加工しようが元のスライスは影響ありません。
（配列値を変更すればもちろん影響あります）

詳しくはこちら

２.

appendではスライス値の再代入を行っているのでちゃんとスライス構造の変化が反映されます。
これけっこう説明ややこしいですね。あとで書き直します。

https://play.golang.org/p/veZLmIk1kGT

func shift(ls []int) int {
	x := ls[0]
	ls = append(ls[:0], ls[1:]...)
	fmt.Printf("ls: %[1]v(%[1]p)\n", ls)
	return x
}
func main() {
	s := []int{1, 2, 3}
	x := shift(s)
	fmt.Printf("s: %[1]v(%[1]p)\n", s)
	fmt.Println("x:",x)
}

詳しくは・・・のページを読んだあとで、
上記ようにポインタアドレスを表示するようにすると見えてくるかもしれません。
xとlsの配列へのポインタは同じ値です。

ls = append(ls[:0], ls[1:]...)

この時何が行われているのかというと、

• （元配列は[1 2 3]）
• lsの配列ポインタの先にls[1:]の内容をコピーする
• （元配列は[2 3 3] に変更される）
• lsというスライスは元配列の先頭から長さ２のスライスになる
• このlsを表示すると「[]int{2 3}」
• shit関数呼び出し元のsというスライスは変更されないので元配列を指す長さ３のスライスのまま
• このsを表示すると「[]int{2 3 3}」となる

３.

以下の形であれば動作すると思います。

https://play.golang.org/p/ITqY6PmOFiA

func shift(in []int) (int, []int) {
    return in[0], in[1:]
}
func main() {
    s := []int{1,2,3}
    x, s := shift(s)
    fmt.Println(x, s)
}

もう一つの方法はスライスをポインタ渡しとします。

https://play.golang.org/p/N2lNYs4eYRc

func shift(in *[]int) int {
	res := (*in)[0]
	*in = (*in)[1:]
	return res
}
func main() {
	s := []int{1, 2, 3}
	x := shift(&s)
	fmt.Println(x, s)
}

Comments

[gorimori]

nobonoboさん

とても詳細な解説ありがとうございました。具体的な実装コードまで提示していただけてとても勉強になります。

1は、
- スライスは配列へのポインタと長さ、キャパシティで構成されており、引数としてスライスを渡した（コピーされた）場合でももとの配列へのポインタを持っているため配列の値を変更できる。

- つまりコピー元のスライスを変更できるが、「コピーされたスライスが持っている」もとの配列へのポインタを変更しても、「コピー元のスライスが持っている」もとの配列へのポインタは影響を受けない

というふうに理解しました。

[ご提示いただいた資料](https://blog.golang.org/go-slices-usage-and-internals)の

> Slicing does not copy the slice's data. It creates a new slice value that points to the original array.

という部分と解説がとてもわかりやすかったです。

2の解説もよく理解できました。何が起きているのかまったくわからなかったので感動しました。コピーされたスライスを使って背後の配列の値を変えたとしても、もとのスライスが持っている`len`の情報が更新されないため`[]int{2,3,3}`となってしまうのですね。

3の例は、前者が「コピーされた新しいスライスをもとのスライスに代入してしまう」という作戦で、後者は「`ptr`, `len`を直接書き換えてしまう」という作戦みたいな感じでしょうか。

丁寧で詳しい解説をどうもありがとうございました。こういったことをちゃんと勉強したことがありませんでしたがとてもおもしろかったです。