Files
ortools-clone/docs/cpp/callback__validator_8cc_source.html

144 lines
68 KiB
HTML
Raw Normal View History

2021-04-27 23:00:03 +02:00
<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
2022-01-16 18:02:36 +01:00
<meta name="generator" content="Doxygen 1.8.15"/>
2021-04-27 23:00:03 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: callback_validator.cc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
2022-01-16 18:02:36 +01:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
2021-04-27 23:00:03 +02:00
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
2021-12-14 13:41:01 +01:00
&#160;<span id="projectnumber">9.2</span>
2021-04-27 23:00:03 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2022-01-16 18:02:36 +01:00
<!-- Generated by Doxygen 1.8.15 -->
2021-04-27 23:00:03 +02:00
<script type="text/javascript">
2022-01-16 18:02:36 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2021-04-27 23:00:03 +02:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-01-16 18:02:36 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2021-04-27 23:00:03 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-01-16 18:02:36 +01:00
/* @license-end */</script>
2021-04-27 23:00:03 +02:00
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
2022-01-16 18:02:36 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('callback__validator_8cc_source.html','');});
2021-04-27 23:00:03 +02:00
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
2022-01-16 18:02:36 +01:00
<div class="headertitle">
<div class="title">callback_validator.cc</div> </div>
2021-04-27 23:00:03 +02:00
</div><!--header-->
<div class="contents">
2022-01-16 18:02:36 +01:00
<a href="callback__validator_8cc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2010-2021 Google LLC</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="callback__validator_8h.html">ortools/math_opt/validators/callback_validator.h</a>&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="integral__types_8h.html">ortools/base/integral_types.h</a>&quot;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;google/protobuf/duration.pb.h&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;absl/status/status.h&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;absl/strings/match.h&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_ac17be684f3a6337b38f287c0a1e8c691"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ac17be684f3a6337b38f287c0a1e8c691">operations_research::math_opt::MakeView</a></div><div class="ttdeci">SparseVectorView&lt; T &gt; MakeView(absl::Span&lt; const int64_t &gt; ids, const Collection &amp;values)</div><div class="ttdef"><b>Definition:</b> <a href="sparse__vector__view_8h_source.html#l00140">sparse_vector_view.h:140</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a7abc01bd247a24b76cd5e58d141c7219"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a7abc01bd247a24b76cd5e58d141c7219">operations_research::math_opt::ValidateCallbackRegistration</a></div><div class="ttdeci">absl::Status ValidateCallbackRegistration(const CallbackRegistrationProto &amp;callback_registration, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="callback__validator_8cc_source.html#l00099">callback_validator.cc:99</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a865fb54657254556516e00a105809539"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a865fb54657254556516e00a105809539">operations_research::math_opt::CheckIdsAndValues</a></div><div class="ttdeci">absl::Status CheckIdsAndValues(const SparseVectorView&lt; T &gt; &amp;vector_view, absl::string_view value_name=&quot;values&quot;)</div><div class="ttdef"><b>Definition:</b> <a href="sparse__vector__validator_8h_source.html#l00050">sparse_vector_validator.h:50</a></div></div>
<div class="ttc" id="log__severity_8h_html_acdd38e3c9f22f127d7776920e3079eda"><div class="ttname"><a href="log__severity_8h.html#acdd38e3c9f22f127d7776920e3079eda">FATAL</a></div><div class="ttdeci">const int FATAL</div><div class="ttdef"><b>Definition:</b> <a href="log__severity_8h_source.html#l00032">log_severity.h:32</a></div></div>
<div class="ttc" id="structoperations__research_1_1math__opt_1_1_double_options_html"><div class="ttname"><a href="structoperations__research_1_1math__opt_1_1_double_options.html">operations_research::math_opt::DoubleOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="scalar__validator_8h_source.html#l00023">scalar_validator.h:23</a></div></div>
<div class="ttc" id="base_2logging_8h_html_a9f96ed9f06763f0821fdbb4d29031d8d"><div class="ttname"><a href="base_2logging_8h.html#a9f96ed9f06763f0821fdbb4d29031d8d">CHECK_OK</a></div><div class="ttdeci">#define CHECK_OK(x)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00044">base/logging.h:44</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a73642a8827dfec380f36678d0451730b"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a73642a8827dfec380f36678d0451730b">operations_research::math_opt::ValidateCallbackDataProto</a></div><div class="ttdeci">absl::Status ValidateCallbackDataProto(const CallbackDataProto &amp;cb_data, const CallbackRegistrationProto &amp;callback_registration, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="callback__validator_8cc_source.html#l00122">callback_validator.cc:122</a></div></div>
<div class="ttc" id="base_2logging_8h_html_accad43a85d781d53381cd53a9894b6ae"><div class="ttname"><a href="base_2logging_8h.html#accad43a85d781d53381cd53a9894b6ae">LOG</a></div><div class="ttdeci">#define LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00420">base/logging.h:420</a></div></div>
<div class="ttc" id="sparse__vector__validator_8h_html"><div class="ttname"><a href="sparse__vector__validator_8h.html">sparse_vector_validator.h</a></div></div>
<div class="ttc" id="model__parameters__validator_8h_html"><div class="ttname"><a href="model__parameters__validator_8h.html">model_parameters_validator.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_ad9f50c9313b35cc1e8887057dc4d9645"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ad9f50c9313b35cc1e8887057dc4d9645">operations_research::math_opt::kInf</a></div><div class="ttdeci">constexpr double kInf</div><div class="ttdef"><b>Definition:</b> <a href="ids__validator_8cc_source.html#l00035">ids_validator.cc:35</a></div></div>
<div class="ttc" id="structoperations__research_1_1math__opt_1_1_model_summary_html"><div class="ttname"><a href="structoperations__research_1_1math__opt_1_1_model_summary.html">operations_research::math_opt::ModelSummary</a></div><div class="ttdef"><b>Definition:</b> <a href="model__summary_8h_source.html#l00076">model_summary.h:76</a></div></div>
<div class="ttc" id="integral__types_8h_html"><div class="ttname"><a href="integral__types_8h.html">integral_types.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a0fef8598a0ae3a84bab650cdb1df7adb"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a0fef8598a0ae3a84bab650cdb1df7adb">operations_research::math_opt::CheckScalar</a></div><div class="ttdeci">absl::Status CheckScalar(const double value, const DoubleOptions &amp;options)</div><div class="ttdef"><b>Definition:</b> <a href="scalar__validator_8cc_source.html#l00037">scalar_validator.cc:37</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a40a8cc2cdbe267cc55742fea9f4f3965"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a40a8cc2cdbe267cc55742fea9f4f3965">operations_research::math_opt::ValidatePrimalSolution</a></div><div class="ttdeci">absl::Status ValidatePrimalSolution(const PrimalSolutionProto &amp;primal_solution, const SparseVectorFilterProto &amp;filter, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="solution__validator_8cc_source.html#l00145">solution_validator.cc:145</a></div></div>
<div class="ttc" id="port_2proto__utils_8h_html"><div class="ttname"><a href="port_2proto__utils_8h.html">proto_utils.h</a></div></div>
<div class="ttc" id="sparse__vector__view_8h_html"><div class="ttname"><a href="sparse__vector__view_8h.html">sparse_vector_view.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_html_a760c8bbae2698a370004ceaaba9d9920"><div class="ttname"><a href="namespaceoperations__research.html#a760c8bbae2698a370004ceaaba9d9920">operations_research::ProtoEnumToString</a></div><div class="ttdeci">std::string ProtoEnumToString(ProtoEnumType enum_value)</div><div class="ttdef"><b>Definition:</b> <a href="port_2proto__utils_8h_source.html#l00047">port/proto_utils.h:47</a></div></div>
<div class="ttc" id="callback__validator_8cc_html_a5ae1b0f92815abfe2eb395308b269b0f"><div class="ttname"><a href="callback__validator_8cc.html#a5ae1b0f92815abfe2eb395308b269b0f">RETURN_IF_SCALAR</a></div><div class="ttdeci">#define RETURN_IF_SCALAR(stat, value, option)</div></div>
<div class="ttc" id="trace_8cc_html_a36bd74109f547f7f8198faf5a12d2879"><div class="ttname"><a href="trace_8cc.html#a36bd74109f547f7f8198faf5a12d2879">message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition:</b> <a href="trace_8cc_source.html#l00398">trace.cc:398</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a9ea88232900efb42627bed41c30aede7"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a9ea88232900efb42627bed41c30aede7">operations_research::math_opt::ValidateSparseVectorFilter</a></div><div class="ttdeci">absl::Status ValidateSparseVectorFilter(const SparseVectorFilterProto &amp;v, const IdNameBiMap &amp;valid_ids)</div><div class="ttdef"><b>Definition:</b> <a href="model__parameters__validator_8cc_source.html#l00033">model_parameters_validator.cc:33</a></div></div>
<div class="ttc" id="base_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="model__summary_8h_html"><div class="ttname"><a href="model__summary_8h.html">model_summary.h</a></div></div>
<div class="ttc" id="solution__validator_8h_html"><div class="ttname"><a href="solution__validator_8h.html">solution_validator.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_a37e6d93b6f608edcfeb9c635c4f7b4bb"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a37e6d93b6f608edcfeb9c635c4f7b4bb">operations_research::math_opt::ValidateCallbackResultProto</a></div><div class="ttdeci">absl::Status ValidateCallbackResultProto(const CallbackResultProto &amp;callback_result, const CallbackEventProto callback_event, const CallbackRegistrationProto &amp;callback_registration, const ModelSummary &amp;model_summary)</div><div class="ttdef"><b>Definition:</b> <a href="callback__validator_8cc_source.html#l00252">callback_validator.cc:252</a></div></div>
<div class="ttc" id="namespaceoperations__research_1_1math__opt_html_aa680631976be354abbcd28e2ec941ca7"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#aa680631976be354abbcd28e2ec941ca7">operations_research::math_opt::CheckIdsSubset</a></div><div class="ttdeci">absl::Status CheckIdsSubset(absl::Span&lt; const int64_t &gt; ids, const IdNameBiMap &amp;universe, absl::string_view ids_description, absl::string_view universe_description)</div><div class="ttdef"><b>Definition:</b> <a href="ids__validator_8cc_source.html#l00238">ids_validator.cc:238</a></div></div>
<div class="ttc" id="status__macros_8h_html"><div class="ttname"><a href="status__macros_8h.html">status_macros.h</a></div></div>
<div class="ttc" id="structoperations__research_1_1math__opt_1_1_double_options_html_a7a8704b7d859fbadb282fd5b25e7a3a6"><div class="ttname"><a href="structoperations__research_1_1math__opt_1_1_double_options.html#a7a8704b7d859fbadb282fd5b25e7a3a6">operations_research::math_opt::DoubleOptions::allow_positive_infinity</a></div><div class="ttdeci">bool allow_positive_infinity</div><div class="ttdef"><b>Definition:</b> <a href="scalar__validator_8h_source.html#l00024">scalar_validator.h:24</a></div></div>
<div class="ttc" id="callback__validator_8h_html"><div class="ttname"><a href="callback__validator_8h.html">callback_validator.h</a></div></div>
<div class="ttc" id="namespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
<div class="ttc" id="gscip__solver_8cc_html_aa59e74cc299dbf75fa6e2234dd0849a2"><div class="ttname"><a href="gscip__solver_8cc.html#aa59e74cc299dbf75fa6e2234dd0849a2">coefficients</a></div><div class="ttdeci">absl::Span&lt; const double &gt; coefficients</div><div class="ttdef"><b>Definition:</b> <a href="gscip__solver_8cc_source.html#l00129">gscip_solver.cc:129</a></div></div>
<div class="ttc" id="status__macros_8h_html_acdc223d8c59d5c591dc6b4e88257627b"><div class="ttname"><a href="status__macros_8h.html#acdc223d8c59d5c591dc6b4e88257627b">RETURN_IF_ERROR</a></div><div class="ttdeci">#define RETURN_IF_ERROR(expr)</div><div class="ttdef"><b>Definition:</b> <a href="status__macros_8h_source.html#l00029">status_macros.h:29</a></div></div>
<div class="ttc" id="scalar__validator_8h_html"><div class="ttname"><a href="scalar__validator_8h.html">scalar_validator.h</a></div></div>
2021-04-27 23:00:03 +02:00
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_1defc00030ff81d309105e053121082f.html">math_opt</a></li><li class="navelem"><a class="el" href="dir_2298c6cf5b60fbeba088c3582d3d0ae0.html">validators</a></li><li class="navelem"><a class="el" href="callback__validator_8cc.html">callback_validator.cc</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2022-01-16 18:02:36 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
2021-04-27 23:00:03 +02:00
</ul>
</div>
</body>
</html>