2019年度「プログラミング言語」配布資料 (5)

五十嵐 淳 (京都大学大学院情報学研究科 通信情報システム専攻)

2019年10月12日

[ 前の資料 | 講義ホームページ・トップ | 次の資料 ]

under construction 2019年度用に改訂予定

ビジターパターンによる操作とデータの分離 (java/bstVisitor)

Java のプログラムでは,ある種類のデータに関する処理が全てひとつのクラスにまとまっているために,データの種類を追加したい場合には,クラスを新たに定義するだけで済むため,データ定義の拡張性に優れている.一方で,操作単位で見てみると,定義が複数のクラスに散らばっているために見通しが悪い.

この点を改善するひとつの方法は,動的ディスパッチに頼らずにデータの種類についての場合分けを行ってアルゴリズムを記述することが考えられる.(これは,上記の null を使った方法と思ってよい.null を使わなくても,isLeafisBranch のようなメソッドを用意したり,Java であれば instanceof 演算子を使えば,オブジェクトが作られたクラスがわかるので,この方法は null を使うのに特有ではないことに注意せよ.)

ここで紹介する,ビジターパターン1は,動的ディスパッチを活用しながら,データに対する操作をデータ定義から分離してプログラムを構成する方法である.find などの2分木に対する操作は,一般的に

から構成されている.講義資料その(2)では,これを,

ということにしてプログラムを組んでいた.ビジターパターンでは,操作を表す,ビジターと呼ばれるオブジェクトを用意し,

という形でクラスを構成する.

find 操作のビジターによる定義

文章で書くだけではわかりにくいので,find 操作の例を見てみよう.まず,インターフェースには,これまでと違い accept というメソッドだけが宣言されている.そして引数は Find 型となっている.これが,これから定義する find 操作を表すビジターのクラス名である.

public interface BinarySearchTree {
    boolean accept(Find v);
}

次に,Find の定義を見てみよう.

public class Find {
    private int n;

    public Find(int n) {
        this.n = n;
    }

    public boolean caseLeaf() {
        return false;
    }

    public boolean caseBranch(BinarySearchTree left, int v, BinarySearchTree right) {
        if (n == v) {
            return true;
        } else if (n < v) {
            return left.accept(this);
        } else /* n > v */ {
            return right.accept(this);
        }
    }
}

caseLeafcaseBranch というメソッドがあって,この中身は葉の場合の処理,枝の場合の処理がほぼそのままコピーされている.また,探索する整数 n は,Find クラスのインスタンス変数として宣言されている.このFind クラスのオブジェクト,例えば new Find(5) は「5 を探索する操作」を表すオブジェクトとして機能する.2分木に対して探索をしたい場合には,以下のように accept メソッドの引数として Find オブジェクトを渡すことになる.

BinarySearchTree t = ...;
boolean b = t.accept(new Find(5));  // Does t store 5?

さて,上のように accept を呼ぶと,tLeafBranch いずれかの accept メソッドを呼ぶことになる.仕上げは,それぞれの accept メソッドから,引数として渡された Find オブジェクトに対し caseLeaf または caseBranch を呼ぶように LeafBranch を定義することにある.

public class Leaf implements BinarySearchTree {
    public Leaf() {
    }

    public boolean accept(Find visitor) {
        return visitor.caseLeaf();
    }
}

public class Branch implements BinarySearchTree {
    private BinarySearchTree left;
    private int v;
    private BinarySearchTree right;

    public Branch(BinarySearchTree left, int v, BinarySearchTree right) {
        this.left = left;
        this.v = v;
        this.right = right;
    }

    public boolean accept(Find visitor) {
        return visitor.caseBranch(left, v, right);
    }
}

6行目と22行目が肝である.受け取った visitor に対し,Leaf クラスでは caseLeaf を,Branch クラスでは caseBranch を呼ぶことで,葉・枝それぞれに対する処理をするわけである.この際,(枝の場合)インスタンス変数もビジターに渡してあげるのも大事な点である2

find 操作の動作

さて,このように定義されたプログラムの動作を シーケンス図(sequence diagram) を使って説明しよう.シーケンス図はクラス図と同様に UML 記法のひとつで,複数のオブジェクト間のメソッド呼出しの関係を時系列で示したものである.例えば,

// 呼出し元
BinarySearchTree t1 = new Leaf();
System.out.println(t1.accept(new Find(5))); // should display false

には,t1 (が指す)オブジェクトと Find オブジェクトが登場するが,t1.accept(new Find(5)) の動作を記述したシーケンス図は下のようになる.

図だけ見れば,なんとなく何を意味しているか想像できるかもしれないが,

このシーケンス図の場合,

  1. 呼出し元が,Find クラスのオブジェクトを生成し,
  2. t1accept メソッドを呼出し,
  3. accept メソッドが,caseLeaf を呼出し,
  4. caseLeaffalse を返し,
  5. accept メソッドが,(caseLeaf から返ってきた)false を最初の呼出し元に返した という時系列を表している.ポイントは,t1Leaf オブジェクトであるために caseLeaf が呼ばれた,というところである.

一方,t1Branch である時を考えてみよう.呼出し元のプログラムは以下のようなものを考える.

// Definitions of t3, t4, t5, v1, v2, n, ...
BinarySearchTree t2 = new Branch(t4,v2,t5);
BinarySearchTree t1 = new Branch(t2,v1,t3);
System.out.println(t1.accept(new Find(n)));

ここで,n < v1 が成り立っているとする.すなわち,n の探索は t1 から t2 に続いていく.このプログラムに対するシーケンス図は以下のようになる.

今度は,t1Branch なので,accept に続いて Find オブジェクトの caseBranch メソッドが呼出されているのがポイントである.その際,t1 のインスタンス変数がごっそりビジターに渡されて,その中で nv1 の比較が行われる.次は,左の部分木 t2 に対する再帰呼出しだが,これはビジター内の処理を呼出し元として,再び accept メソッドを呼ぶことで行われる.その結果,t2 に対する accept の呼出しは,再び caseBranch の呼出しとなって戻ってくる.一回目の caseBranch の処理が途中のまま,再び caseBranch が呼出されていることを示すため,ライフラインが二重に太くなっている.この先の処理は nv2 の大小に依存するが,そこは書いていない.(nv2 が等しい場合にはすぐに true を返すので必ずしも,accept 呼出しが発生するわけではない.)その後,truefalse が決定されたら,それがたらい回しに元来た経路を辿って,呼出し元まで伝播していく.

かなりややこしい経過を辿るが(特に Find のメソッド呼出しの途中で,また Find のメソッドが呼ばれる,というのが,わかりにくいような気がする),このようにして find 操作が実現でき,かつ,find 操作の本質的な部分を一箇所(すなわち Find クラス)に集めることができた.

もう一度,復習すると,ビジターの原理は,

ここまでは find 操作に特化したプログラムを書いたが,以下は,このパターンを,色々な操作を同時に使えるように一般化していく.

パターンへの一般化

上にあげたプログラムでは accept メソッドの引数が,特定のクラスである Find に固定されてしまっていたため,探索操作しかできない.一般には色々な操作をビジターとして定義したいわけだが,操作毎に(別の名前の) accept を定義するのでは使い勝手が悪い.そこで,最初の一般化として, boolean を返す操作一般 をうまく扱えるようにする.そのために,ビジターのためのインターフェースを定義し,Find (や,その他 boolean を返すビジターのクラス) はそのインターフェースを implements して定義するようにする.

まず,クラス図を示そう.

インターフェース間の矢印は相互に依存関係があることを示している(「矢じり」が,implements を表すものと違うことに注意).BSTVisitorB が「booleanを返す2分木に対する操作一般」を表すためのインターフェースであり,accept メソッドも Find 決めうちではなく,BSTVisitorB を引数としている.FindBSTVisitorBimplements する形で定義するため,accept に渡すことができる.他にも BSTVisitorBimplements したクラスを追加する(caseLeafcaseBranch の具体的な定義を与える)ことで,2分木に対する操作を, 既存のクラスの変更をすることなく 追加することができる.

ここまで一般化すると「パターン」と呼ぶにふさわしくなってくる.

返り値の違うビジターの扱い

上の方法で,boolean を返す操作については一般的に扱うことができるが,他の型(例えば挿入・削除のように2分木や min のように int)を返す操作を追加する場合は,別のインターフェースを用意する.

配布しているソースコードは,この方針で定義されている.クラス・インターフェースの数はかなり増えてしまうが,例えば Insert クラスに書かれていることは,本質的に OCaml プログラムの insert 関数と同じことであることがわかるのではないだろうか.

let rec insert(t, n) =
  match t with
    Lf -> Br {left=Lf; value=n; right=Lf}
  | Br {left=l; value=v; right=r} ->
     if n = v then t
     else if n < v then 
       let new_left = insert(l, n) in
       Br {left=new_left; value=v; right=r}
     else (* n > v *)
       let new_right = insert(r, n) in
       Br {left=l;        value=v; right=new_right}
public class Insert implements BSTVisitorBST {
    private int n;
    
    // constructor is omitted

    public BinarySearchTree caseLeaf() {
        return new Branch(new Leaf(), n, new Leaf());
    }

    public BinarySearchTree caseBranch(BinarySearchTree left, int v, BinarySearchTree right) {
        if (n == v) {
            return new Branch(left, v, right);
        } else if (n < v) {
            BinarySearchTree newLeft = left.accept(this);
            return new Branch(newLeft, v, right);
        } else /* n > v */ {
            BinarySearchTree newRight = right.accept(this);
            return new Branch(left, v, newRight);
        }
    }
}

さらに一般化

インターフェースを増やさずに様々な返り値型のビジターを扱う方法もあるが,ここまでで習った Java 言語の機能だけでは難しい.この点への対処については,時間があればカバーしたい.また,データの種類を増やしたい場合には,ビジターのインターフェースからビジタークラスまで,caseXXX メソッドを増やす必要があり,結局,OCaml のような関数を使った方法と同様な不便さがある.

その他

これらのバリエーションを組み合わせる,というのも考えられる.

ビジターパターンは動的ディスパッチに依存しているので,葉を null ポインタで表現する方法と組み合わせることはできない.


[ 前の資料 | 講義ホームページ・トップ | 次の資料 ]


  1. オブジェクト指向言語でのプログラミングイディオムのいくつかはデザインパターン(design pattern)と呼ばれている.デザインパターンには,ここで紹介するビジターパターン以外にも多数あって,講義資料その(2)で導入した,インターフェースとクラスを使ったデータ構造の表現方法もコンポジットパターンと呼ばれている.

  2. オブジェクトを丸ごとビジターに渡すことも多い(正式なビジターパターンの定義ではそうなっている)が,ここでは他のやり方との比較をやりやすくするためにインスタンス変数を渡すようにプログラムを書いている.


Copyright 五十嵐 淳, 2016, 2017, 2018, 2019