You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2017/07/31 19:30:02 UTC
[44/51] [partial] arrow-site git commit: Update C++ API docs to 0.5.0
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/b286da84/docs/cpp/bit-util_8h.html
----------------------------------------------------------------------
diff --git a/docs/cpp/bit-util_8h.html b/docs/cpp/bit-util_8h.html
index cc401c8..c4468a0 100644
--- a/docs/cpp/bit-util_8h.html
+++ b/docs/cpp/bit-util_8h.html
@@ -3,17 +3,15 @@
<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.11"/>
-<title>Apache Arrow (C++): /home/uwe/Development/arrow/cpp/src/arrow/util/bit-util.h File Reference</title>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/util/bit-util.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="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>
-<script type="text/javascript">
- $(document).ready(function() { init_search(); });
-</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -32,41 +30,19 @@
</table>
</div>
<!-- end header part -->
-<!-- Generated by Doxygen 1.8.11 -->
+<!-- Generated by Doxygen 1.8.13 -->
<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 Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li><a href="annotated.html"><span>Classes</span></a></li>
- <li class="current"><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="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>File Members</span></a></li>
- </ul>
- </div>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -88,20 +64,37 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- top -->
<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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">bit-util.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
-<div class="textblock"><code>#include <cstdint></code><br />
+<div class="textblock"><code>#include <endian.h></code><br />
+<code>#include <cstdint></code><br />
<code>#include <limits></code><br />
<code>#include <memory></code><br />
<code>#include <vector></code><br />
+<code>#include "<a class="el" href="compiler-util_8h_source.html">arrow/util/compiler-util.h</a>"</code><br />
<code>#include "<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br />
</div>
<p><a href="bit-util_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 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="structarrow_1_1make__unsigned.html">arrow::make_unsigned< T ></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="structarrow_1_1make__unsigned_3_01int8__t_01_4.html">arrow::make_unsigned< int8_t ></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="structarrow_1_1make__unsigned_3_01int16__t_01_4.html">arrow::make_unsigned< int16_t ></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="structarrow_1_1make__unsigned_3_01int32__t_01_4.html">arrow::make_unsigned< int32_t ></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="structarrow_1_1make__unsigned_3_01int64__t_01_4.html">arrow::make_unsigned< int64_t ></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 name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacearrow"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html">arrow</a></td></tr>
@@ -110,15 +103,24 @@ Namespaces</h2></td></tr>
<tr class="memitem:namespacearrow_1_1_bit_util"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1_bit_util.html">arrow::BitUtil</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 name="define-members"></a>
+Macros</h2></td></tr>
+<tr class="memitem:a582fbf29e9f0fbf6dd39031af11a8894"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bit-util_8h.html#a582fbf29e9f0fbf6dd39031af11a8894">ARROW_BYTE_SWAP64</a>   __builtin_bswap64</td></tr>
+<tr class="separator:a582fbf29e9f0fbf6dd39031af11a8894"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a4fabecc746b1f8c287ca27cebdfb3eee"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bit-util_8h.html#a4fabecc746b1f8c287ca27cebdfb3eee">ARROW_BYTE_SWAP32</a>   __builtin_bswap32</td></tr>
+<tr class="separator:a4fabecc746b1f8c287ca27cebdfb3eee"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a760bf109287895672418b5a7855d4464"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bit-util_8h.html#a760bf109287895672418b5a7855d4464">INIT_BITSET</a>(valid_bits_vector, valid_bits_index)</td></tr>
+<tr class="separator:a760bf109287895672418b5a7855d4464"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:abd53b6fe5d0ee60b928d2813f89422cf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bit-util_8h.html#abd53b6fe5d0ee60b928d2813f89422cf">READ_NEXT_BITSET</a>(valid_bits_vector)</td></tr>
+<tr class="separator:abd53b6fe5d0ee60b928d2813f89422cf"><td class="memSeparator" colspan="2"> </td></tr>
+</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a579a683813940e32133af9e6c6acb2c4"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1_bit_util.html#a579a683813940e32133af9e6c6acb2c4">arrow::BitUtil::RoundUp</a> (int64_t value, int64_t factor)</td></tr>
<tr class="memdesc:a579a683813940e32133af9e6c6acb2c4"><td class="mdescLeft"> </td><td class="mdescRight">Returns 'value' rounded up to the nearest multiple of 'factor'. <a href="namespacearrow_1_1_bit_util.html#a579a683813940e32133af9e6c6acb2c4">More...</a><br /></td></tr>
<tr class="separator:a579a683813940e32133af9e6c6acb2c4"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a2f7b5bcced6e09a6b02315208dec7c5d"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1_bit_util.html#a2f7b5bcced6e09a6b02315208dec7c5d">arrow::BitUtil::RoundUpToMultipleOf64</a> (int64_t num)</td></tr>
-<tr class="separator:a2f7b5bcced6e09a6b02315208dec7c5d"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:af9b78659f3d02ccfebdd1e592add36c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1_bit_util.html#af9b78659f3d02ccfebdd1e592add36c8">arrow::BitUtil::BytesToBits</a> (const std::vector< uint8_t > &bytes, uint8_t *bits)</td></tr>
-<tr class="separator:af9b78659f3d02ccfebdd1e592add36c8"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:aabb775a4d6129fb8e33a7b24e8b412dd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1_bit_util.html#aabb775a4d6129fb8e33a7b24e8b412dd">arrow::BitUtil::FillBitsFromBytes</a> (const std::vector< uint8_t > &bytes, uint8_t *bits)</td></tr>
+<tr class="separator:aabb775a4d6129fb8e33a7b24e8b412dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb2da8e090e9456b4e8ca6b05d6448f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="visibility_8h.html#a7060b7b5f11fc11ce77a4d30b37619ef">ARROW_EXPORT</a> Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1_bit_util.html#adb2da8e090e9456b4e8ca6b05d6448f5">arrow::BitUtil::BytesToBits</a> (const std::vector< uint8_t > &, std::shared_ptr< Buffer > *)</td></tr>
<tr class="separator:adb2da8e090e9456b4e8ca6b05d6448f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad55168cd9074fddb1ce5f103d29c26f"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#aad55168cd9074fddb1ce5f103d29c26f">arrow::GetEmptyBitmap</a> (MemoryPool *pool, int64_t length, std::shared_ptr< MutableBuffer > *result)</td></tr>
@@ -132,12 +134,87 @@ Functions</h2></td></tr>
<tr class="memitem:a6009c894cf619352dfc7bb26b7ac15b9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a6009c894cf619352dfc7bb26b7ac15b9">arrow::BitmapEquals</a> (const uint8_t *left, int64_t left_offset, const uint8_t *right, int64_t right_offset, int64_t bit_length)</td></tr>
<tr class="separator:a6009c894cf619352dfc7bb26b7ac15b9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
+<h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a4fabecc746b1f8c287ca27cebdfb3eee"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4fabecc746b1f8c287ca27cebdfb3eee">◆ </a></span>ARROW_BYTE_SWAP32</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define ARROW_BYTE_SWAP32   __builtin_bswap32</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="a582fbf29e9f0fbf6dd39031af11a8894"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a582fbf29e9f0fbf6dd39031af11a8894">◆ </a></span>ARROW_BYTE_SWAP64</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define ARROW_BYTE_SWAP64   __builtin_bswap64</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="a760bf109287895672418b5a7855d4464"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a760bf109287895672418b5a7855d4464">◆ </a></span>INIT_BITSET</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define INIT_BITSET</td>
+ <td>(</td>
+ <td class="paramtype"> </td>
+ <td class="paramname">valid_bits_vector, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"> </td>
+ <td class="paramname">valid_bits_index </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="keywordtype">int</span> byte_offset_##valid_bits_vector = (valid_bits_index) / 8; \</div><div class="line"> int bit_offset_##valid_bits_vector = (valid_bits_index) % 8; \</div><div class="line"> uint8_t bitset_##valid_bits_vector = valid_bits_vector[byte_offset_##valid_bits_vector];</div></div><!-- fragment -->
+</div>
+</div>
+<a id="abd53b6fe5d0ee60b928d2813f89422cf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#abd53b6fe5d0ee60b928d2813f89422cf">◆ </a></span>READ_NEXT_BITSET</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define READ_NEXT_BITSET</td>
+ <td>(</td>
+ <td class="paramtype"> </td>
+ <td class="paramname">valid_bits_vector</td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<b>Value:</b><div class="fragment"><div class="line">bit_offset_##valid_bits_vector++; \</div><div class="line"> if (bit_offset_##valid_bits_vector == 8) { \</div><div class="line"> bit_offset_##valid_bits_vector = 0; \</div><div class="line"> byte_offset_##valid_bits_vector++; \</div><div class="line"> bitset_##valid_bits_vector = valid_bits_vector[byte_offset_##valid_bits_vector]; \</div><div class="line"> }</div></div><!-- fragment -->
+</div>
+</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.11
+</a> 1.8.13
</small></address>
</body>
</html>