243 lines
17 KiB
HTML
243 lines
17 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.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: fp_utils.h File Reference</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.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('fp__utils_8h.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="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fp_utils.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a href="fp__utils_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_scoped_floating_point_env.html">ScopedFloatingPointEnv</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespaceoperations__research"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html">operations_research</a></td></tr>
|
|
<tr class="memdesc:namespaceoperations__research"><td class="mdescLeft"> </td><td class="mdescRight">Collection of objects used to extend the <a class="el" href="classoperations__research_1_1_constraint.html" title="A constraint is the main modeling object.">Constraint</a> <a class="el" href="classoperations__research_1_1_solver.html" title="Solver Class.">Solver</a> library. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a417a0547a8cf6eff90b4430609e054b0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fp__utils_8h.html#a417a0547a8cf6eff90b4430609e054b0">EXPECT_COMPARABLE</a>(expected, obtained, epsilon)</td></tr>
|
|
<tr class="separator:a417a0547a8cf6eff90b4430609e054b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ba22f5b9700b4d8930219ecd6cf5a1a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="fp__utils_8h.html#a9ba22f5b9700b4d8930219ecd6cf5a1a">EXPECT_NOTCOMPARABLE</a>(expected, obtained, epsilon)</td></tr>
|
|
<tr class="separator:a9ba22f5b9700b4d8930219ecd6cf5a1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:addb09ab3f085b1424ee43c8565494b40"><td class="memTemplParams" colspan="2">template<typename FloatType > </td></tr>
|
|
<tr class="memitem:addb09ab3f085b1424ee43c8565494b40"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#addb09ab3f085b1424ee43c8565494b40">IsPositiveOrNegativeInfinity</a> (FloatType x)</td></tr>
|
|
<tr class="separator:addb09ab3f085b1424ee43c8565494b40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4175e34e3e7f573a9dd0187b199afc24"><td class="memTemplParams" colspan="2">template<typename FloatType > </td></tr>
|
|
<tr class="memitem:a4175e34e3e7f573a9dd0187b199afc24"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a4175e34e3e7f573a9dd0187b199afc24">AreWithinAbsoluteOrRelativeTolerances</a> (FloatType x, FloatType y, FloatType relative_tolerance, FloatType absolute_tolerance)</td></tr>
|
|
<tr class="separator:a4175e34e3e7f573a9dd0187b199afc24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a705ecff17f450f06856ceec064725b8d"><td class="memTemplParams" colspan="2">template<typename FloatType > </td></tr>
|
|
<tr class="memitem:a705ecff17f450f06856ceec064725b8d"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a705ecff17f450f06856ceec064725b8d">AreWithinAbsoluteTolerance</a> (FloatType x, FloatType y, FloatType absolute_tolerance)</td></tr>
|
|
<tr class="separator:a705ecff17f450f06856ceec064725b8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a096ed4f933f943ccb8859e0dc08b06ca"><td class="memTemplParams" colspan="2">template<typename FloatType > </td></tr>
|
|
<tr class="memitem:a096ed4f933f943ccb8859e0dc08b06ca"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a096ed4f933f943ccb8859e0dc08b06ca">IsSmallerWithinTolerance</a> (FloatType x, FloatType y, FloatType tolerance)</td></tr>
|
|
<tr class="separator:a096ed4f933f943ccb8859e0dc08b06ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1181732aa2f4c08e28ea32b1c7c6f256"><td class="memTemplParams" colspan="2">template<typename FloatType > </td></tr>
|
|
<tr class="memitem:a1181732aa2f4c08e28ea32b1c7c6f256"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a1181732aa2f4c08e28ea32b1c7c6f256">IsIntegerWithinTolerance</a> (FloatType x, FloatType tolerance)</td></tr>
|
|
<tr class="separator:a1181732aa2f4c08e28ea32b1c7c6f256"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cc8b704d0f858f38ad0851bc1b9d478"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a7cc8b704d0f858f38ad0851bc1b9d478">GetBestScalingOfDoublesToInt64</a> (const std::vector< double > &<a class="el" href="parser_8yy_8cc.html#a5a634cf4429798b1c921a81de8250051">input</a>, int64_t max_absolute_sum, double *scaling_factor, double *<a class="el" href="sat_2lp__utils_8cc.html#a2a1a02478d02cd8e42a1afece079d4a2">max_relative_coeff_error</a>)</td></tr>
|
|
<tr class="separator:a7cc8b704d0f858f38ad0851bc1b9d478"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae3359f1c2367d44e5cf9be5d5abc89f"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#aae3359f1c2367d44e5cf9be5d5abc89f">GetBestScalingOfDoublesToInt64</a> (const std::vector< double > &<a class="el" href="parser_8yy_8cc.html#a5a634cf4429798b1c921a81de8250051">input</a>, const std::vector< double > &lb, const std::vector< double > &ub, int64_t max_absolute_sum)</td></tr>
|
|
<tr class="separator:aae3359f1c2367d44e5cf9be5d5abc89f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46f21c3da23685e58b31d880b2144458"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a46f21c3da23685e58b31d880b2144458">ComputeScalingErrors</a> (const std::vector< double > &<a class="el" href="parser_8yy_8cc.html#a5a634cf4429798b1c921a81de8250051">input</a>, const std::vector< double > &lb, const std::vector< double > &ub, double scaling_factor, double *<a class="el" href="sat_2lp__utils_8cc.html#a2a1a02478d02cd8e42a1afece079d4a2">max_relative_coeff_error</a>, double *max_scaled_sum_error)</td></tr>
|
|
<tr class="separator:a46f21c3da23685e58b31d880b2144458"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae2e6ed909e0cd5f240b885800f55c87"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#aae2e6ed909e0cd5f240b885800f55c87">ComputeGcdOfRoundedDoubles</a> (const std::vector< double > &x, double scaling_factor)</td></tr>
|
|
<tr class="separator:aae2e6ed909e0cd5f240b885800f55c87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2adddfecac47612f1da312dbb80d91b7"><td class="memTemplParams" colspan="2">template<typename FloatType > </td></tr>
|
|
<tr class="memitem:a2adddfecac47612f1da312dbb80d91b7"><td class="memTemplItemLeft" align="right" valign="top">FloatType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research.html#a2adddfecac47612f1da312dbb80d91b7">Interpolate</a> (FloatType x, FloatType y, FloatType alpha)</td></tr>
|
|
<tr class="separator:a2adddfecac47612f1da312dbb80d91b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a417a0547a8cf6eff90b4430609e054b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a417a0547a8cf6eff90b4430609e054b0">◆ </a></span>EXPECT_COMPARABLE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define EXPECT_COMPARABLE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">expected, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">obtained, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">epsilon </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> EXPECT_TRUE(<a class="code" href="namespaceoperations__research.html#a4175e34e3e7f573a9dd0187b199afc24">operations_research::AreWithinAbsoluteOrRelativeTolerances</a>( \</div>
|
|
<div class="line"> expected, obtained, epsilon, epsilon)) \</div>
|
|
<div class="line"> << obtained << <span class="stringliteral">" != expected value "</span> << expected \</div>
|
|
<div class="line"> << <span class="stringliteral">" within epsilon = "</span> << epsilon;</div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a4175e34e3e7f573a9dd0187b199afc24"><div class="ttname"><a href="namespaceoperations__research.html#a4175e34e3e7f573a9dd0187b199afc24">operations_research::AreWithinAbsoluteOrRelativeTolerances</a></div><div class="ttdeci">bool AreWithinAbsoluteOrRelativeTolerances(FloatType x, FloatType y, FloatType relative_tolerance, FloatType absolute_tolerance)</div><div class="ttdef"><b>Definition:</b> <a href="fp__utils_8h_source.html#l00120">fp_utils.h:120</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="fp__utils_8h_source.html#l00170">170</a> of file <a class="el" href="fp__utils_8h_source.html">fp_utils.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9ba22f5b9700b4d8930219ecd6cf5a1a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ba22f5b9700b4d8930219ecd6cf5a1a">◆ </a></span>EXPECT_NOTCOMPARABLE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define EXPECT_NOTCOMPARABLE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">expected, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">obtained, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">epsilon </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> EXPECT_FALSE(<a class="code" href="namespaceoperations__research.html#a4175e34e3e7f573a9dd0187b199afc24">operations_research::AreWithinAbsoluteOrRelativeTolerances</a>( \</div>
|
|
<div class="line"> expected, obtained, epsilon, epsilon)) \</div>
|
|
<div class="line"> << obtained << <span class="stringliteral">" == expected value "</span> << expected \</div>
|
|
<div class="line"> << <span class="stringliteral">" within epsilon = "</span> << epsilon;</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="fp__utils_8h_source.html#l00176">176</a> of file <a class="el" href="fp__utils_8h_source.html">fp_utils.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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_a3328a0ea67a2aaa160c2783ffbaa5dc.html">util</a></li><li class="navelem"><a class="el" href="fp__utils_8h.html">fp_utils.h</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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|