216 lines
17 KiB
HTML
216 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.3"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: enums.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.3</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.3 -->
|
|
<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('enums_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="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">enums.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a href="enums_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 id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1math__opt_1_1_enum.html">Enum< E ></a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1math__opt_1_1_enum_proto.html">EnumProto< P ></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 id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespaceoperations__research"><td class="memItemLeft" align="right" valign="top">namespace  </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>
|
|
<tr class="memitem:namespaceoperations__research_1_1math__opt"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html">operations_research::math_opt</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 id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:af602afafd0a177b2dcab54c32c999d81"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="enums_8h.html#af602afafd0a177b2dcab54c32c999d81">MATH_OPT_DEFINE_ENUM</a>(CppEnum, proto_unspecified_value)</td></tr>
|
|
<tr class="separator:af602afafd0a177b2dcab54c32c999d81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a421f67b1b543745af048494865a94609"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#a421f67b1b543745af048494865a94609">ProtoEnumIsValid</a> = bool(*)(int)</td></tr>
|
|
<tr class="separator:a421f67b1b543745af048494865a94609"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:afd93f2315e9dc6bea76df7e7d0d853d1"><td class="memTemplParams" colspan="2">template<typename E > </td></tr>
|
|
<tr class="memitem:afd93f2315e9dc6bea76df7e7d0d853d1"><td class="memTemplItemLeft" align="right" valign="top">Enum< E >::Proto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#afd93f2315e9dc6bea76df7e7d0d853d1">EnumToProto</a> (const std::optional< E > <a class="el" href="primal__dual__hybrid__gradient_8cc.html#a730b1ea892f1f794d9bd5f16027acb63">value</a>)</td></tr>
|
|
<tr class="separator:afd93f2315e9dc6bea76df7e7d0d853d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86f945abbc696d74a9dc599130fdbd6d"><td class="memTemplParams" colspan="2">template<typename E > </td></tr>
|
|
<tr class="memitem:a86f945abbc696d74a9dc599130fdbd6d"><td class="memTemplItemLeft" align="right" valign="top">Enum< E >::Proto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#a86f945abbc696d74a9dc599130fdbd6d">EnumToProto</a> (const E <a class="el" href="primal__dual__hybrid__gradient_8cc.html#a730b1ea892f1f794d9bd5f16027acb63">value</a>)</td></tr>
|
|
<tr class="separator:a86f945abbc696d74a9dc599130fdbd6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd8f963e2ba6b11aafb05a134bcdb7d7"><td class="memTemplParams" colspan="2">template<typename P > </td></tr>
|
|
<tr class="memitem:acd8f963e2ba6b11aafb05a134bcdb7d7"><td class="memTemplItemLeft" align="right" valign="top">std::optional< typename EnumProto< P >::Cpp > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#acd8f963e2ba6b11aafb05a134bcdb7d7">EnumFromProto</a> (const P proto_value)</td></tr>
|
|
<tr class="separator:acd8f963e2ba6b11aafb05a134bcdb7d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f53152d02871cc3d74708a98798108e"><td class="memTemplParams" colspan="2">template<typename E > </td></tr>
|
|
<tr class="memitem:a0f53152d02871cc3d74708a98798108e"><td class="memTemplItemLeft" align="right" valign="top">absl::string_view </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#a0f53152d02871cc3d74708a98798108e">EnumToString</a> (const E <a class="el" href="primal__dual__hybrid__gradient_8cc.html#a730b1ea892f1f794d9bd5f16027acb63">value</a>)</td></tr>
|
|
<tr class="separator:a0f53152d02871cc3d74708a98798108e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9534b6743126afe27e4982249abcbf4"><td class="memTemplParams" colspan="2">template<typename E > </td></tr>
|
|
<tr class="memitem:ab9534b6743126afe27e4982249abcbf4"><td class="memTemplItemLeft" align="right" valign="top">std::optional< absl::string_view > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#ab9534b6743126afe27e4982249abcbf4">EnumToOptString</a> (const E <a class="el" href="primal__dual__hybrid__gradient_8cc.html#a730b1ea892f1f794d9bd5f16027acb63">value</a>)</td></tr>
|
|
<tr class="separator:ab9534b6743126afe27e4982249abcbf4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00d8499c8f5baa9ecd7b24d34d7b25a2"><td class="memTemplParams" colspan="2">template<typename E > </td></tr>
|
|
<tr class="memitem:a00d8499c8f5baa9ecd7b24d34d7b25a2"><td class="memTemplItemLeft" align="right" valign="top">std::optional< E > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#a00d8499c8f5baa9ecd7b24d34d7b25a2">EnumFromString</a> (const absl::string_view str)</td></tr>
|
|
<tr class="separator:a00d8499c8f5baa9ecd7b24d34d7b25a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e76538efbebc3745c913d17d09bfa68"><td class="memTemplParams" colspan="2">template<typename E , typename = std::enable_if_t<Enum<E>::kIsImplemented>> </td></tr>
|
|
<tr class="memitem:a2e76538efbebc3745c913d17d09bfa68"><td class="memTemplItemLeft" align="right" valign="top">std::ostream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#a2e76538efbebc3745c913d17d09bfa68">operator<<</a> (std::ostream &out, const E <a class="el" href="primal__dual__hybrid__gradient_8cc.html#a730b1ea892f1f794d9bd5f16027acb63">value</a>)</td></tr>
|
|
<tr class="separator:a2e76538efbebc3745c913d17d09bfa68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d5fc713961a16f62654a672dc55346e"><td class="memTemplParams" colspan="2">template<typename E , typename = std::enable_if_t<Enum<E>::kIsImplemented>> </td></tr>
|
|
<tr class="memitem:a2d5fc713961a16f62654a672dc55346e"><td class="memTemplItemLeft" align="right" valign="top">std::ostream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceoperations__research_1_1math__opt.html#a2d5fc713961a16f62654a672dc55346e">operator<<</a> (std::ostream &out, const std::optional< E > opt_value)</td></tr>
|
|
<tr class="separator:a2d5fc713961a16f62654a672dc55346e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="af602afafd0a177b2dcab54c32c999d81" name="af602afafd0a177b2dcab54c32c999d81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af602afafd0a177b2dcab54c32c999d81">◆ </a></span>MATH_OPT_DEFINE_ENUM</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MATH_OPT_DEFINE_ENUM</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">CppEnum, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">proto_unspecified_value </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"> <span class="keyword">template</span> <> \</div>
|
|
<div class="line"> struct Enum<CppEnum> { \</div>
|
|
<div class="line"> static <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> kIsImplemented = <span class="keyword">true</span>; \</div>
|
|
<div class="line"> using Proto = CppEnum##Proto; \</div>
|
|
<div class="line"> static <span class="keyword">constexpr</span> Proto kProtoUnspecifiedValue = proto_unspecified_value; \</div>
|
|
<div class="line"> static std::optional<absl::string_view> ToOptString(CppEnum <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>); \</div>
|
|
<div class="line"> static absl::Span<const CppEnum> AllValues(); \</div>
|
|
<div class="line"> }; \</div>
|
|
<div class="line"> \</div>
|
|
<div class="line"> template <> \</div>
|
|
<div class="line"> struct EnumProto<CppEnum##Proto> { \</div>
|
|
<div class="line"> using Cpp = CppEnum; \</div>
|
|
<div class="line"> static <span class="keyword">constexpr</span> CppEnum##Proto kMin = CppEnum##Proto##_MIN; \</div>
|
|
<div class="line"> static <span class="keyword">constexpr</span> CppEnum##Proto kMax = CppEnum##Proto##_MAX; \</div>
|
|
<div class="line"> static <span class="keyword">constexpr</span> <a class="code hl_typedef" href="namespaceoperations__research_1_1math__opt.html#a421f67b1b543745af048494865a94609">ProtoEnumIsValid</a> kIsValid = CppEnum##Proto##_IsValid; \</div>
|
|
<div class="line"> } <span class="comment">/* missing semicolon to force adding it at the invocation site */</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_a421f67b1b543745af048494865a94609"><div class="ttname"><a href="namespaceoperations__research_1_1math__opt.html#a421f67b1b543745af048494865a94609">operations_research::math_opt::ProtoEnumIsValid</a></div><div class="ttdeci">bool(*)(int) ProtoEnumIsValid</div><div class="ttdef"><b>Definition:</b> <a href="enums_8h_source.html#l00157">enums.h:157</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="enums_8h_source.html#l00319">319</a> of file <a class="el" href="enums_8h_source.html">enums.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_1defc00030ff81d309105e053121082f.html">math_opt</a></li><li class="navelem"><a class="el" href="dir_dd5645fbbabcdccb47d1d6db92f0f35b.html">cpp</a></li><li class="navelem"><a class="el" href="enums_8h.html">enums.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.3 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|