Files
ortools-clone/docs/cpp_sat/cp__model__solver_8h.html
Laurent Perron 0ac3fa17eb more linear doc
2019-07-15 17:42:24 -07:00

109 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>OR-Tools</title>
<meta http-equiv="Content-Type" content="text/html;"/>
<meta charset="utf-8"/>
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">OR-Tools 7.2</span>
</div>
</div>
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
<div id="content">
<!-- Generated by Doxygen 1.8.15 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('cp__model__solver_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">cp_model_solver.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="cp__model__solver_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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceoperations__research"><td class="memItemLeft" align="right" valign="top"> &#160;</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">&#160;</td><td class="mdescRight">Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceoperations__research_1_1sat"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html">operations_research::sat</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a287579e5f181fc7c89feccf1128faffb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#a287579e5f181fc7c89feccf1128faffb">operations_research::sat::CpModelStats</a> (const CpModelProto &amp;model)</td></tr>
<tr class="memdesc:a287579e5f181fc7c89feccf1128faffb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a std::string with some statistics on the given <a class="el" href="classoperations__research_1_1sat_1_1CpModelProto.html">CpModelProto</a>. <a href="namespaceoperations__research_1_1sat.html#a287579e5f181fc7c89feccf1128faffb">More...</a><br /></td></tr>
<tr class="separator:a287579e5f181fc7c89feccf1128faffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2d87e8109f9c60f7af84a60106abd57"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#ac2d87e8109f9c60f7af84a60106abd57">operations_research::sat::CpSolverResponseStats</a> (const CpSolverResponse &amp;response)</td></tr>
<tr class="memdesc:ac2d87e8109f9c60f7af84a60106abd57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a std::string with some statistics on the solver response. <a href="namespaceoperations__research_1_1sat.html#ac2d87e8109f9c60f7af84a60106abd57">More...</a><br /></td></tr>
<tr class="separator:ac2d87e8109f9c60f7af84a60106abd57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d67b9c66f1cb9c1dcc3415cd5af11bf"><td class="memItemLeft" align="right" valign="top">CpSolverResponse&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#a9d67b9c66f1cb9c1dcc3415cd5af11bf">operations_research::sat::SolveCpModel</a> (const CpModelProto &amp;model_proto, Model *model)</td></tr>
<tr class="memdesc:a9d67b9c66f1cb9c1dcc3415cd5af11bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solves the given <a class="el" href="classoperations__research_1_1sat_1_1CpModelProto.html">CpModelProto</a>. <a href="namespaceoperations__research_1_1sat.html#a9d67b9c66f1cb9c1dcc3415cd5af11bf">More...</a><br /></td></tr>
<tr class="separator:a9d67b9c66f1cb9c1dcc3415cd5af11bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09d851f944ab4f305c3d9f8df99b7bf8"><td class="memItemLeft" align="right" valign="top">CpSolverResponse&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#a09d851f944ab4f305c3d9f8df99b7bf8">operations_research::sat::Solve</a> (const CpModelProto &amp;model_proto)</td></tr>
<tr class="memdesc:a09d851f944ab4f305c3d9f8df99b7bf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solves the given cp_model and returns an instance of <a class="el" href="classoperations__research_1_1sat_1_1CpSolverResponse.html">CpSolverResponse</a>. <a href="namespaceoperations__research_1_1sat.html#a09d851f944ab4f305c3d9f8df99b7bf8">More...</a><br /></td></tr>
<tr class="separator:a09d851f944ab4f305c3d9f8df99b7bf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3062797aa0396abf37dbcc99a746f12"><td class="memItemLeft" align="right" valign="top">CpSolverResponse&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12">operations_research::sat::SolveWithParameters</a> (const CpModelProto &amp;model_proto, const SatParameters &amp;params)</td></tr>
<tr class="memdesc:aa3062797aa0396abf37dbcc99a746f12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solves the given cp_model with the give sat parameters, and returns an instance of <a class="el" href="classoperations__research_1_1sat_1_1CpSolverResponse.html">CpSolverResponse</a>. <a href="namespaceoperations__research_1_1sat.html#aa3062797aa0396abf37dbcc99a746f12">More...</a><br /></td></tr>
<tr class="separator:aa3062797aa0396abf37dbcc99a746f12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af52c27ecb43d6486c1a70e022b4aad39"><td class="memItemLeft" align="right" valign="top">CpSolverResponse&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#af52c27ecb43d6486c1a70e022b4aad39">operations_research::sat::SolveWithParameters</a> (const CpModelProto &amp;model_proto, const std::string &amp;params)</td></tr>
<tr class="memdesc:af52c27ecb43d6486c1a70e022b4aad39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solves the given cp_model with the given sat parameters as std::string in JSon format, and returns an instance of <a class="el" href="classoperations__research_1_1sat_1_1CpSolverResponse.html">CpSolverResponse</a>. <a href="namespaceoperations__research_1_1sat.html#af52c27ecb43d6486c1a70e022b4aad39">More...</a><br /></td></tr>
<tr class="separator:af52c27ecb43d6486c1a70e022b4aad39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad04337634227eac006d3e33a7028f82f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#ad04337634227eac006d3e33a7028f82f">operations_research::sat::SetSynchronizationFunction</a> (std::function&lt; CpSolverResponse()&gt; f, Model *model)</td></tr>
<tr class="memdesc:ad04337634227eac006d3e33a7028f82f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If set, the underlying solver will call this function "regularly" in a deterministic way. <a href="namespaceoperations__research_1_1sat.html#ad04337634227eac006d3e33a7028f82f">More...</a><br /></td></tr>
<tr class="separator:ad04337634227eac006d3e33a7028f82f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:aacf15d440f0db4cd0a63c8aebe85db6d"><td class="memItemLeft" align="right" valign="top">std::function&lt; void(Model *)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#aacf15d440f0db4cd0a63c8aebe85db6d">operations_research::sat::NewFeasibleSolutionObserver</a> (const std::function&lt; void(const CpSolverResponse &amp;response)&gt; &amp;observer)</td></tr>
<tr class="memdesc:aacf15d440f0db4cd0a63c8aebe85db6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows to register a solution "observer" with the model with model.Add(NewFeasibleSolutionObserver([](response){...})); The given function will be called on each "improving" feasible solution found during the search. <a href="namespaceoperations__research_1_1sat.html#aacf15d440f0db4cd0a63c8aebe85db6d">More...</a><br /></td></tr>
<tr class="separator:aacf15d440f0db4cd0a63c8aebe85db6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10700832ca6bc420f2931eb707957b0b"><td class="memItemLeft" align="right" valign="top">std::function&lt; SatParameters(Model *)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b">operations_research::sat::NewSatParameters</a> (const std::string &amp;params)</td></tr>
<tr class="memdesc:a10700832ca6bc420f2931eb707957b0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows to change the default parameters with model-&gt;Add(NewSatParameters(parameters_as_string_or_proto)) before calling <a class="el" href="namespaceoperations__research_1_1sat.html#a9d67b9c66f1cb9c1dcc3415cd5af11bf" title="Solves the given CpModelProto.">SolveCpModel()</a>. <a href="namespaceoperations__research_1_1sat.html#a10700832ca6bc420f2931eb707957b0b">More...</a><br /></td></tr>
<tr class="separator:a10700832ca6bc420f2931eb707957b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>