187 lines
19 KiB
HTML
187 lines
19 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.8.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: lazy_mutable_copy.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
|
|
 <span id="projectnumber">8.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<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');
|
|
/* @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('lazy__mutable__copy_8h_source.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">lazy_mutable_copy.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="lazy__mutable__copy_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2010-2018 Google LLC</span></div>
|
|
<div class="line"><a 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 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 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 name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 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 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 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 name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef OR_TOOLS_UTIL_LAZY_MUTABLE_COPY_H_</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define OR_TOOLS_UTIL_LAZY_MUTABLE_COPY_H_</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "absl/memory/memory.h"</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// LazyMutableCopy<T> is a helper class for making an on-demand copy of an</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// object of arbitrary type T. Type T must have a copy constructor.</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Sample usage:</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// const Proto& original_input = ...;</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// LazyMutableCopy<Proto> input(original_input);</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// if (input.get().foo() == BAD_VALUE) {</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// input.get_mutable()->set_foo(GOOD_VALUE); // Copies the object.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// }</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// // Process "input" here without worrying about BAD_VALUE.</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// A good pattern is to have function taking LazyMutableCopy<> as argument:</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// void ProcessProto(LazyMutableCopy<Proto> input) { // pass by copy</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// ...</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// }</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// At the call site: ProcessProto({const_ref_to_my_proto});</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// In basic usage, a LazyMutableCopy is in one of two states:</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// - original: points to the const original. No memory allocated.</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// - copy: points to a mutable copy of the original and owns it. Owning the</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// copy means that the destructor will delete it, like std::unique_ptr<>.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// This is what you get by calling get_mutable().</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_lazy_mutable_copy.html"> 45</a></span> <span class="keyword">class </span><a class="code" href="classoperations__research_1_1_lazy_mutable_copy.html">LazyMutableCopy</a> {</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// You always construct a LazyMutableCopy with a const reference to an object,</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// which must outlive this class (unless get_mutable() was called).</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_lazy_mutable_copy.html#a5636913e03f5b56c1fb099c76f183e0b"> 49</a></span>  <a class="code" href="classoperations__research_1_1_lazy_mutable_copy.html#a5636913e03f5b56c1fb099c76f183e0b">LazyMutableCopy</a>(<span class="keyword">const</span> T& obj) <span class="comment">// NOLINT(google-explicit-constructor)</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  : original_(&obj) {}</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// You can move a LazyMutableCopy, much like a std::unique_ptr<> or a const*.</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// We simply rely on the default move constructors being available.</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_lazy_mutable_copy.html#a1bfb20d09743b0dad247746b528b5650"> 55</a></span>  <span class="keyword">const</span> T& <a class="code" href="classoperations__research_1_1_lazy_mutable_copy.html#a1bfb20d09743b0dad247746b528b5650">get</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> copy_ != <span class="keyword">nullptr</span> ? *copy_ : *original_; }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_lazy_mutable_copy.html#aa2de4f4134b2decff4e5790e7a7d00e2"> 56</a></span>  T* <a class="code" href="classoperations__research_1_1_lazy_mutable_copy.html#aa2de4f4134b2decff4e5790e7a7d00e2">get_mutable</a>() {</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">if</span> (copy_ == <span class="keyword">nullptr</span>) {</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  copy_ = absl::make_unique<T>(*original_);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  original_ = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> copy_.get();</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// True iff get_mutable() was called at least once (in which case the object</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// was copied).</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_lazy_mutable_copy.html#a0a26562f081626d20c79a563c18988b8"> 66</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classoperations__research_1_1_lazy_mutable_copy.html#a0a26562f081626d20c79a563c18988b8">was_copied</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> copy_ != <span class="keyword">nullptr</span>; }</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">const</span> T* original_;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  std::unique_ptr<T> copy_;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> };</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif // OR_TOOLS_UTIL_LAZY_MUTABLE_COPY_H_</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclassoperations__research_1_1_lazy_mutable_copy_html_a0a26562f081626d20c79a563c18988b8"><div class="ttname"><a href="classoperations__research_1_1_lazy_mutable_copy.html#a0a26562f081626d20c79a563c18988b8">operations_research::LazyMutableCopy::was_copied</a></div><div class="ttdeci">bool was_copied() const</div><div class="ttdef"><b>Definition:</b> <a href="lazy__mutable__copy_8h_source.html#l00066">lazy_mutable_copy.h:66</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">The vehicle routing library lets one model and solve generic vehicle routing problems ranging from th...</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="aclassoperations__research_1_1_lazy_mutable_copy_html_aa2de4f4134b2decff4e5790e7a7d00e2"><div class="ttname"><a href="classoperations__research_1_1_lazy_mutable_copy.html#aa2de4f4134b2decff4e5790e7a7d00e2">operations_research::LazyMutableCopy::get_mutable</a></div><div class="ttdeci">T * get_mutable()</div><div class="ttdef"><b>Definition:</b> <a href="lazy__mutable__copy_8h_source.html#l00056">lazy_mutable_copy.h:56</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_lazy_mutable_copy_html_a1bfb20d09743b0dad247746b528b5650"><div class="ttname"><a href="classoperations__research_1_1_lazy_mutable_copy.html#a1bfb20d09743b0dad247746b528b5650">operations_research::LazyMutableCopy::get</a></div><div class="ttdeci">const T & get() const</div><div class="ttdef"><b>Definition:</b> <a href="lazy__mutable__copy_8h_source.html#l00055">lazy_mutable_copy.h:55</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_lazy_mutable_copy_html"><div class="ttname"><a href="classoperations__research_1_1_lazy_mutable_copy.html">operations_research::LazyMutableCopy</a></div><div class="ttdef"><b>Definition:</b> <a href="lazy__mutable__copy_8h_source.html#l00045">lazy_mutable_copy.h:45</a></div></div>
|
|
<div class="ttc" id="aclassoperations__research_1_1_lazy_mutable_copy_html_a5636913e03f5b56c1fb099c76f183e0b"><div class="ttname"><a href="classoperations__research_1_1_lazy_mutable_copy.html#a5636913e03f5b56c1fb099c76f183e0b">operations_research::LazyMutableCopy::LazyMutableCopy</a></div><div class="ttdeci">LazyMutableCopy(const T &obj)</div><div class="ttdef"><b>Definition:</b> <a href="lazy__mutable__copy_8h_source.html#l00049">lazy_mutable_copy.h:49</a></div></div>
|
|
<!-- 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="lazy__mutable__copy_8h.html">lazy_mutable_copy.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.8.20 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|