2020-09-01 16:00:33 +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-17 21:42:14 +01:00
< meta name = "generator" content = "Doxygen 1.9.3" / >
2020-09-01 16:00:33 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > OR-Tools: cp_model_symmetries.h 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
2022-03-04 00:11:33 +01:00
  < span id = "projectnumber" > 9.3< / span >
2020-09-01 16:00:33 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2022-01-17 21:42:14 +01:00
<!-- Generated by Doxygen 1.9.3 -->
2020-09-01 16:00:33 +02:00
< script type = "text/javascript" >
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
2020-09-01 16:00:33 +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-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2020-09-01 16:00:33 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-01-17 21:42:14 +01:00
/* @license-end */
< / script >
2020-09-01 16:00:33 +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-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(document).ready(function(){initNavTree('cp__model__symmetries_8h_source.html',''); initResizable(); });
2020-09-01 16:00:33 +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-17 21:42:14 +01:00
< div class = "headertitle" > < div class = "title" > cp_model_symmetries.h< / div > < / div >
2020-09-01 16:00:33 +02:00
< / div > <!-- header -->
< div class = "contents" >
2022-01-17 21:42:14 +01:00
< a href = "cp__model__symmetries_8h.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" > #ifndef OR_TOOLS_SAT_CP_MODEL_SYMMETRIES_H_< / span > < / div >
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < span class = "preprocessor" > #define OR_TOOLS_SAT_CP_MODEL_SYMMETRIES_H_< / span > < / div >
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / 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 < memory> < / span > < / div >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > 19< / span > < span class = "preprocessor" > #include < vector> < / span > < / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "preprocessor" > #include " < a class = "code" href = "sparse__permutation_8h.html" > ortools/algorithms/sparse_permutation.h< / a > " < / span > < / div >
2022-03-04 00:11:33 +01:00
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < span class = "preprocessor" > #include " ortools/sat/cp_model.pb.h" < / span > < / div >
2022-01-17 21:42:14 +01:00
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < span class = "preprocessor" > #include " < a class = "code" href = "presolve__context_8h.html" > ortools/sat/presolve_context.h< / a > " < / span > < / div >
2022-03-04 00:11:33 +01:00
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < span class = "preprocessor" > #include " ortools/sat/sat_parameters.pb.h" < / span > < / div >
2022-01-17 21:42:14 +01:00
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > 25< / span > < span class = "preprocessor" > #include " < a class = "code" href = "util_2logging_8h.html" > ortools/util/logging.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > 27< / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespaceoperations__research.html" > operations_research< / a > {< / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < span class = "keyword" > namespace < / span > sat {< / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > < / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > 30< / span > < span class = "comment" > // Returns a list of generators of the symmetry group of the given problem. Each< / span > < / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < span class = "comment" > // generator is a permutation of the integer range [0, n) where n is the number< / span > < / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > < span class = "comment" > // of variables of the problem. They are permutations of the (index< / span > < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < span class = "comment" > // representation of the) problem variables.< / span > < / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "comment" > //< / span > < / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > < span class = "comment" > // Note that we ignore the variables that appear in no constraint, instead of< / span > < / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > < span class = "comment" > // outputing the full symmetry group involving them.< / span > < / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > < span class = "comment" > //< / span > < / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < span class = "comment" > // TODO(user): On SAT problems it is more powerful to detect permutations also< / span > < / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < span class = "comment" > // involving the negation of the problem variables. So that we could find a< / span > < / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > < span class = "comment" > // symmetry x < -> not(y) for instance.< / span > < / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "comment" > //< / span > < / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > < span class = "comment" > // TODO(user): As long as we only exploit symmetry involving only Boolean< / span > < / div >
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > < span class = "comment" > // variables we can make this code more efficient by not detecting symmetries< / span > < / div >
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > < span class = "comment" > // involing integer variable.< / span > < / div >
< div class = "line" > < a id = "l00045" name = "l00045" > < / a > < span class = "lineno" > 45< / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespaceoperations__research_1_1sat.html#acb3c20cf3ea92b6e424b1bf0dfa81d79" > FindCpModelSymmetries< / a > (< / div >
< div class = "line" > < a id = "l00046" name = "l00046" > < / a > < span class = "lineno" > 46< / span > < span class = "keyword" > const< / span > SatParameters& params, < span class = "keyword" > const< / span > CpModelProto& problem,< / div >
< div class = "line" > < a id = "l00047" name = "l00047" > < / a > < span class = "lineno" > 47< / span > std::vector< std::unique_ptr< SparsePermutation> > * generators,< / div >
< div class = "line" > < a id = "l00048" name = "l00048" > < / a > < span class = "lineno" > 48< / span > < span class = "keywordtype" > double< / span > deterministic_limit, SolverLogger* logger);< / div >
< div class = "line" > < a id = "l00049" name = "l00049" > < / a > < span class = "lineno" > 49< / span > < / div >
< div class = "line" > < a id = "l00050" name = "l00050" > < / a > < span class = "lineno" > 50< / span > < span class = "comment" > // Detects symmetries and fill the symmetry field.< / span > < / div >
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > 51< / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespaceoperations__research_1_1sat.html#a0fc24fd6e8320e397bb6700b009a8f3b" > DetectAndAddSymmetryToProto< / a > (< span class = "keyword" > const< / span > SatParameters& params,< / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > 52< / span > CpModelProto* < a class = "code hl_variable" href = "cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2" > proto< / a > , SolverLogger* logger);< / div >
< div class = "line" > < a id = "l00053" name = "l00053" > < / a > < span class = "lineno" > 53< / span > < / div >
< div class = "line" > < a id = "l00054" name = "l00054" > < / a > < span class = "lineno" > 54< / span > < span class = "comment" > // Basic implementation of some symmetry breaking during presolve.< / span > < / div >
< div class = "line" > < a id = "l00055" name = "l00055" > < / a > < span class = "lineno" > 55< / span > < span class = "comment" > //< / span > < / div >
< div class = "line" > < a id = "l00056" name = "l00056" > < / a > < span class = "lineno" > 56< / span > < span class = "comment" > // Currently this just try to fix variables by detecting symmetries between< / span > < / div >
< div class = "line" > < a id = "l00057" name = "l00057" > < / a > < span class = "lineno" > 57< / span > < span class = "comment" > // Booleans in bool_and, at_most_one or exactly_one constraints.< / span > < / div >
< div class = "line" > < a id = "l00058" name = "l00058" > < / a > < span class = "lineno" > 58< / span > < span class = "keywordtype" > bool< / span > < a class = "code hl_function" href = "namespaceoperations__research_1_1sat.html#a1b24f74de50e3483bbefacffcd349eb1" > DetectAndExploitSymmetriesInPresolve< / a > (PresolveContext* < a class = "code hl_variable" href = "gurobi__interface_8cc.html#a5f287b83a753915ae862fed64f8640a6" > context< / a > );< / div >
< div class = "line" > < a id = "l00059" name = "l00059" > < / a > < span class = "lineno" > 59< / span > < / div >
< div class = "line" > < a id = "l00060" name = "l00060" > < / a > < span class = "lineno" > 60< / span > } < span class = "comment" > // namespace sat< / span > < / div >
< div class = "line" > < a id = "l00061" name = "l00061" > < / a > < span class = "lineno" > 61< / span > } < span class = "comment" > // namespace operations_research< / span > < / div >
< div class = "line" > < a id = "l00062" name = "l00062" > < / a > < span class = "lineno" > 62< / span > < / div >
< div class = "line" > < a id = "l00063" name = "l00063" > < / a > < span class = "lineno" > 63< / span > < span class = "preprocessor" > #endif < / span > < span class = "comment" > // OR_TOOLS_SAT_CP_MODEL_SYMMETRIES_H_< / span > < / div >
2022-03-04 00:11:33 +01:00
< div class = "ttc" id = "acp__model__fz__solver_8cc_html_aed003f5eb5197bc586b7ef2c36a63da2" > < div class = "ttname" > < a href = "cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2" > proto< / a > < / div > < div class = "ttdeci" > CpModelProto proto< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "cp__model__fz__solver_8cc_source.html#l00118" > cp_model_fz_solver.cc:118< / a > < / div > < / div >
2022-01-17 21:42:14 +01:00
< div class = "ttc" id = "agurobi__interface_8cc_html_a5f287b83a753915ae862fed64f8640a6" > < div class = "ttname" > < a href = "gurobi__interface_8cc.html#a5f287b83a753915ae862fed64f8640a6" > context< / a > < / div > < div class = "ttdeci" > GurobiMPCallbackContext * context< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "gurobi__interface_8cc_source.html#l00514" > gurobi_interface.cc:514< / a > < / div > < / div >
2022-03-04 00:11:33 +01:00
< div class = "ttc" id = "anamespaceoperations__research_1_1sat_html_a0fc24fd6e8320e397bb6700b009a8f3b" > < div class = "ttname" > < a href = "namespaceoperations__research_1_1sat.html#a0fc24fd6e8320e397bb6700b009a8f3b" > operations_research::sat::DetectAndAddSymmetryToProto< / a > < / div > < div class = "ttdeci" > void DetectAndAddSymmetryToProto(const SatParameters & params, CpModelProto *proto, SolverLogger *logger)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "cp__model__symmetries_8cc_source.html#l00564" > cp_model_symmetries.cc:564< / a > < / div > < / div >
< div class = "ttc" id = "anamespaceoperations__research_1_1sat_html_a1b24f74de50e3483bbefacffcd349eb1" > < div class = "ttname" > < a href = "namespaceoperations__research_1_1sat.html#a1b24f74de50e3483bbefacffcd349eb1" > operations_research::sat::DetectAndExploitSymmetriesInPresolve< / a > < / div > < div class = "ttdeci" > bool DetectAndExploitSymmetriesInPresolve(PresolveContext *context)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "cp__model__symmetries_8cc_source.html#l00676" > cp_model_symmetries.cc:676< / a > < / div > < / div >
< div class = "ttc" id = "anamespaceoperations__research_1_1sat_html_acb3c20cf3ea92b6e424b1bf0dfa81d79" > < div class = "ttname" > < a href = "namespaceoperations__research_1_1sat.html#acb3c20cf3ea92b6e424b1bf0dfa81d79" > operations_research::sat::FindCpModelSymmetries< / a > < / div > < div class = "ttdeci" > void FindCpModelSymmetries(const SatParameters & params, const CpModelProto & problem, std::vector< std::unique_ptr< SparsePermutation > > *generators, double deterministic_limit, SolverLogger *logger)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "cp__model__symmetries_8cc_source.html#l00475" > cp_model_symmetries.cc:475< / a > < / div > < / div >
2022-01-17 21:42:14 +01:00
< 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 = "apresolve__context_8h_html" > < div class = "ttname" > < a href = "presolve__context_8h.html" > presolve_context.h< / a > < / div > < / div >
< div class = "ttc" id = "asparse__permutation_8h_html" > < div class = "ttname" > < a href = "sparse__permutation_8h.html" > sparse_permutation.h< / a > < / div > < / div >
< div class = "ttc" id = "autil_2logging_8h_html" > < div class = "ttname" > < a href = "util_2logging_8h.html" > logging.h< / a > < / div > < / div >
2021-01-26 11:28:50 +01:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2020-09-01 16:00:33 +02:00
<!-- 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_dddac007a45022d9da6ea1dee012c3b9.html" > sat< / a > < / li > < li class = "navelem" > < a class = "el" href = "cp__model__symmetries_8h.html" > cp_model_symmetries.h< / a > < / li >
< li class = "footer" > Generated by
< a href = "http://www.doxygen.org/index.html" >
2022-01-17 21:42:14 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.9.3 < / li >
2020-09-01 16:00:33 +02:00
< / ul >
< / div >
< / body >
< / html >
