Google Git
Sign in
apache / impala / asf-site / . / doc / html / classimpala_1_1BitWriter.html
blob: 9145315ef50ef81163eb4efc015a0af5aa62e951 [file] [log] [blame]
<!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>
<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.6"/>
<title>Impala: impala::BitWriter Class 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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.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 style="padding-left: 0.5em;">
<div id="projectname">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('classimpala_1_1BitWriter.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classimpala_1_1BitWriter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::BitWriter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::BitWriter:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1BitWriter__coll__graph.svg" width="331" height="392"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aee06cbfece816eb4f1cbe93e11b5cdb1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#aee06cbfece816eb4f1cbe93e11b5cdb1">BitWriter</a> (uint8_t *<a class="el" href="classimpala_1_1BitWriter.html#af0b648c79e0484b4559b445eee296a32">buffer</a>, int <a class="el" href="classimpala_1_1BitWriter.html#af9bb67d6d32c22bb27d6c13229d7442c">buffer_len</a>)</td></tr>
<tr class="separator:aee06cbfece816eb4f1cbe93e11b5cdb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0138cd016024f173e1236e0c1b02f98c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#a0138cd016024f173e1236e0c1b02f98c">Clear</a> ()</td></tr>
<tr class="separator:a0138cd016024f173e1236e0c1b02f98c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a556a5c41e337ace2f621f84d6b86e285"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#a556a5c41e337ace2f621f84d6b86e285">bytes_written</a> () const </td></tr>
<tr class="separator:a556a5c41e337ace2f621f84d6b86e285"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0b648c79e0484b4559b445eee296a32"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#af0b648c79e0484b4559b445eee296a32">buffer</a> () const </td></tr>
<tr class="separator:af0b648c79e0484b4559b445eee296a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9bb67d6d32c22bb27d6c13229d7442c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#af9bb67d6d32c22bb27d6c13229d7442c">buffer_len</a> () const </td></tr>
<tr class="separator:af9bb67d6d32c22bb27d6c13229d7442c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae21363cc6a60255901c4fbfe12401a97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#ae21363cc6a60255901c4fbfe12401a97">PutValue</a> (<a class="el" href="classuint64__t.html">uint64_t</a> v, int num_bits)</td></tr>
<tr class="separator:ae21363cc6a60255901c4fbfe12401a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9306b1719419818d0b97201bb01795f4"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a9306b1719419818d0b97201bb01795f4"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#a9306b1719419818d0b97201bb01795f4">PutAligned</a> (T v, int num_bytes)</td></tr>
<tr class="separator:a9306b1719419818d0b97201bb01795f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a002cb318632b647a3ff75ebfb224e3e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#a002cb318632b647a3ff75ebfb224e3e2">PutVlqInt</a> (int32_t v)</td></tr>
<tr class="separator:a002cb318632b647a3ff75ebfb224e3e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2497dce674f6dfdc6b29049ccfb2d43"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#ac2497dce674f6dfdc6b29049ccfb2d43">GetNextBytePtr</a> (int num_bytes=1)</td></tr>
<tr class="separator:ac2497dce674f6dfdc6b29049ccfb2d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad13d095b59cc0a7a3653c01dbb2640b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#ad13d095b59cc0a7a3653c01dbb2640b6">Flush</a> (<a class="el" href="classbool.html">bool</a> align=false)</td></tr>
<tr class="separator:ad13d095b59cc0a7a3653c01dbb2640b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ad0d92e5c7e9abd191184b30dfa2cfe9e"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#ad0d92e5c7e9abd191184b30dfa2cfe9e">buffer_</a></td></tr>
<tr class="separator:ad0d92e5c7e9abd191184b30dfa2cfe9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47efe629c10dec6ed931542816da34a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#a47efe629c10dec6ed931542816da34a1">max_bytes_</a></td></tr>
<tr class="separator:a47efe629c10dec6ed931542816da34a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dbe233b8c5da9e21ca87827eea0288c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuint64__t.html">uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#a0dbe233b8c5da9e21ca87827eea0288c">buffered_values_</a></td></tr>
<tr class="separator:a0dbe233b8c5da9e21ca87827eea0288c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb7affb520f003c7fa3d1fb4f162dba2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#aeb7affb520f003c7fa3d1fb4f162dba2">byte_offset_</a></td></tr>
<tr class="separator:aeb7affb520f003c7fa3d1fb4f162dba2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93c65128df0063d4aebb0b25b1d017e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1BitWriter.html#a93c65128df0063d4aebb0b25b1d017e7">bit_offset_</a></td></tr>
<tr class="separator:a93c65128df0063d4aebb0b25b1d017e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility class to write bit/byte streams. This class can write data to either be bit packed or byte aligned (and a single stream that has a mix of both). This class does not allocate memory. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00030">30</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aee06cbfece816eb4f1cbe93e11b5cdb1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">impala::BitWriter::BitWriter </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>buffer_len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>buffer: buffer to write bits to. Buffer should be preallocated with 'buffer_len' bytes. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00034">34</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00040">Clear()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af0b648c79e0484b4559b445eee296a32"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t* impala::BitWriter::buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00049">49</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00078">buffer_</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00161">impala::RleEncoder::buffer()</a>.</p>
</div>
</div>
<a class="anchor" id="af9bb67d6d32c22bb27d6c13229d7442c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int impala::BitWriter::buffer_len </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00050">50</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00079">max_bytes_</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00397">impala::RleEncoder::CheckBufferFull()</a>.</p>
</div>
</div>
<a class="anchor" id="a556a5c41e337ace2f621f84d6b86e285"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int impala::BitWriter::bytes_written </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of current bytes written, including the current byte (i.e. may include a fraction of a byte). Includes buffered values. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00048">48</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00086">bit_offset_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00085">byte_offset_</a>, and <a class="el" href="bit-util_8h_source.html#l00032">impala::BitUtil::Ceil()</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00397">impala::RleEncoder::CheckBufferFull()</a>, <a class="el" href="rle-encoding_8h_source.html#l00370">impala::RleEncoder::Flush()</a>, <a class="el" href="rle-encoding_8h_source.html#l00162">impala::RleEncoder::len()</a>, and <a class="el" href="rle-test_8cc_source.html#l00097">impala::TestBitArrayValues()</a>.</p>
</div>
</div>
<a class="anchor" id="a0138cd016024f173e1236e0c1b02f98c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void impala::BitWriter::Clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00040">40</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00086">bit_offset_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00083">buffered_values_</a>, and <a class="el" href="bit-stream-utils_8h_source.html#l00085">byte_offset_</a>.</p>
<p>Referenced by <a class="el" href="bit-stream-utils_8h_source.html#l00034">BitWriter()</a>, and <a class="el" href="rle-encoding_8h_source.html#l00404">impala::RleEncoder::Clear()</a>.</p>
</div>
</div>
<a class="anchor" id="ad13d095b59cc0a7a3653c01dbb2640b6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void impala::BitWriter::Flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbool.html">bool</a>&#160;</td>
<td class="paramname"><em>align</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flushes all buffered values to the buffer. Call this when done writing to the buffer. If 'align' is true, buffered_values_ is reset and any future writes will be written to the next byte boundary. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00045">45</a> of file <a class="el" href="bit-stream-utils_8inline_8h_source.html">bit-stream-utils.inline.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00086">bit_offset_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00078">buffer_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00083">buffered_values_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00085">byte_offset_</a>, <a class="el" href="bit-util_8h_source.html#l00032">impala::BitUtil::Ceil()</a>, and <a class="el" href="bit-stream-utils_8h_source.html#l00079">max_bytes_</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00370">impala::RleEncoder::Flush()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00057">GetNextBytePtr()</a>, <a class="el" href="rle-test_8cc_source.html#l00033">impala::TEST()</a>, <a class="el" href="rle-test_8cc_source.html#l00097">impala::TestBitArrayValues()</a>, and <a class="el" href="rle-benchmark_8cc_source.html#l00113">TestBitWriterEncode()</a>.</p>
</div>
</div>
<a class="anchor" id="ac2497dce674f6dfdc6b29049ccfb2d43"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t * impala::BitWriter::GetNextBytePtr </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_bytes</em> = <code>1</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the next aligned byte and advance the underlying buffer by num_bytes. Returns NULL if there was not enough space. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00057">57</a> of file <a class="el" href="bit-stream-utils_8inline_8h_source.html">bit-stream-utils.inline.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00078">buffer_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00085">byte_offset_</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00045">Flush()</a>, and <a class="el" href="bit-stream-utils_8h_source.html#l00079">max_bytes_</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00295">impala::RleEncoder::FlushLiteralRun()</a>, and <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00067">PutAligned()</a>.</p>
</div>
</div>
<a class="anchor" id="a9306b1719419818d0b97201bb01795f4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbool.html">bool</a> impala::BitWriter::PutAligned </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_bytes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes v to the next aligned byte using num_bytes. If T is larger than num_bytes, the extra high-order bytes will be ignored. Returns false if there was not enough space. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00067">67</a> of file <a class="el" href="bit-stream-utils_8inline_8h_source.html">bit-stream-utils.inline.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00057">GetNextBytePtr()</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00325">impala::RleEncoder::FlushRepeatedRun()</a>.</p>
</div>
</div>
<a class="anchor" id="ae21363cc6a60255901c4fbfe12401a97"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbool.html">bool</a> impala::BitWriter::PutValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classuint64__t.html">uint64_t</a>&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_bits</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a value to buffered_values_, flushing to buffer_ if necessary. This is bit packed. Returns false if there was not enough space. num_bits must be &lt;= 32. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00023">23</a> of file <a class="el" href="bit-stream-utils_8inline_8h_source.html">bit-stream-utils.inline.h</a>.</p>
<p>References <a class="el" href="bit-stream-utils_8h_source.html#l00086">bit_offset_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00078">buffer_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00083">buffered_values_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00085">byte_offset_</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00079">max_bytes_</a>, and <a class="el" href="compiler-util_8h_source.html#l00033">UNLIKELY</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00295">impala::RleEncoder::FlushLiteralRun()</a>, <a class="el" href="rle-test_8cc_source.html#l00033">impala::TEST()</a>, <a class="el" href="rle-test_8cc_source.html#l00097">impala::TestBitArrayValues()</a>, and <a class="el" href="rle-benchmark_8cc_source.html#l00113">TestBitWriterEncode()</a>.</p>
</div>
</div>
<a class="anchor" id="a002cb318632b647a3ff75ebfb224e3e2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbool.html">bool</a> impala::BitWriter::PutVlqInt </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a Vlq encoded int to the buffer. Returns false if there was not enough room. The value is written byte aligned. For more details on vlq: en.wikipedia.org/wiki/Variable-length_quantity </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00074">74</a> of file <a class="el" href="bit-stream-utils_8inline_8h_source.html">bit-stream-utils.inline.h</a>.</p>
<p>Referenced by <a class="el" href="rle-encoding_8h_source.html#l00325">impala::RleEncoder::FlushRepeatedRun()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a93c65128df0063d4aebb0b25b1d017e7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int impala::BitWriter::bit_offset_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00086">86</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>Referenced by <a class="el" href="bit-stream-utils_8h_source.html#l00048">bytes_written()</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00040">Clear()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00045">Flush()</a>, and <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00023">PutValue()</a>.</p>
</div>
</div>
<a class="anchor" id="ad0d92e5c7e9abd191184b30dfa2cfe9e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t* impala::BitWriter::buffer_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00078">78</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>Referenced by <a class="el" href="bit-stream-utils_8h_source.html#l00049">buffer()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00045">Flush()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00057">GetNextBytePtr()</a>, and <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00023">PutValue()</a>.</p>
</div>
</div>
<a class="anchor" id="a0dbe233b8c5da9e21ca87827eea0288c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuint64__t.html">uint64_t</a> impala::BitWriter::buffered_values_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Bit-packed values are initially written to this variable before being memcpy'd to buffer_. This is faster than writing values byte by byte directly to buffer_. </p>
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00083">83</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>Referenced by <a class="el" href="bit-stream-utils_8h_source.html#l00040">Clear()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00045">Flush()</a>, and <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00023">PutValue()</a>.</p>
</div>
</div>
<a class="anchor" id="aeb7affb520f003c7fa3d1fb4f162dba2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int impala::BitWriter::byte_offset_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00085">85</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>Referenced by <a class="el" href="bit-stream-utils_8h_source.html#l00048">bytes_written()</a>, <a class="el" href="bit-stream-utils_8h_source.html#l00040">Clear()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00045">Flush()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00057">GetNextBytePtr()</a>, and <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00023">PutValue()</a>.</p>
</div>
</div>
<a class="anchor" id="a47efe629c10dec6ed931542816da34a1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int impala::BitWriter::max_bytes_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="bit-stream-utils_8h_source.html#l00079">79</a> of file <a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a>.</p>
<p>Referenced by <a class="el" href="bit-stream-utils_8h_source.html#l00050">buffer_len()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00045">Flush()</a>, <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00057">GetNextBytePtr()</a>, and <a class="el" href="bit-stream-utils_8inline_8h_source.html#l00023">PutValue()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>be/src/util/<a class="el" href="bit-stream-utils_8h_source.html">bit-stream-utils.h</a></li>
<li>be/src/util/<a class="el" href="bit-stream-utils_8inline_8h_source.html">bit-stream-utils.inline.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1BitWriter.html">BitWriter</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:50 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>