Revitモデルから警備員の巡回路を求める

# はじめに
__[DANSO（建築情報学会） Advent Calendar 2022](https://qiita.com/advent-calendar/2022/ais-j-danso)__ の13日目の記事です。
この記事は12日目の記事の続編です。

https://qiita.com/Z0E/items/c695e20c82010c6986ea

前回 __NetworkX__ でつくったグラフマップを使って巡回セールスマン問題を解きます。

:::note warn
本記事では巡回セールスマン問題を解くアルゴリズム中身については詳しく解説せず、実装方法のみ紹介します。
:::



# 最短の巡回路を求めたい

大学を巡回する警備員はエレベーターホールから出発し、フロアの研究室・教室を1回だけ訪れてエレベーターホールに戻ります。この条件を満たす巡回路において、警備員が歩く距離（経路コスト）が最小のものを求めます。

この問題は __巡回セールスマン問題（TSP：Traveling Salesman Problem）__ の類似問題として解決することができます。TSPとは、$V$ 頂点からなる重み付き完全グラフについて、全ての頂点をちょうど一度ずつ巡り出発地に戻る巡回路のうち、総移動コスト（重みの合計）が最小のものを求める組合せ最適化問題です。TSPの解法は最適化分野で古くから研究されており、集積回路の設計や運送会社の配送計画などに応用されています。


TPSの解法は様々な手法が提案されていますが、大きく分けて以下の2つに分類されます。
* __厳密解法__：厳密解を求める解法です。$V$ が大きくなると計算量が急増するため実用的ではありません。
* __近似解法__：精度がある程度よい近似解を求める解法です。$V$ がある程度大きくても高速に解を求めることができます。



# 計算用の完全グラフをつくる
前回扱ったグラフマップは、機械室や廊下など巡回する必要のない部屋が頂点に含まれています。またグラフマップは完全グラフではないため、TSPのモデルをそのまま適用することはできません。そこでグラフマップから不要な頂点を取り除き、さらに残りの頂点間のパスを再計算することで、計算用の完全グラフをつくります。

### グラフマップをロードする
前回と同様にしてJSONファイルからグラフマップを復元します。

```py3:pythonスクリプト
import json
import networkx as nx

def read_json_file(path):
    with open(path, "r", encoding="utf-8") as json_file:
        json_data = json.load(json_file)
    return nx.readwrite.json_graph.node_link_graph(json_data)
    
graph = read_json_file(<ファイルパス>)
```

グラフを描画します。$115$ 頂点、$1030$ 辺からなるグラフです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2059946/bbf0c8cd-f146-094b-3de9-fa9f6d84e73c.png)


### グラフマップを完全グラフに変換する
`nx.Graph()`で新しく無向グラフをつくり、グラフマップの各頂点の中で名前が「部屋○○」「教室○○」「エレベーターホール」のものを`add_nodes()`で追加します。
次に`nx.dijkstra_path()` `nx.dijkstra_path_length()`で追加された頂点間の最短経路とその距離を取得します。`add_edge()`で頂点間の辺をつくり、最短経路と距離を辺にタグ付けします。

```py3:pythonスクリプト
from itertools import combinations

def get_complete_graph(graph):
    complete_graph = nx.Graph()
    # node
    for node, tag in graph.nodes(data=True):
        if node[:2] in ("部屋", "教室"): complete_graph.add_node(node, x=tag["x"], y=tag["y"])
    # edge
    for node1, node2 in combinations(complete_graph.nodes, 2):
        path = nx.dijkstra_path(graph, node1, node2)
        length = nx.dijkstra_path_length(graph, node1, node2)
        complete_graph.add_edge(node1, node2, weight=length, path=path)
    return complete_graph

complete_graph = get_complete_graph(graph)
```

$V_{1}$ 頂点、$E_{1}$ 辺からなるグラフマップを $V_{2}$ 頂点からなる完全グラフに変換するとき、計算量は $O(V_{2}^2 E_{1} logV_{1})$ となるため短時間で実行できることが分かります。

グラフを描画します。$23$ 頂点からなる完全グラフで、各辺に最短経路がタグ付けされていることが分かります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2059946/27f3df93-6b85-5382-b0be-98c504c001a5.png)



# 遺伝的アルゴリズムで巡回路を求める
はじめに述べたように、TSPの厳密解法はグラフの頂点数が増加すると計算量が急増してしまいます。例えば $V=30$ の場合、巡回路の組み合わせは $4.42×10^{30}$ 通りとなり、これをすべて計算するのは現実的ではありません。そのため現実的な時間で近似解を求められるアルゴリズムを用います。TSPやその他多くの最適化問題で用いられる近似アルゴリズムとして、以下のようなものがあげられます。

* ランダムサーチ
* 山登り法
* 焼きなまし法
* 遺伝的アルゴリズム


今回は以下の記事を参考にして、__遺伝的アルゴリズム（GA:Genetic Algorithm）__ でTPSの解を求めます。※目的関数など記事と異なる箇所もあります

https://mukai-lab.info/pages/classes/artificial_intelligence/chapter11/

GAは生物の遺伝子の進化を模したアルゴリズムです。部屋の訪問順の並びを生物個体の遺伝子に見立て、同世代の個体の中で「選択」「突然変異」「交叉」と呼ばれる操作を行って次世代を生み出すことを繰り返し、最適解を探索します。GAは最適化問題の解法としては応用性が高く、多峰性の問題にも強という特徴があります。

### SimpleAIとは
__SimpleAI__ はお手軽に探索アルゴリズムを実装できる Pythonパッケージです。
```py3:pythonスクリプト
import random, copy
from simpleai.search import SearchProblem
from simpleai.search.local import genetic
```

### 個体の遺伝子を定義する

以下のようなルールで巡回路から個体の遺伝子（数列）を求めます。

>`graph.nodes()`で頂点リストを求め、巡回路の全ての頂点について以下の操作を繰り返します。
>1. 巡回路の $i$ 番目の頂点 $V_{i}$ が、頂点リストの中で $j$ 番目にあるとき、遺伝子の $i$ 番目の染色体を $j$ とする
>2. 頂点リストから頂点 $V_{i}$を取り除く
>
>例えば`[A,B,C,D] = graph.nodes()`のとき、巡回路`[A,D,C,B]`から個体`0,2,1,0`が求まります。

個体から巡回路を生成する関数を定義します。
```py3:pythonスクリプト
def gene_2_route(gene):
    destinations = list(copy.deepcopy(complete_graph.nodes))
    route = []
    for index in gene:
        node = destinations[index]
        destinations.pop(index)
        route.append(node)
    route.append(route[0])
    return route
```


### GAを実装する
__Simple AI__ の`SearchProblem`クラスを継承して`TSPGA`クラスをつくり、`value()`　`generate_random_state()` `crossover()` `mutate()`の4つのメソッドをオーバーライドします。

__「選択」__`value()`
個体から巡回路を求めて経路コストを計算し、より低コストな個体を選ぶ操作です。

__「初期値生成」__`generate_random_state()`
個体の初期値をランダムに生成する操作です。

__「交叉」__`crossover()`
２つの個体がもつ遺伝子の染色体をそれぞれ $1/2$ の確率で取り入れ新しい個体を生み出す操作です。

__「突然変異」__`mutate()`
個体の遺伝子をランダムな位置で変更し、新しい個体を生み出す操作です。

```py3:pythonスクリプト
class TSPGA(SearchProblem):

    def value(self, state):
        # 選択
        route = gene_2_route(state)
        cost = -nx.path_weight(complete_graph, route, weight="weight")
        global max_state
        global max_cost
        if max_cost < cost:
            max_state = state
            max_cost = cost
        return cost
        
    def generate_random_state(self):
        # 初期値生成
        destinations = list(copy.deepcopy(complete_graph.nodes))
        gene = []
        for i in range(len(destinations)):
            node = random.choice(destinations)
            index = destinations.index(node)
            destinations.pop(index)
            gene.append(index)
        return gene

    def crossover(self, state1, state2):
        # 一様交叉
        child = []
        for i in range(len(state1)):
            p = random.random()
            if p < 0.5: child.append(state1[i])
            else: child.append(state2[i])
        return child

    def mutate(self, state):
        # 突然変異
        child = list(copy.deepcopy(state))
        index = np.random.randint(0, len(child))
        max = len(child) - index
        child[index] = np.random.randint(0, max)
        return child
```

### GAを実行する
以下のようにパラメータを設定しGAを実行します。
* 1世代の数：1000
* 突然変異の確立：0.4
* 世代交代：5000

```py3:pythonスクリプト
initial_gene = [0]*complete_graph.number_of_nodes()
max_state = initial_gene
max_cost = -10**8
problem = TSPGA(initial_state=initial_gene)
result = genetic(problem, population_size=1000, mutation_chance=0.4, iterations_limit=5000)
route = gene_2_route(result.state)
```

求めた巡回路とグラフを描画します。経路コストは462294（＝警備員が歩く距離は約462m）となりました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2059946/baab44ae-08c7-cd9f-77ca-edd8231e40f2.png)



# 巡回路をグラフマップに反映する
完全グラフで求めた巡回路を使って、もとのグラフマップでの巡回路も求めます。完全グラフの各辺には最短経路がタグ付けされているので、その情報からグラフマップでの巡回路の各辺が分かります。

```py3:pythonスクリプト
def get_edges(route, complete_graph):
    edges = []
    route_edges = set(zip(route, route[1:]))
    for i, j, tag in complete_graph.edges(data=True):
        if (i, j) in route_edges or (j, i) in route_edges:
            path = tag["path"]
            edges.extend(set(zip(path, path[1:])))
    return edges

route_edges = get_edges(route, complete_graph)
```

巡回路とグラフを描画します。一部の辺が重なっているため分かりにくいですが、最短巡回路に近いルートを求められています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2059946/0f817634-0ce2-3f9f-8e7a-6edd43dabe7d.png)



# 参考リンク

https://pypi.org/project/simpleai/

https://mukai-lab.info/pages/classes/artificial_intelligence/chapter11/

https://qiita.com/masaru/items/729a0a0e2d7f305e8e90

https://qiita.com/take314/items/dc2e6cf6d97889923c8b

https://qiita.com/infhyroyage/items/50b9a45b2d1ed0dde218#2%E9%87%8D%E6%9C%A8%E3%82%A2%E3%83%AB%E3%82%B4%E3%83%AA%E3%82%BA%E3%83%A0