# 探索パラメータ
:::{container} prog-cpp
Hi-QUBO の3つのソルバー — Easy Solver、Exhaustive Solver、ABS3 Solver — は、`search()` を通じて探索パラメータを受け取ります。 パラメータはキーと値のペアです。 値は文字列・整数・浮動小数点数のいずれでも指定可能で、数値は内部的に自動で文字列に変換されます。
:::


:::{container} prog-python
pyQBPP の3つのソルバー — Easy Solver、Exhaustive Solver、ABS3 Solver — は、`search()` を通じて探索パラメータを受け取ります。 パラメータはキーと値のペアです。 値は文字列・整数・浮動小数点数のいずれでも指定可能で、数値は内部的に自動で文字列に変換されます。
:::

## パラメータの指定
`search()` に初期化子リストを直接渡します:

:::{container} prog-cpp
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: パラメーターの指定1_cpp -->
:end-before: <!-- end: パラメーターの指定1_cpp -->
```
:::


:::{container} prog-python
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: パラメーターの指定1_python -->
:end-before: <!-- end: パラメーターの指定1_python -->
```
:::



値は文字列・整数・浮動小数点数を混在させることができます:

:::{container} prog-cpp
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: パラメーターの指定2_cpp -->
:end-before: <!-- end: パラメーターの指定2_cpp -->
```
:::


:::{container} prog-python
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: パラメーターの指定2_python -->
:end-before: <!-- end: パラメーターの指定2_python -->
```
:::


プログラムで動的にパラメータを構築する場合は、`qbpp::Params` オブジェクトを作成し `operator()` で設定します:

:::{container} prog-cpp
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: パラメーターの指定3_cpp -->
:end-before: <!-- end: パラメーターの指定3_cpp -->
```
:::


:::{container} prog-python
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: パラメーターの指定3_python -->
:end-before: <!-- end: パラメーターの指定3_python -->
```
:::



## 共通パラメータ
以下のパラメータは3つのソルバーすべてで共通です:


| パラメータ | 型 | 説明 |
|---|---|---|
| `target_energy` | 整数 | エネルギーがこの値以下の解が見つかったら探索を停止する。 |
| `enable_default_callback` | `0`/`1` | 新たに見つかった最良解を標準エラー出力に表示する。デフォルト: `0`。 |
| `topk_sols` | 整数 | 探索中にエネルギー上位N個の解を保持する。 |
| `best_energy_sols` | `0`/`1` | 最良エネルギーのすべての解を保持する。`0` = 上限なし。 |


## Easy Solver のパラメータ

| パラメータ | 型 | 説明 | デフォルト |
|---|---|---|---|
| `time_limit` | 浮動小数点数 | 制限時間（秒）。0 で無制限。 | `10.0` |
| `target_energy` | 整数 | 目標エネルギー。 | `(なし)` |
| `enable_default_callback` | `0`/`1` | 進捗を表示。 | `0` |
| `topk_sols` | 整数 | 保持するトップk解の数。 | `(無効)` |
| `best_energy_sols` | `0`/整数 | 保持する最良エネルギー解の数。 | `(無効)` |

例:
:::{container} prog-cpp
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: Easy Solver のパラメーター_cpp -->
:end-before: <!-- end: Easy Solver のパラメーター_cpp -->
```
:::


:::{container} prog-python
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: Easy Solver のパラメーター_python -->
:end-before: <!-- end: Easy Solver のパラメーター_python -->
```
:::


## Exhaustive Solver のパラメータ
Exhaustive Solver は完全探索を行うため、`time_limit` パラメータはありません。

| パラメータ | 型 | 説明 | デフォルト |
|---|---|---|---|
| `target_energy` | 整数 | 目標エネルギー（早期終了用）。 | `(なし)` |
| `verbose` | `0`/`1` | 探索進捗率を表示する。 | `0` |
| `enable_default_callback` | `0`/`1` | 進捗を表示。 | `0` |
| `topk_sols` | 整数 | 保持するトップk解の数。 | `(無効)` |
| `best_energy_sols` | `0`/`1` | すべての最適解を保持。 | `(無効)` |
| `all_sols` | `0`/`1` | すべての実行可能解を保持。 | `(無効)` |


例:
:::{container} prog-cpp
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: Exhaustive Solver のパラメーター_cpp -->
:end-before: <!-- end: Exhaustive Solver のパラメーター_cpp -->
```
:::


:::{container} prog-python
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: Exhaustive Solver のパラメーター1_python -->
:end-before: <!-- end: Exhaustive Solver のパラメーター1_python -->
```

パラメータを組み合わせて複数の解を収集できます:

```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: Exhaustive Solver のパラメーター2_python -->
:end-before: <!-- end: Exhaustive Solver のパラメーター2_python -->
```
:::

## ABS3 Solver のパラメーター

| パラメータ | 型 | 説明 | デフォルト |
|---|---|---|---|
| `time_limit` | 浮動小数点数 | 制限時間（秒）。 | `10.0` |
| `target_energy` | 整数 | 目標エネルギー。 | `(なし)` |
| `enable_default_callback` | `0`/`1` | 進捗を表示。 | `0` |
| `topk_sols` | 整数 | 保持するトップk解の数。 | `(無効)` |
| `best_energy_sols` | `0`/`1` | すべての最適解を保持。 | `(無効)` |
| `cpu_enable` | 0/1 | CPUソルバーの有効/無効。 | `1` |
| `cpu_thread_count` | 整数 | CPUスレッド数。 | `(自動)` |
| `block_count` | 整数 | GPUブロック数。 | `(自動)` |
| `thread_count` | 整数 | GPUブロックあたりのスレッド数。 | `(自動)` |


例:
:::{container} prog-cpp
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: ABS3 Solver のパラメーター_cpp -->
:end-before: <!-- end: ABS3 Solver のパラメーター_cpp -->
```
:::


:::{container} prog-python
```{include} ../../programFiles/markDown/advanced/search-parameter-program.md
:start-after: <!-- begin: ABS3 Solver のパラメーター_python -->
:end-before: <!-- end: ABS3 Solver のパラメーター_python -->
```
:::



## エラー処理
不明なパラメータキーを指定すると、実行時に `std::runtime_error` が発生します。