Skip to content

Commit b4350f2

Browse files
committed
Update solver options for multiprecision backend
1 parent 87b7e5d commit b4350f2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/usage/params.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ The details of the parameters are as below:
2020
| Parameter | Description | Default |
2121
|-----------|-------------|---------|
2222
| `maxIteration` | The maximum number of iterations. | `100` |
23-
| `epsilonStar` | The accuracy of an approximate optimal solution for primal and dual SDP. | `1.0E-7` |
23+
| `epsilonStar` | The accuracy of an approximate optimal solution for primal and dual SDP. **If using the multiprecision backend, this parameter may be reduced by orders of magnitude to achieve extended precision.** | `1.0E-7` |
2424
| `lambdaStar` | An initial point. | `1.0E2` |
2525
| `omegaStar` | The search region for an optimal solution. | `2.0` |
2626
| `lowerBound` | Lower bound of the minimum objective value of the primal SDP. | `-1.0E5` |
2727
| `upperBound` | Upper bound of the maximum objective value of the dual SDP. | `1.0E5` |
2828
| `betaStar` | The parameter for controlling the search direction if the current point is feasible. | `0.1` |
2929
| `betaBar` | The parameter for controlling the search direction if the current point is infeasible. | `0.2` |
3030
| `gammaStar` | A reduction factor for the primal and dual step lengths. | `0.9` |
31-
| `epsilonDash` | The relative accuracy of an approximate optimal solution between primal and dual SDP. | `1.0E-7` |
31+
| `epsilonDash` | The relative accuracy of an approximate optimal solution between primal and dual SDP. **If using the multiprecision backend, this parameter may be reduced by orders of magnitude to achieve extended precision.** | `1.0E-7` |
3232
| `isSymmetric` | Specify whether to check the symmetricity of input matrices. | `False` |
3333
| `isDimacs` | Specify whether to compute DIMACS ERROR. | `False` |
3434
| `numThreads` | Number of Threads for internal computation. | `multiprocessing.cpu_count()` |
@@ -63,7 +63,7 @@ The below options set printing options.
6363
| `print` | Whether to display solver output to stdout. If set to `'display'`, output is printed and if set to `'no'` or empty, no message is print out. | `'display'` |
6464
| `resultFile` | Destination of detail file output. | `''` |
6565
| `sdpaResult` | Destination of file output for SDPA result. | `''` |
66-
| `xPrint` | Format specifier for `yMat` printed to the file. See [this reference page](https://www.cplusplus.com/reference/cstdio/fprintf/) to set it. `NOPRINT` skips printout. | `'%+8.3e'` |
67-
| `yPrint` | Format specifier for `xVec` printed to the file. See [this reference page](https://www.cplusplus.com/reference/cstdio/fprintf/) to set it. `NOPRINT` skips printout. | `'%+8.3e'` |
68-
| `sPrint` | Format specifier for `xMat` printed to the file. See [this reference page](https://www.cplusplus.com/reference/cstdio/fprintf/) to set it. `NOPRINT` skips printout. | `'%+8.3e'` |
69-
| `infPrint` | Format specifier for problem information printed to the file. See [this reference page](https://www.cplusplus.com/reference/cstdio/fprintf/) to set it. `NOPRINT` skips printout. | `'%+10.16e'` |
66+
| `xPrint` | Format specifier for `yMat` printed to the file. To adjust, see [`fprintf` documentation](https://www.cplusplus.com/reference/cstdio/fprintf/) (for regular backend) or [`gmp_printf` documentation](https://gmplib.org/manual/Formatted-Output-Strings) (for multiprecision backend). `NOPRINT` skips printout. | `'%+8.3e'` (regular backend), `'%+18.12Fe'` (multiprecision backend) |
67+
| `yPrint` | Format specifier for `yMat` printed to the file. To adjust, see [`fprintf` documentation](https://www.cplusplus.com/reference/cstdio/fprintf/) (for regular backend) or [`gmp_printf` documentation](https://gmplib.org/manual/Formatted-Output-Strings) (for multiprecision backend). `NOPRINT` skips printout. | `'%+8.3e'` (regular backend), `'%+18.12Fe'` (multiprecision backend) |
68+
| `sPrint` | Format specifier for `yMat` printed to the file. To adjust, see [`fprintf` documentation](https://www.cplusplus.com/reference/cstdio/fprintf/) (for regular backend) or [`gmp_printf` documentation](https://gmplib.org/manual/Formatted-Output-Strings) (for multiprecision backend). `NOPRINT` skips printout. | `'%+8.3e'` (regular backend), `'%+18.12Fe'` (multiprecision backend) |
69+
| `infPrint` | Format specifier for problem information printed to the file. See [`fprintf` documentation](https://www.cplusplus.com/reference/cstdio/fprintf/) to set it. `NOPRINT` skips printout. | `'%+10.16e'` |

0 commit comments

Comments
 (0)