annotated.html 19 KB
Newer Older
Valentin Platzgummer's avatar
Valentin Platzgummer committed
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
<!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"/>-->
        <script type="text/javascript" src="jquery.js"></script>
        <script type="text/javascript" src="dynsections.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="banner-container">
            <div id="banner">
                <span id="sfml">Google OR-Tools 8.1</span>
            </div>
        </div>
        <div id="content" style="width: 100%; overflow: hidden;">
        <div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
        <h2>C++ Reference</h2>
        <ul>
          <li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
          <li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
          <li><a href="../cpp_graph/annotated.html">Graph</a></li>
          <li><a href="../cpp_routing/annotated.html">Routing</a></li>
          <li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
        </ul>
        </div>
        <div id="content">
            <div align="center">
                <h1 style="color: #145A32;">C++ Reference: CP-SAT</h1>
            </div>
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('annotated.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">Class List</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceoperations__research.html" target="_self">operations_research</a></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceoperations__research_1_1sat.html" target="_self">sat</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_automaton_constraint.html" target="_self">AutomatonConstraint</a></td><td class="desc">Specialized automaton constraint </td></tr>
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_bool_var.html" target="_self">BoolVar</a></td><td class="desc">A Boolean variable </td></tr>
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_circuit_constraint.html" target="_self">CircuitConstraint</a></td><td class="desc">Specialized circuit constraint </td></tr>
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_constraint.html" target="_self">Constraint</a></td><td class="desc">A constraint </td></tr>
<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_cp_model_builder.html" target="_self">CpModelBuilder</a></td><td class="desc">Wrapper class around the cp_model proto </td></tr>
<tr id="row_0_0_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_cumulative_constraint.html" target="_self">CumulativeConstraint</a></td><td class="desc">Specialized cumulative constraint </td></tr>
<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_interval_var.html" target="_self">IntervalVar</a></td><td class="desc">Represents a Interval variable </td></tr>
<tr id="row_0_0_7_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_int_var.html" target="_self">IntVar</a></td><td class="desc">An integer variable </td></tr>
<tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_linear_expr.html" target="_self">LinearExpr</a></td><td class="desc">A dedicated container for linear expressions </td></tr>
<tr id="row_0_0_9_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_model.html" target="_self">Model</a></td><td class="desc">Class that owns everything related to a particular optimization model </td></tr>
<tr id="row_0_0_10_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_multiple_circuit_constraint.html" target="_self">MultipleCircuitConstraint</a></td><td class="desc">Specialized circuit constraint </td></tr>
<tr id="row_0_0_11_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_no_overlap2_d_constraint.html" target="_self">NoOverlap2DConstraint</a></td><td class="desc">Specialized no_overlap2D constraint </td></tr>
<tr id="row_0_0_12_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_p_r_o_t_o_b_u_f___f_i_n_a_l.html" target="_self">PROTOBUF_FINAL</a></td><td class="desc"></td></tr>
<tr id="row_0_0_13_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_reservoir_constraint.html" target="_self">ReservoirConstraint</a></td><td class="desc">Specialized reservoir constraint </td></tr>
<tr id="row_0_0_14_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1sat_1_1_table_constraint.html" target="_self">TableConstraint</a></td><td class="desc">Specialized assignment constraint </td></tr>
<tr id="row_0_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structoperations__research_1_1_closed_interval.html" target="_self">ClosedInterval</a></td><td class="desc">Represents a closed interval [start, end] </td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1_domain.html" target="_self">Domain</a></td><td class="desc">We call <em>domain</em> any subset of Int64 = [kint64min, kint64max] </td></tr>
<tr id="row_0_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1_nested_time_limit.html" target="_self">NestedTimeLimit</a></td><td class="desc">Provides a way to nest time limits for algorithms where a certain part of the computation is bounded not just by the overall time limit, but also by a stricter time limit specific just for this particular part </td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1_shared_time_limit.html" target="_self">SharedTimeLimit</a></td><td class="desc"></td></tr>
<tr id="row_0_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_5_" class="arrow" onclick="toggleFolder('0_5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1_sorted_disjoint_interval_list.html" target="_self">SortedDisjointIntervalList</a></td><td class="desc">This class represents a sorted list of disjoint, closed intervals </td></tr>
<tr id="row_0_5_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structoperations__research_1_1_sorted_disjoint_interval_list_1_1_interval_comparator.html" target="_self">IntervalComparator</a></td><td class="desc"></td></tr>
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classoperations__research_1_1_time_limit.html" target="_self">TimeLimit</a></td><td class="desc">A simple class to enforce both an elapsed time limit and a deterministic time limit in the same thread as a program </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_cp_solver_status_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::CpSolverStatus &gt;</a></td><td class="desc"></td></tr>
<tr id="row_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_decision_strategy_proto___domain_reduction_strategy_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::DecisionStrategyProto_DomainReductionStrategy &gt;</a></td><td class="desc"></td></tr>
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_decision_strategy_proto___variable_selection_strategy_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::DecisionStrategyProto_VariableSelectionStrategy &gt;</a></td><td class="desc"></td></tr>
<tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___binary_minization_algorithm_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_BinaryMinizationAlgorithm &gt;</a></td><td class="desc"></td></tr>
<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___clause_ordering_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_ClauseOrdering &gt;</a></td><td class="desc"></td></tr>
<tr id="row_6_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___clause_protection_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_ClauseProtection &gt;</a></td><td class="desc"></td></tr>
<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___conflict_minimization_algorithm_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_ConflictMinimizationAlgorithm &gt;</a></td><td class="desc"></td></tr>
<tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___f_p_rounding_method_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_FPRoundingMethod &gt;</a></td><td class="desc"></td></tr>
<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___max_sat_assumption_order_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_MaxSatAssumptionOrder &gt;</a></td><td class="desc"></td></tr>
<tr id="row_10_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___max_sat_stratification_algorithm_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_MaxSatStratificationAlgorithm &gt;</a></td><td class="desc"></td></tr>
<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___polarity_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_Polarity &gt;</a></td><td class="desc"></td></tr>
<tr id="row_12_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___restart_algorithm_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_RestartAlgorithm &gt;</a></td><td class="desc"></td></tr>
<tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___search_branching_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_SearchBranching &gt;</a></td><td class="desc"></td></tr>
<tr id="row_14_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structis__proto__enum_3_01_1_1operations__research_1_1sat_1_1_sat_parameters___variable_order_01_4.html" target="_self">is_proto_enum&lt; ::operations_research::sat::SatParameters_VariableOrder &gt;</a></td><td class="desc"></td></tr>
<tr id="row_15_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table_struct__ortools__2fsat__2fboolean__5fproblem__2eproto.html" target="_self">TableStruct_ortools_2fsat_2fboolean_5fproblem_2eproto</a></td><td class="desc"></td></tr>
<tr id="row_16_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table_struct__ortools__2fsat__2fcp__5fmodel__2eproto.html" target="_self">TableStruct_ortools_2fsat_2fcp_5fmodel_2eproto</a></td><td class="desc"></td></tr>
<tr id="row_17_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_table_struct__ortools__2fsat__2fsat__5fparameters__2eproto.html" target="_self">TableStruct_ortools_2fsat_2fsat_5fparameters_2eproto</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
        </div>
        </div>
        <div id="footer-container">
            <div id="footer">
            </div>
        </div>
    </body>
</html>