-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocplex.mp.sdetails.html
259 lines (239 loc) · 13.8 KB
/
docplex.mp.sdetails.html
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>docplex.mp.sdetails module — DOcplex.MP: Mathematical Programming Modeling for Python V2.14 documentation</title>
<link rel="stylesheet" href="_static/bizstyle.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/bizstyle.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="docplex.mp.sktrans.transformers module" href="docplex.mp.sktrans.transformers.html" />
<link rel="prev" title="docplex.mp.relaxer module" href="docplex.mp.relaxer.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<!--[if lt IE 9]>
<script type="text/javascript" src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="docplex.mp.sktrans.transformers.html" title="docplex.mp.sktrans.transformers module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="docplex.mp.relaxer.html" title="docplex.mp.relaxer module"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">DOcplex.MP: Mathematical Programming Modeling for Python V2.14 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="refman.html" accesskey="U"><strong>docplex.mp</strong> reference manual</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="docplex.mp.relaxer.html"
title="previous chapter">docplex.mp.relaxer module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="docplex.mp.sktrans.transformers.html"
title="next chapter">docplex.mp.sktrans.transformers module</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="docplex-mp-sdetails-module">
<h1>docplex.mp.sdetails module<a class="headerlink" href="#docplex-mp-sdetails-module" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-docplex.mp.sdetails"></span><dl class="class">
<dt id="docplex.mp.sdetails.SolveDetails">
<em class="property">class </em><code class="descclassname">docplex.mp.sdetails.</code><code class="descname">SolveDetails</code><span class="sig-paren">(</span><em>time=0</em>, <em>status_code=-1</em>, <em>status_string=None</em>, <em>problem_type=None</em>, <em>ncolumns=0</em>, <em>nonzeros=0</em>, <em>miprelgap=None</em>, <em>best_bound=None</em>, <em>n_iterations=0</em>, <em>n_nodes_processed=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/sdetails.html#SolveDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The <a class="reference internal" href="#docplex.mp.sdetails.SolveDetails" title="docplex.mp.sdetails.SolveDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolveDetails</span></code></a> class contains the details of a solve.</p>
<p>This class should never be instantiated. You get an instance of this class from
the model by calling the property <a class="reference internal" href="docplex.mp.model.html#docplex.mp.model.Model.solve_details" title="docplex.mp.model.Model.solve_details"><code class="xref py py-data docutils literal notranslate"><span class="pre">docplex.mp.model.Model.solve_details</span></code></a>.</p>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.best_bound">
<code class="descname">best_bound</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.best_bound" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the MIP best bound at the end of the solve.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<ul class="last simple">
<li>This property returns NaN when the problem is not a MIP.</li>
</ul>
</div>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.columns">
<code class="descname">columns</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.columns" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the number of columns.</p>
</dd></dl>
<dl class="method">
<dt id="docplex.mp.sdetails.SolveDetails.has_hit_limit">
<code class="descname">has_hit_limit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/sdetails.html#SolveDetails.has_hit_limit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.has_hit_limit" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if the solve details indicate that the solve has hit a limit.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the solve details indicate that the solve has hit a limit.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.mip_relative_gap">
<code class="descname">mip_relative_gap</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.mip_relative_gap" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the MIP relative gap.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<ul class="last simple">
<li>This property returns NaN when the problem is not a MIP.</li>
<li>The gap is returned as a floating-point value, not as a percentage.</li>
</ul>
</div>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.nb_iterations">
<code class="descname">nb_iterations</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.nb_iterations" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the number of iterations at the end of the solve.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<ul class="last simple">
<li>The nature of the iterations depend on the algorithm usd to solve the model.</li>
<li><dl class="first docutils">
<dt>For multi-objective models, this property returns a tuple of numbers,</dt>
<dd>one for each objective solved.</dd>
</dl>
</li>
</ul>
</div>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.nb_linear_nonzeros">
<code class="descname">nb_linear_nonzeros</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.nb_linear_nonzeros" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the number of linear non-zeros in the matrix solved.</p>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.nb_nodes_processed">
<code class="descname">nb_nodes_processed</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.nb_nodes_processed" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the number of nodes processed at the end of solve.</p>
<dl class="docutils">
<dt>Note: for multi-objective problems, this property returns a tuple of numbers,</dt>
<dd>one for each objective solved.</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.problem_type">
<code class="descname">problem_type</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.problem_type" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the problem type as a string.</p>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.status">
<code class="descname">status</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.status" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the solve status as a string.</p>
<p>This string is normally the value returned by the CPLEX callable library method
CPXXgetstatstring,
see <a class="reference external" href="https://www.ibm.com/support/knowledgecenter/SSSA5P_12.8.0/ilog.odms.cplex.help/refcallablelibrary/cpxapi/getstatstring.html">https://www.ibm.com/support/knowledgecenter/SSSA5P_12.8.0/ilog.odms.cplex.help/refcallablelibrary/cpxapi/getstatstring.html</a></p>
<p class="rubric">Example</p>
<ul class="simple">
<li>Returns “optimal” when the solution has been proven optimal.</li>
<li>Returns “feasible” for a feasible, but not optimal, solution.</li>
<li>Returns “MIP_time_limit_feasible” for a MIP solution obtained before a time limit.</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>In certain cases, status may return a string that is not directly passed from CPLEX</p>
<blockquote class="last">
<div><ul class="simple">
<li>If an exception occurs during the CPLEX solve phase, status contains the text of the exception.</li>
<li><dl class="first docutils">
<dt>If solve fails because of a promotional version limitation, the following message is returned</dt>
<dd>“Promotional version. Problem size limits exceeded., CPLEX code=1016.”
The corresponding status code is 1016.</dd>
</dl>
</li>
</ul>
</div></blockquote>
</div>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.status_code">
<code class="descname">status_code</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.status_code" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the CPLEX status code as a number.
Possible values for the status code are described in the CPLEX documentation
at:
<a class="reference external" href="https://www.ibm.com/support/knowledgecenter/SSSA5P_12.8.0/ilog.odms.cplex.help/refcallablelibrary/macros/Solution_status_codes.html">https://www.ibm.com/support/knowledgecenter/SSSA5P_12.8.0/ilog.odms.cplex.help/refcallablelibrary/macros/Solution_status_codes.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">an integer number (a CPLEX status code)</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="docplex.mp.sdetails.SolveDetails.time">
<code class="descname">time</code><a class="headerlink" href="#docplex.mp.sdetails.SolveDetails.time" title="Permalink to this definition">¶</a></dt>
<dd><p>This property returns the solve time in seconds.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="docplex.mp.sktrans.transformers.html" title="docplex.mp.sktrans.transformers module"
>next</a> |</li>
<li class="right" >
<a href="docplex.mp.relaxer.html" title="docplex.mp.relaxer module"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">DOcplex.MP: Mathematical Programming Modeling for Python V2.14 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="refman.html" ><strong>docplex.mp</strong> reference manual</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016-2019, IBM®.
</div>
</body>
</html>