188 lines
21 KiB
HTML
188 lines
21 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: recordio.cc 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('recordio_8cc_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">recordio.cc</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="recordio_8cc.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">#include "<a class="code" href="recordio_8h.html">ortools/base/recordio.h</a>"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <zlib.h></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <string></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="preprocessor">#include "<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespacerecordio.html"> 23</a></span> <span class="keyword">namespace </span><a class="code" href="namespacerecordio.html">recordio</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classrecordio_1_1_record_writer.html#a02e12506b860e66bf8706eb414fa165e">RecordWriter::kMagicNumber</a> = 0x3ed7230a;</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classrecordio_1_1_record_writer.html#a3bb1bd5f31cd743b4992e21ec837c3d5"> 26</a></span> <a class="code" href="classrecordio_1_1_record_writer.html#a3bb1bd5f31cd743b4992e21ec837c3d5">RecordWriter::RecordWriter</a>(<a class="code" href="class_file.html">File</a>* <span class="keyword">const</span> <a class="code" href="namespacefile.html">file</a>)</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  : file_(<a class="code" href="namespacefile.html">file</a>), use_compression_(true) {}</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classrecordio_1_1_record_writer.html#aef7e3d18ef267f23f64ad397fa359cc1"> 29</a></span> <span class="keywordtype">bool</span> <a class="code" href="classrecordio_1_1_record_writer.html#aef7e3d18ef267f23f64ad397fa359cc1">RecordWriter::Close</a>() { <span class="keywordflow">return</span> file_-><a class="code" href="class_file.html#aef7e3d18ef267f23f64ad397fa359cc1">Close</a>(); }</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classrecordio_1_1_record_writer.html#ac9dbc3fc3f2746caeebf5d372bfc8ebc"> 31</a></span> <span class="keywordtype">void</span> <a class="code" href="classrecordio_1_1_record_writer.html#ac9dbc3fc3f2746caeebf5d372bfc8ebc">RecordWriter::set_use_compression</a>(<span class="keywordtype">bool</span> use_compression) {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  use_compression_ = use_compression;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> }</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> std::string RecordWriter::Compress(std::string <span class="keyword">const</span>& s)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> source_size = s.size(); <span class="comment">// NOLINT</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* source = s.c_str();</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> dsize = source_size + (source_size * 0.1f) + 16; <span class="comment">// NOLINT</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  std::unique_ptr<char[]> destination(<span class="keyword">new</span> <span class="keywordtype">char</span>[dsize]);</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Use compress() from zlib.h.</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> result =</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  compress(<span class="keyword">reinterpret_cast<</span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>*<span class="keyword">></span>(destination.get()), &dsize,</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>*<span class="keyword">></span>(source), source_size);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (result != Z_OK) {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  LOG(FATAL) << <span class="stringliteral">"Compress error occurred! Error code: "</span> << result;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> std::string(destination.get(), dsize);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> }</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classrecordio_1_1_record_reader.html#a2e00cf22bc775cb3941575287e3d28d6"> 52</a></span> <a class="code" href="classrecordio_1_1_record_reader.html#a2e00cf22bc775cb3941575287e3d28d6">RecordReader::RecordReader</a>(<a class="code" href="class_file.html">File</a>* <span class="keyword">const</span> <a class="code" href="namespacefile.html">file</a>) : file_(<a class="code" href="namespacefile.html">file</a>) {}</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classrecordio_1_1_record_reader.html#aef7e3d18ef267f23f64ad397fa359cc1"> 54</a></span> <span class="keywordtype">bool</span> <a class="code" href="classrecordio_1_1_record_reader.html#aef7e3d18ef267f23f64ad397fa359cc1">RecordReader::Close</a>() { <span class="keywordflow">return</span> file_-><a class="code" href="class_file.html#aef7e3d18ef267f23f64ad397fa359cc1">Close</a>(); }</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">void</span> RecordReader::Uncompress(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> source, <a class="code" href="integral__types_8h.html#abc0f5bc07737e498f287334775dff2b6">uint64</a> source_size,</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">char</span>* <span class="keyword">const</span> output_buffer,</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="integral__types_8h.html#abc0f5bc07737e498f287334775dff2b6">uint64</a> output_size)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> result_size = output_size; <span class="comment">// NOLINT</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// Use uncompress() from zlib.h</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> result =</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  uncompress(<span class="keyword">reinterpret_cast<</span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>*<span class="keyword">></span>(output_buffer), &result_size,</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>*<span class="keyword">></span>(source), source_size);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">if</span> (result != Z_OK) {</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  LOG(FATAL) << <span class="stringliteral">"Uncompress error occurred! Error code: "</span> << result;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  CHECK_LE(result_size, <span class="keyword">static_cast<</span><span class="keywordtype">unsigned</span> <span class="keywordtype">long</span><span class="keyword">></span>(output_size)); <span class="comment">// NOLINT</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">// namespace recordio</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="anamespacerecordio_html"><div class="ttname"><a href="namespacerecordio.html">recordio</a></div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00023">recordio.cc:23</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_writer_html_a02e12506b860e66bf8706eb414fa165e"><div class="ttname"><a href="classrecordio_1_1_record_writer.html#a02e12506b860e66bf8706eb414fa165e">recordio::RecordWriter::kMagicNumber</a></div><div class="ttdeci">static const int kMagicNumber</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8h_source.html#l00036">recordio.h:36</a></div></div>
|
|
<div class="ttc" id="aclass_file_html_aef7e3d18ef267f23f64ad397fa359cc1"><div class="ttname"><a href="class_file.html#aef7e3d18ef267f23f64ad397fa359cc1">File::Close</a></div><div class="ttdeci">bool Close()</div><div class="ttdef"><b>Definition:</b> <a href="file_8cc_source.html#l00048">file.cc:48</a></div></div>
|
|
<div class="ttc" id="arecordio_8h_html"><div class="ttname"><a href="recordio_8h.html">recordio.h</a></div></div>
|
|
<div class="ttc" id="abase_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_writer_html_a3bb1bd5f31cd743b4992e21ec837c3d5"><div class="ttname"><a href="classrecordio_1_1_record_writer.html#a3bb1bd5f31cd743b4992e21ec837c3d5">recordio::RecordWriter::RecordWriter</a></div><div class="ttdeci">RecordWriter(File *const file)</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00026">recordio.cc:26</a></div></div>
|
|
<div class="ttc" id="aclass_file_html"><div class="ttname"><a href="class_file.html">File</a></div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8h_source.html#l00032">base/file.h:32</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_reader_html_aef7e3d18ef267f23f64ad397fa359cc1"><div class="ttname"><a href="classrecordio_1_1_record_reader.html#aef7e3d18ef267f23f64ad397fa359cc1">recordio::RecordReader::Close</a></div><div class="ttdeci">bool Close()</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00054">recordio.cc:54</a></div></div>
|
|
<div class="ttc" id="aintegral__types_8h_html_abc0f5bc07737e498f287334775dff2b6"><div class="ttname"><a href="integral__types_8h.html#abc0f5bc07737e498f287334775dff2b6">uint64</a></div><div class="ttdeci">uint64_t uint64</div><div class="ttdef"><b>Definition:</b> <a href="integral__types_8h_source.html#l00039">integral_types.h:39</a></div></div>
|
|
<div class="ttc" id="anamespacefile_html"><div class="ttname"><a href="namespacefile.html">file</a></div><div class="ttdef"><b>Definition:</b> <a href="file_8cc_source.html#l00141">file.cc:141</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_reader_html_a2e00cf22bc775cb3941575287e3d28d6"><div class="ttname"><a href="classrecordio_1_1_record_reader.html#a2e00cf22bc775cb3941575287e3d28d6">recordio::RecordReader::RecordReader</a></div><div class="ttdeci">RecordReader(File *const file)</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00052">recordio.cc:52</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_writer_html_aef7e3d18ef267f23f64ad397fa359cc1"><div class="ttname"><a href="classrecordio_1_1_record_writer.html#aef7e3d18ef267f23f64ad397fa359cc1">recordio::RecordWriter::Close</a></div><div class="ttdeci">bool Close()</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00029">recordio.cc:29</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_writer_html_ac9dbc3fc3f2746caeebf5d372bfc8ebc"><div class="ttname"><a href="classrecordio_1_1_record_writer.html#ac9dbc3fc3f2746caeebf5d372bfc8ebc">recordio::RecordWriter::set_use_compression</a></div><div class="ttdeci">void set_use_compression(bool use_compression)</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00031">recordio.cc:31</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_8f9dc966244f4c6e9b2fa0dee1e4ef1a.html">base</a></li><li class="navelem"><a class="el" href="recordio_8cc.html">recordio.cc</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>
|