NPath値とは何でしょうか

Question

最近自分の扱っているコードについて、
データを取ってみたくなったので、
phpmdを導入し、ためしに以下のようなコマンドを実行してみました。

$ phpmd hoge.php text codesize  

すると、以下のようなメッセージが出力されました。

The method init() has an NPath complexity of 1536. The configured NPath complexity threshold is 200.

「NPath複雑値が1558あります。複雑度のしきい値は200です。」
といったようなことが書かれていると現状、把握しています。

ただ、NPathが何なのかが調べてみてもよくわかりませんでしたので、
ご教示をいただきたく思います。
よろしくお願いします。

Answer 1

NPathとは関数の中の可能性のあるパス(経路)数です。
例えば以下のようにif文が２つ関数があった場合、最初のif文は3パターンの分岐があり、2つ目のif文は2パターンの分岐があるので、関数全体では2☓3=6となりNPathは6になります。

    public function hoge() {
        // 3パターンの分岐
        if($hoge == 1) {
            $hoge = 0;
        } else if($hoge == 2) {
            $hoge = 1;
        }

        // 2パターンの分岐
        if($hogege == 1) {
            $hogege = 0;
        }
    }

一つの関数内のたくさんの分岐があると組み合わせも多くなり、NPathの値も多くなります。組み合わせが多いということは複雑なコードで可読性も落ちますし、その分テストも大変になります。
※ただ、複雑さを測る指標の一つなので参考程度にみればいいと思いますよ。
※ご自身で分岐を増やしたり、減らしたりしてNPathの値がどう変わるかみると理解が深まると思いますよ

phpmdのjava版であるcheckstyleには詳しい説明が載っているので参考にしてください。言語は違っても基本的な考え方は同じです。

余談ですが、同じような指標で循環的複雑度(Cyclomatic Complexity)というものもあります。phpmdにもあります。こっちの方はネット中にも情報が多いですね

Comments

[hmaeyama]

回答ありがとうございます。
大変わかりやすく、おかげで理解できましたのでベストアンサーにさせていただきます。