1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.16.
.TH SDPB "1" "February 2021" "sdpb 1.0" "User Commands"
.SH NAME
sdpb \- Semidefinite program solver
.SH SYNOPSIS
sdpb [OPTIONS] [SOLVER PARAMETERS]
.SH DESCRIPTION
ERROR: the option '\-\-sdpFile' is required but missing
.SS "Basic options:"
.TP
\fB\-h\fR [ \fB\-\-help\fR ]
Show this helpful message.
.TP
\fB\-s\fR [ \fB\-\-sdpFile\fR ] arg
SDP data file in XML format.
.TP
\fB\-p\fR [ \fB\-\-paramFile\fR ] arg
Any parameter can optionally be set via
this file in key=value format. Command
line arguments override values in the
parameter file.
.TP
\fB\-o\fR [ \fB\-\-outFile\fR ] arg
The optimal solution is saved to this
file in Mathematica format. Defaults to
sdpFile with '.out' extension.
.TP
\fB\-c\fR [ \fB\-\-checkpointFile\fR ] arg
Checkpoints are saved to this file
every checkpointInterval. Defaults to
sdpFile with '.ck' extension.
.SS "Solver parameters:"
.TP
\fB\-\-precision\fR arg (=400)
Precision in binary digits. GMP will
round up to the nearest multiple of 64
(or 32 on older systems).
.TP
\fB\-\-maxThreads\fR arg (=4)
Maximum number of threads to use for
parallel calculation.
.TP
\fB\-\-checkpointInterval\fR arg (=3600)
Save checkpoints to checkpointFile
every checkpointInterval seconds.
.TP
\fB\-\-noFinalCheckpoint\fR
Don't save a final checkpoint after
terminating (useful when debugging).
.TP
\fB\-\-findPrimalFeasible\fR
Terminate once a primal feasible
solution is found.
.TP
\fB\-\-findDualFeasible\fR
Terminate once a dual feasible solution
is found.
.TP
\fB\-\-detectPrimalFeasibleJump\fR
Terminate if a primal\-step of 1 is
taken. This often indicates that a
primal feasible solution would be found
if the precision were high enough. Try
increasing either primalErrorThreshold
or precision and run from the latest
checkpoint.
.TP
\fB\-\-detectDualFeasibleJump\fR
Terminate if a dual\-step of 1 is taken.
This often indicates that a dual
feasible solution would be found if the
precision were high enough. Try
increasing either dualErrorThreshold or
precision and run from the latest
checkpoint.
.TP
\fB\-\-maxIterations\fR arg (=500)
Maximum number of iterations to run the
solver.
.TP
\fB\-\-maxRuntime\fR arg (=86400)
Maximum amount of time to run the
solver in seconds.
.TP
\fB\-\-dualityGapThreshold\fR arg (=1e\-30)
Threshold for duality gap (roughly the
difference in primal and dual
objective) at which the solution is
considered optimal. Corresponds to
SDPA's epsilonStar.
.TP
\fB\-\-primalErrorThreshold\fR arg (=1e\-30)
Threshold for feasibility of the primal
problem. Corresponds to SDPA's
epsilonBar.
.TP
\fB\-\-dualErrorThreshold\fR arg (=1e\-30)
Threshold for feasibility of the dual
problem. Corresponds to SDPA's
epsilonBar.
.TP
\fB\-\-initialMatrixScalePrimal\fR arg (=1e+20)
The primal matrix X begins at
initialMatrixScalePrimal times the
identity matrix. Corresponds to SDPA's
lambdaStar.
.TP
\fB\-\-initialMatrixScaleDual\fR arg (=1e+20) The dual matrix Y begins at
initialMatrixScaleDual times the
identity matrix. Corresponds to SDPA's
lambdaStar.
.TP
\fB\-\-feasibleCenteringParameter\fR arg (=0.1)
Shrink the complementarity X Y by this
factor when the primal and dual
problems are feasible. Corresponds to
SDPA's betaStar.
.TP
\fB\-\-infeasibleCenteringParameter\fR arg (=0.3)
Shrink the complementarity X Y by this
factor when either the primal or dual
problems are infeasible. Corresponds to
SDPA's betaBar.
.TP
\fB\-\-stepLengthReduction\fR arg (=0.7)
Shrink each newton step by this factor
(smaller means slower, more stable
convergence). Corresponds to SDPA's
gammaStar.
.TP
\fB\-\-choleskyStabilizeThreshold\fR arg (=1e\-40)
Adds stabilizing terms to the cholesky
decomposition of the schur complement
matrix for diagonal entries which are
smaller than this threshold times the
geometric mean of other diagonal
entries. Somewhat higher
choleskyStabilizeThreshold can improve
numerical stability but if the
threshold is large enough that a high
proportion of eigenvalues are being
stabilized, the computation will slow
substantially.
.TP
\fB\-\-maxComplementarity\fR arg (=1e+100)
Terminate if the complementarity mu =
Tr(X Y)/dim(X) exceeds this value.
.SH EXAMPLES
The example files are contained in the package sdpb-doc and can be found at /usr/share/doc/sdpb-doc/examples/.
The input format for SDPB is XML-based and described in the manual. The Mathematica file mathematica/SDPB.m includes code to export semidefinite programs in this format, along with some examples. An example input file test.xml is included as well.
Two python wrappers for SDPB are also available:
PyCFTBoot by Connor Behan (arXiv:1602.02810)
cboot by Tomoki Ohtsuki (arXiv:1602.07295).
.SH "SEE ALSO"
The SDPB manual and the README file are contained in the package sdpb-doc and can be found at /usr/share/doc/sdpb-doc/.
.PP
The full documentation for
.B sdpb
is maintained as a Texinfo manual. If the
.B info
and
.B sdpb
programs are properly installed at your site, the command
.IP
.B info sdpb
.PP
should give you access to the complete manual.
.SH AUTHOR
This manpage was written by Nilesh Patra for the Debian distribution and
can be used for any other usage of the program.
|
