（古い情報）ついに使い物になるフリーの数理最適化ソルバーが登場？　MIPCL

# （更新情報）
- 2021/09/04:
    - 去年書いた、PuLPのソルバーをCOIN-CBCのマルチスレッド版にするよりも、**Python-MIP**というソルバー（ソルバーインターフェース）を使ったほうがよいです。同こんされているCOIN-CBCがマルチスレッドに対応していますし、それ以外にもいいことがあります。詳しくは以下の記事をご覧ください。

[今度こそ？使い物になるフリーの数理最適化（混合整数最適化）ソルバー Python-MIP](https://qiita.com/keisukesato-ac/items/f2fb63140b80226ba687)


- 2020/09/04: 
    - この日付現在でも**MIPCLの入手性が悪い**ままの状態が続いているので、**MIPCLを使わずに、すぐ↓にリンクを貼ったPuLPのソルバーをCOIN-CBCのマルチスレッド版にする方法のほうをお勧め**します。
- 2020/05/25:
    - WindowsでPuLPを使用するにあたり、手っ取り早く数理最適化ソルバーをCOIN-CBCのマルチスレッド版にする方法の記事を、 [Python数理最適化パッケージPuLPの計算エンジンを速いものにする（Windows版お手軽編） & 計算時間を指定する](https://qiita.com/keisukesato-ac/items/a7180cd61a9dff904263) としてまとめました。
- 2020/05/24:
    - ベンチマークで、COIN-CBCのマルチスレッド版の入手方法を更新しました。
- 2020/05/10: 
    - MIPCLのダウンロードとインストール方法について更新しました。
    - 実験環境（インストールと動作確認）を更新しました。
    - ベンチマークにCOIN-CBCのマルチスレッド対応版の結果を追加しました。

# はじめに
数理最適化問題（数理計画問題）、特に整数最適化問題（整数計画問題）の式を解いてくれる無償で商用利用可能なソルバーとしては、PuLP（デフォルトのソルバーとしてCOIN-CBCが付属）が比較的有名だと思います（[使用例](https://qiita.com/samuelladoco/items/703bf78ea66e8369c455)）。また、Google OR-Tools（こちらもデフォルトのソルバーとしてCOIN-CBCが付属）も知られています。ただし、これらのソルバーは、有償のソルバー（Gurobi, CPLEX, XPRESSなど）と比べると、計算速度が大きく劣るため、実務で解きたい問題が許容時間内に解けない場合があります。
ここでは、上記の無償ソルバーよりも**速く問題を解いてくれそうな**「**MIPCL**」という新しめのソルバーを紹介します。


# MIPCLとは
**MIPCL**
公式サイト｜http://www.mipcl-cpp.appspot.com/index.html

※ 2020/05/10 重要な追記
2020年4月ころに、上記の公式サイトが**消えてしまいました…**しかし、Pythonから利用できるMIPCLのバージョン2.2.0は、引き続き、以下から入手できるようです。

- Windows 64bit: https://www.researchgate.net/publication/332962540_mipcl-py-220windows-x86_64
- Linux 64bit: https://www.researchgate.net/publication/332962384_mipcl-py-220linux-x86_64tar
- マニュアル: https://www.researchgate.net/publication/332962492_Nicolai_N_Pisaruk_Mixed_Integer_Programming_in_Operations_Management_MIPCL-PY_manual

2017年夏ころでしょうか、ソルバーを比較する[ベンチマークサイト](http://plato.asu.edu/ftp/milp.html)に突如としてMIPCLというソルバーが出現し、フリーの中ではSCIPに次ぐ性能という評価になりました。ただしSCIPは商用利用したい場合は作者への相談が必要なので、そういう敷居がない中ではMIPCLは最高性能になりました。
MIPCLのよさげなところは、特に何の設定もなしにPythonインターフェースから呼んでも、**マルチスレッド**で動作してくれるところにあります。（[こちらのブログエントリー](http://inarizuuuushi.hatenablog.com/entry/2019/03/07/090000)によると、PuLPについても、同こんのソルバーCOIN-CBCを呼ぶ際にマルチスレッドで動かすことができるようなのですが、なぜか私の環境（Windowsです）ではうまく動きません…~~COIN-CBCのソースコード自体はマルチスレッドに対応しているので、ソースコードから自分でコンパイルするなどしてバイナリーを生成すればいけるはずです。そのやり方を調べて公開できればと思っています。~~ベンチマークのところで、COIN-CBCのマルチスレッド対応版の入手方法について軽く触れました。）

MIPCLは、整数最適化のほかにも、凸二次最適化問題（凸二次計画問題）や二次錐最適化問題（二次錐計画問題）を扱えるそうです。

ライセンス形態ですが、公式ページには「GNU Lesser Public License (GLPL)」と書いていますが、おそらく誤植です。ダウンロードしたファイルには「GNU LESSER GENERAL PUBLIC LICENSE Version 3」と書いていまして、おそらくこちらのほうが正しい表記だと思います。いわゆるLGPLですね。なので、いにしえのGPLとは違い、MIPCLを外部から呼び出すという通常の使い方をする場合は、自分のコードを公開しなくてよさそうです（よね？）。


# 実験環境
- Windows 10 1909 64bit
    - 管理者権限を持つアカウントで作業
- Python 3.7 64bit (Anaconda3 2020.02 64bit)
    - (ユーザー領域にインストール（「Just Me」を選択）)
- MIPCL-PY 2.2.0
    - (ベンチマークは2.1.3で実施)
- Visual Studio Code 1.45.0
    - (ユーザー領域にインストール)


# ダウンロードとインストール
## ダウンロード
[公式サイト](http://www.mipcl-cpp.appspot.com/index.html) → Download → OSを選択 → Download（個人情報は入力しなくてもよい）

※ 2020/05/10 重要な追記
上にも書きましたが、2020年4月ころに、公式サイトが消えてしまったので、以下の手順で入手します。
[ResearchGateでの公開ページ](https://www.researchgate.net/publication/332962540_mipcl-py-220windows-x86_64) → Dolwnload file → `mipcl-py-2.2.0.windows-x86_64.zip` を保存 → zipを展開

## インストール
### Visual C++ (2017?)再頒布可能パッケージのインストール
~~1. `setup.exe`を実行 → Visual C++ "14"ランタイムのダウンロードとインストールが始まる → **OSが勝手に再起動する**
    - すでに（類似の）ランタイムがインストールされていれば、MIPCL同こんのものはインストールしなくてもよい模様~~

※ 2020/05/10 重要な編集
インストールに失敗することがあるようです。なので、インストールをしないでこの先の手順を進めてみましたが、**なぜか正常に動いた**ので、Visual C++ "14"ランタイムのインストールは不要なのかもしれません。
インストールされたMIPCL本体ファイルたちに含まれる`README`を読んでみたのですが、Visual C++ 再頒布可能パッケージ（Visual Studio 2017の再頒布可能パッケージだそうです）は必要であるが手動で入れてもよいと書かれていたので、**やっぱり必要であり、かつ、未インストールの場合は、以下の方法で入手してもよさそう**です。
[MS公式](https://support.microsoft.com/ja-jp/help/2977003/the-latest-supported-visual-c-downloads) → 「Visual Studio 2015、2017 および 2019」のところにある 「vc_redist.x64.exe」 をクリックしてダウンロードしてインストール

### 本体のインストール
1. `MIPCL-PY.msi` → インストール対象を選択 → インストールフォルダーを選択 → インストールが終わったら手動でOSを再起動
    - インストール対象を`Just Me`か`All Users`にするかは、おそらく環境変数`PYTHONPATH`がユーザー環境変数になるかシステム環境変数になるかに影響するのではないか
        - 今どき`PYTHONPATH`使うパッケージって…
        - Pythonなのに`.msi`のインストーラーって…
    - インストールフォルダーは、デフォルトでは`C:\Program Files\PNN\MIPCL-PY_64\`になっていますが、もしなんかいやな予感がする方は`C:\Users\(ユーザー名)\Documents\Software\PNN\MIPCL-PY_64\`あたりに入れると精神衛生上よさそう
    - わざわざOSを再起動をする理由ですが、手元のPython開発環境では、再起動をしないと`PYTHONPATH`の値がPython処理系のモジュール検索パスに反映されないためです


# 最適化例(1)
簡単な例を紹介します。
問題例は[こちらのエントリー](https://qiita.com/samuelladoco/items/703bf78ea66e8369c455)の例(1)と同じものを使用します。

## コード
```python:p1.py
# coding: utf-8

# Dummy Nihongo: あ（私の使っているテキストエディタにUTF-8と認識させるため）


# Import
# -----------------------------------------------------------------------------
# MIPCL-PY
import mipcl_py.mipshell.mipshell as mp
# -----------------------------------------------------------------------------


# Main
# -----------------------------------------------------------------------------
print(f'-' * 40)
print(f'[宣言]')

# 数理最適化問題を宣言（名前をつける必要あり）
prob = mp.Problem('Problem-1')

# 変数を宣言（連続変数）
# 引数を全部指定する場合
x = mp.Var(name='x', type=mp.REAL, lb=0.0, ub=mp.VAR_INF, priority=0)
# 引数をけっこう省略する場合（type以降のデフォルト値は↑と同じ）
y = mp.Var(name='y')

# 目的関数を宣言（最大化）
mp.maximize(x + y)

# 制約条件を宣言
2 * x + y <= 2
x + 2 * y <= 2


print(f'-' * 40)
print(f'[計算]')

# 計算（計算ログを出力）
prob.optimize(silent=False)

print(f'-' * 40)
print(f'[出力]')
# テキスト出力
prob.printSolution()

print(f'-' * 32)
# 目的関数値や変数の値を個別に取得
print(f'目的関数値 = {prob.getObjVal()}')
print(f'変数 x の値 = {x.val}')
print(f'変数 y の値 = {y.val}')

print(f'-' * 40)
# -----------------------------------------------------------------------------
```
## 実行結果
```
----------------------------------------
[宣言]
----------------------------------------
[計算]
Scaling...
Min exp = 0,  Max exp = 1

Preprocessing Time: 0.000
Solving...

Building initial basis...
     0.001          1          0      D/S                  0.0000
     0.003          3          0      P/S                  1.3333
Solution Time: 0.6
----------------------------------------
[出力]
Optimal objective value is 1.3333
'x' = 0.6667
'y' = 0.6667
--------------------------------
目的関数値 = 1.3333333333333335
変数 x の値 = 0.6666666666666667
変数 y の値 = 0.6666666666666666
----------------------------------------
```

# 最適化例(2)
$\sum$を使った整数最適化問題の例を紹介します。
問題例は[こちらのエントリー](https://qiita.com/keisukesato-ac/items/526543004141a1018a51)のサンプル2と同じものを使用します。ただし、クラス周りの記述はやめて、シンプルなコードにします。

## コード
```python:p2.py
# coding: utf-8

# Dummy Nihongo: あ（私の使っているテキストエディタにUTF-8と認識させるため）


# Import
# -----------------------------------------------------------------------------
# MIPCL-PY
import mipcl_py.mipshell.mipshell as mp
# -----------------------------------------------------------------------------


# Main
# -----------------------------------------------------------------------------
print(f'-' * 40)
print(f'[集合の定義]')
I = ['Aさん', 'Bさん', 'Cさん']
J = ['東京', '大阪']
c = {
    ('Aさん', '東京'):  7, ('Aさん', '大阪'):  2, 
    ('Bさん', '東京'): 10, ('Bさん', '大阪'): 13, 
    ('Cさん', '東京'):  3, ('Cさん', '大阪'):  6
}

print(f'-' * 40)
print(f'[宣言]')

# 数理最適化問題を宣言（名前をつける必要あり）
prob = mp.Problem('Problem-2')

# 変数を宣言（0-1変数）
# x[社員名, 仕事名] を gp.Var クラスのオブジェクト を表す辞書として定義
x = {}
for i in I:
    for j in J:
        # 引数のうち、 priority を省略
        x[i, j] = mp.Var(name=f'x({i},{j})', type=mp.BIN)


# 目的関数を宣言（最小化）
mp.minimize(mp.sum_(c[i, j] * x[i, j] for i in I for j in J))

# 制約条件を宣言
for i in I:
    mp.sum_(x[i, j] for j in J) <= 1
for j in J:
    mp.sum_(x[i, j] for i in I) >= 1

print(f'-' * 40)
print(f'[計算]')

# 計算（計算ログを出力）
prob.optimize(silent=False)

print(f'-' * 40)
print(f'[出力]')
# テキスト出力
prob.printSolution()

print(f'-' * 32)
# 目的関数値や変数の値を個別に取得
print(f'目的関数値 = {prob.getObjVal()}')
for i in I:
        for j in J:
            if x[i, j].val > 0.98:
                print(f"{i}に{j}を割り当て")

print(f'-' * 40)
# -----------------------------------------------------------------------------
```
## 実行結果
```
----------------------------------------
[集合の定義]
----------------------------------------
[宣言]
----------------------------------------
[計算]
Start preprocessing: Rows - 5, Cols - 6 (Int - 6, Bin - 6), NZs - 12
==================================== Probing =====================================
     Time  Round  Probed vars  Fixed vars  Mod. entries  New var bds  Implications
    0.002      1            6           0             0            0             3
==================================================================================
After preprocessing: Rows - 5, Cols - 6 (Int - 6, Bin - 6), NZs - 12
Scaling...
Min exp = 0,  Max exp = 0

Preprocessing Time: 0.005
Optimizing...
Building initial basis...
     0.006          1          0      D/S                  5.0000
Generating cuts...
===========================================
MIPCL version 2.1.3
Solution time: 0.009
Branch-and-Cut nodes: 1
Objective value: 5.0000 - optimality proven
----------------------------------------
[出力]
Optimal objective value is 5.0000
'x(Aさん,東京)' = 0.0000
'x(Aさん,大阪)' = 1.0000
'x(Bさん,東京)' = 0.0000
'x(Bさん,大阪)' = 0.0000
'x(Cさん,東京)' = 1.0000
'x(Cさん,大阪)' = 0.0000
--------------------------------
目的関数値 = 5.0
Aさんに大阪を割り当て
Cさんに東京を割り当て
----------------------------------------
```

# ベンチマーク
グラフクラスタリング（与えられた無向グラフを、いくつかの密な部分グラフに分割する問題）に関する[こちらの論文](https://doi.org/10.1016/j.ejor.2015.03.012)の定式化を、いくつかのソルバーで解いてみました。環境はCore i9-9900K (8コア16スレ)です。
この論文の定式化に基づくインスタンスの印象としては、最適解を見つけるのにも少し時間がかかるものの、それ以上に、見つかった解が最適であることを保証するために多くの時間がかかるような定式化であるということが挙げられます。

|インスタンス| Gurobi 8.1.0 | MIPCL 2.1.3 | PuLP 1.6.9 (COIN-CBC, 1スレ) |COIN-CBC (バージョン不明), 8スレ |
|:----------:|-----------:|------------:|------------:|------------:|
| 1       | 0.6       | 0.9        | 21.4         |8.6|
| 2       | 0.4     | 1.2      | 11.1       |4.6|
| 3       | 0.6       | 2.1        | 39.4         |6.0|
| 4       | 0.3        | 1.1          | 16.0         |5.8|
| 5       | 9.8       | 126.8       | 1,589.4       |612.4|
（単位：秒）
（おおむね、インスタンスの数字が大きいほど、インスタンスのサイズが大きい）

※ 2020/05/24 重要な追記
「COIN-CBC (バージョン不明), 8スレ」の結果を追記しました。これは、 [こちらのページ](https://bintray.com/coin-or/download/Cbc/master#files) の `Cbc-master-x86_64-w64-mingw32.zip` をダウンロードして展開し、中にある `cbc.exe` にインスタンスを解かせたものです。なお、整数最適化は比較的重い処理であり、SMT機能を持つプロセッサーで物理コア数を超え論理コア数ぶんのスレッドを使うと遅くなることがままあるのですが（同一コア内で処理の競合が起きやすい）、このCBCバイナリーは自動でCPUのSMT周りの特性を見てふるまいを変えてくれないようなので、手動で8スレと指定して解きました。なお、各スレッドの処理をどの論理コアへ割りふるかについては、昨今のOSのほうでいい感じにやってくれるようです。
（自分用メモ: `cbc.exe a.lp threads=8 solve`）

残念ながら私の環境ではPuLPに同こんされているCOIN-CBCがマルチスレッドで動かなかったためフェアな比較にはなっていませんが、MIPCLは、PuLPよりも速く、ある程度のサイズまでは有償ソルバーであるGurobiとそんなに変わりない時間でインスタンスを解きました。また、バージョンは不明ですがCOIN-CBCのマルチスレッド版よりも速く解きました。


# おわりに
MIPCLは、インストール方法だったりAPIが、ほかのソルバーと大きく違って直感的ではないため、もにょるところはありますが（例：`Problem`クラスにクラス変数`curProb`があって、それが現在選択されている問題例を示していること）、フリーで商用利用可能なことと性能のバランスがとれていることから、試しに動かしてみる価値はあると思います。