176 lines
20 KiB
HTML
176 lines
20 KiB
HTML
<!-- 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"/>
|
|
<meta name="generator" content="Doxygen 1.9.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: scalar_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>
|
|
<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
|
|
 <span id="projectnumber">9.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('scalar__validator_8cc_source.html',''); initResizable(); });
|
|
/* @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">
|
|
<div class="headertitle"><div class="title">scalar_validator.cc</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="scalar__validator_8cc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include "<a class="code" href="scalar__validator_8h.html">ortools/math_opt/validators/scalar_validator.h</a>"</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include <cmath></span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include <limits></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include "absl/status/status.h"</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "absl/strings/str_cat.h"</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span>math_opt {</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">namespace </span>{</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">constexpr</span> <span class="keywordtype">double</span> <a class="code hl_variable" href="namespaceoperations__research_1_1math__opt.html#ad9f50c9313b35cc1e8887057dc4d9645">kInf</a> = std::numeric_limits<double>::infinity();</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>} <span class="comment">// namespace</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1math__opt.html#ad45d12cfd14f770f145f80788e5fe859"> 29</a></span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#ad45d12cfd14f770f145f80788e5fe859">CheckScalarNoNanNoInf</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> d) {</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordflow">if</span> (!std::isfinite(d)) {</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">return</span> absl::InvalidArgumentError(</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> absl::StrCat(<span class="stringliteral">"Expected no NaN or inf but found value: "</span>, d));</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> }</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">return</span> absl::OkStatus();</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>}</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1math__opt.html#a0fef8598a0ae3a84bab650cdb1df7adb"> 37</a></span>absl::Status <a class="code hl_function" href="namespaceoperations__research_1_1math__opt.html#a0fef8598a0ae3a84bab650cdb1df7adb">CheckScalar</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>, <span class="keyword">const</span> <a class="code hl_struct" href="structoperations__research_1_1math__opt_1_1_double_options.html">DoubleOptions</a>& options) {</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">if</span> (std::isnan(<a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>)) {</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">return</span> absl::InvalidArgumentError(<span class="stringliteral">"Invalid NaN value"</span>);</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">if</span> (!options.<a class="code hl_variable" href="structoperations__research_1_1math__opt_1_1_double_options.html#a7a8704b7d859fbadb282fd5b25e7a3a6">allow_positive_infinity</a> && <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a> == <a class="code hl_variable" href="namespaceoperations__research_1_1math__opt.html#ad9f50c9313b35cc1e8887057dc4d9645">kInf</a>) {</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> absl::InvalidArgumentError(<span class="stringliteral">"Invalid positive infinite value"</span>);</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">if</span> (!options.<a class="code hl_variable" href="structoperations__research_1_1math__opt_1_1_double_options.html#ad98cfcfb281319994d4f9ac805fbabee">allow_negative_infinity</a> && <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a> == -<a class="code hl_variable" href="namespaceoperations__research_1_1math__opt.html#ad9f50c9313b35cc1e8887057dc4d9645">kInf</a>) {</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">return</span> absl::InvalidArgumentError(<span class="stringliteral">"Invalid negative infinite value"</span>);</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">if</span> (!options.<a class="code hl_variable" href="structoperations__research_1_1math__opt_1_1_double_options.html#a6c45e87af20aaf4c6808078845279afa">allow_positive</a> && <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a> > 0) {</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">return</span> absl::InvalidArgumentError(</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> absl::StrCat(<span class="stringliteral">"Invalid positive value = "</span>, <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>));</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">if</span> (!options.<a class="code hl_variable" href="structoperations__research_1_1math__opt_1_1_double_options.html#aab8451781022ee9145bf9f056ee01771">allow_negative</a> && <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a> < 0) {</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">return</span> absl::InvalidArgumentError(</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> absl::StrCat(<span class="stringliteral">"Invalid negative value = "</span>, <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>));</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">return</span> absl::OkStatus();</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>}</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>} <span class="comment">// namespace math_opt</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} <span class="comment">// namespace operations_research</span></div>
|
|
<div class="ttc" id="ademon__profiler_8cc_html_ac072af30c4ffbc834bb4c681f6ecb514"><div class="ttname"><a href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a></div><div class="ttdeci">int64_t value</div><div class="ttdef"><b>Definition:</b> <a href="demon__profiler_8cc_source.html#l00044">demon_profiler.cc:44</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__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 &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="anamespaceoperations__research_1_1math__opt_html_ad45d12cfd14f770f145f80788e5fe859"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#ad45d12cfd14f770f145f80788e5fe859">operations_research::math_opt::CheckScalarNoNanNoInf</a></div><div class="ttdeci">absl::Status CheckScalarNoNanNoInf(const double d)</div><div class="ttdef"><b>Definition:</b> <a href="scalar__validator_8cc_source.html#l00029">scalar_validator.cc:29</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__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="anamespaceoperations__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="ascalar__validator_8h_html"><div class="ttname"><a href="scalar__validator_8h.html">scalar_validator.h</a></div></div>
|
|
<div class="ttc" id="astructoperations__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="astructoperations__research_1_1math__opt_1_1_double_options_html_a6c45e87af20aaf4c6808078845279afa"><div class="ttname"><a href="structoperations__research_1_1math__opt_1_1_double_options.html#a6c45e87af20aaf4c6808078845279afa">operations_research::math_opt::DoubleOptions::allow_positive</a></div><div class="ttdeci">bool allow_positive</div><div class="ttdef"><b>Definition:</b> <a href="scalar__validator_8h_source.html#l00027">scalar_validator.h:27</a></div></div>
|
|
<div class="ttc" id="astructoperations__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="astructoperations__research_1_1math__opt_1_1_double_options_html_aab8451781022ee9145bf9f056ee01771"><div class="ttname"><a href="structoperations__research_1_1math__opt_1_1_double_options.html#aab8451781022ee9145bf9f056ee01771">operations_research::math_opt::DoubleOptions::allow_negative</a></div><div class="ttdeci">bool allow_negative</div><div class="ttdef"><b>Definition:</b> <a href="scalar__validator_8h_source.html#l00026">scalar_validator.h:26</a></div></div>
|
|
<div class="ttc" id="astructoperations__research_1_1math__opt_1_1_double_options_html_ad98cfcfb281319994d4f9ac805fbabee"><div class="ttname"><a href="structoperations__research_1_1math__opt_1_1_double_options.html#ad98cfcfb281319994d4f9ac805fbabee">operations_research::math_opt::DoubleOptions::allow_negative_infinity</a></div><div class="ttdeci">bool allow_negative_infinity</div><div class="ttdef"><b>Definition:</b> <a href="scalar__validator_8h_source.html#l00025">scalar_validator.h:25</a></div></div>
|
|
</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="scalar__validator_8cc.html">scalar_validator.cc</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|