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/04/24 03:03:50 UTC

[44/51] [partial] arrow-site git commit: Add current C++ doxygen API docs

http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/builder_8h.html
----------------------------------------------------------------------
diff --git a/docs/cpp/builder_8h.html b/docs/cpp/builder_8h.html
new file mode 100644
index 0000000..6a2e9b8
--- /dev/null
+++ b/docs/cpp/builder_8h.html
@@ -0,0 +1,198 @@
+<!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>Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/builder.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/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">Apache Arrow (C++)
+   </div>
+   <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</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><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&#160;List</span></a></li>
+      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
+    </ul>
+  </div>
+<!-- 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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</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 id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Classes</a> &#124;
+<a href="#namespaces">Namespaces</a> &#124;
+<a href="#typedef-members">Typedefs</a> &#124;
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">builder.h File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &lt;cstdint&gt;</code><br/>
+<code>#include &lt;functional&gt;</code><br/>
+<code>#include &lt;memory&gt;</code><br/>
+<code>#include &lt;string&gt;</code><br/>
+<code>#include &lt;vector&gt;</code><br/>
+<code>#include &quot;<a class="el" href="buffer_8h_source.html">arrow/buffer.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="memory__pool_8h_source.html">arrow/memory_pool.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="status_8h_source.html">arrow/status.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="type_8h_source.html">arrow/type.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="type__traits_8h_source.html">arrow/type_traits.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="bit-util_8h_source.html">arrow/util/bit-util.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="macros_8h_source.html">arrow/util/macros.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>&quot;</code><br/>
+</div>
+<p><a href="builder_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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1decimal_1_1_decimal.html">arrow::decimal::Decimal&lt; T &gt;</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_array_builder.html">arrow::ArrayBuilder</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for all data array builders.  <a href="classarrow_1_1_array_builder.html#details">More...</a><br/></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_primitive_builder.html">arrow::PrimitiveBuilder&lt; Type &gt;</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_numeric_builder.html">arrow::NumericBuilder&lt; T &gt;</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for all Builders that emit an <a class="el" href="classarrow_1_1_array.html" title="Immutable data array with some logical type and some length. ">Array</a> of a scalar numerical type.  <a href="classarrow_1_1_numeric_builder.html#details">More...</a><br/></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_boolean_builder.html">arrow::BooleanBuilder</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_list_builder.html">arrow::ListBuilder</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builder class for variable-length list array value types.  <a href="classarrow_1_1_list_builder.html#details">More...</a><br/></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_binary_builder.html">arrow::BinaryBuilder</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_string_builder.html">arrow::StringBuilder</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_fixed_size_binary_builder.html">arrow::FixedSizeBinaryBuilder</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_decimal_builder.html">arrow::DecimalBuilder</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_struct_builder.html">arrow::StructBuilder</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append, Resize and Reserve methods are acting on <a class="el" href="classarrow_1_1_struct_builder.html" title="Append, Resize and Reserve methods are acting on StructBuilder. ">StructBuilder</a>.  <a href="classarrow_1_1_struct_builder.html#details">More...</a><br/></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html">arrow</a></td></tr>
+<tr class="memdesc:namespacearrow"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public API for the "Feather" file format, originally created at <a href="http://github.com/wesm/feather">http://github.com/wesm/feather</a>. <br/></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:namespacearrow_1_1decimal"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1decimal.html">arrow::decimal</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
+Typedefs</h2></td></tr>
+<tr class="memitem:adab028f188008a82d790cd69ac351a3b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#adab028f188008a82d790cd69ac351a3b">arrow::UInt8Builder</a> = NumericBuilder&lt; UInt8Type &gt;</td></tr>
+<tr class="separator:adab028f188008a82d790cd69ac351a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6f7720234c751cfa79a0d6d4e2014485"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a6f7720234c751cfa79a0d6d4e2014485">arrow::UInt16Builder</a> = NumericBuilder&lt; UInt16Type &gt;</td></tr>
+<tr class="separator:a6f7720234c751cfa79a0d6d4e2014485"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a54e6101656a21b97a88179c8d1c453b9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a54e6101656a21b97a88179c8d1c453b9">arrow::UInt32Builder</a> = NumericBuilder&lt; UInt32Type &gt;</td></tr>
+<tr class="separator:a54e6101656a21b97a88179c8d1c453b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1777cb0f7c98036ad6f078fa0f1a6829"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a1777cb0f7c98036ad6f078fa0f1a6829">arrow::UInt64Builder</a> = NumericBuilder&lt; UInt64Type &gt;</td></tr>
+<tr class="separator:a1777cb0f7c98036ad6f078fa0f1a6829"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9675d2aecdd6ad622ee1358c358ba278"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a9675d2aecdd6ad622ee1358c358ba278">arrow::Int8Builder</a> = NumericBuilder&lt; Int8Type &gt;</td></tr>
+<tr class="separator:a9675d2aecdd6ad622ee1358c358ba278"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab5ad5330bb34a045c6e87ecee875057e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#ab5ad5330bb34a045c6e87ecee875057e">arrow::Int16Builder</a> = NumericBuilder&lt; Int16Type &gt;</td></tr>
+<tr class="separator:ab5ad5330bb34a045c6e87ecee875057e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a031c893d8d592c7a099bb9bea3a25f86"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a031c893d8d592c7a099bb9bea3a25f86">arrow::Int32Builder</a> = NumericBuilder&lt; Int32Type &gt;</td></tr>
+<tr class="separator:a031c893d8d592c7a099bb9bea3a25f86"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a08fa80026c56e0f1ff24b43c4dc33e61"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a08fa80026c56e0f1ff24b43c4dc33e61">arrow::Int64Builder</a> = NumericBuilder&lt; Int64Type &gt;</td></tr>
+<tr class="separator:a08fa80026c56e0f1ff24b43c4dc33e61"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a06c8b697ab3c8b10f4653b088351c4a0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a06c8b697ab3c8b10f4653b088351c4a0">arrow::TimestampBuilder</a> = NumericBuilder&lt; TimestampType &gt;</td></tr>
+<tr class="separator:a06c8b697ab3c8b10f4653b088351c4a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad48a5da822678dcfb566dd1df839f4c2"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#ad48a5da822678dcfb566dd1df839f4c2">arrow::Time32Builder</a> = NumericBuilder&lt; Time32Type &gt;</td></tr>
+<tr class="separator:ad48a5da822678dcfb566dd1df839f4c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac10bcef81b16eedc8fe72f9471833d79"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#ac10bcef81b16eedc8fe72f9471833d79">arrow::Time64Builder</a> = NumericBuilder&lt; Time64Type &gt;</td></tr>
+<tr class="separator:ac10bcef81b16eedc8fe72f9471833d79"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:adcb521d3f703682dd58904c6b3a0d184"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#adcb521d3f703682dd58904c6b3a0d184">arrow::Date32Builder</a> = NumericBuilder&lt; Date32Type &gt;</td></tr>
+<tr class="separator:adcb521d3f703682dd58904c6b3a0d184"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0f6f5ba414e7dce870af9fc1fa6f96aa"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#a0f6f5ba414e7dce870af9fc1fa6f96aa">arrow::Date64Builder</a> = NumericBuilder&lt; Date64Type &gt;</td></tr>
+<tr class="separator:a0f6f5ba414e7dce870af9fc1fa6f96aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae87957f6c01fb918bb573f04c5188ca4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#ae87957f6c01fb918bb573f04c5188ca4">arrow::HalfFloatBuilder</a> = NumericBuilder&lt; HalfFloatType &gt;</td></tr>
+<tr class="separator:ae87957f6c01fb918bb573f04c5188ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afc7f8a9698e4a5b6e8c3884c2cf3aedb"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#afc7f8a9698e4a5b6e8c3884c2cf3aedb">arrow::FloatBuilder</a> = NumericBuilder&lt; FloatType &gt;</td></tr>
+<tr class="separator:afc7f8a9698e4a5b6e8c3884c2cf3aedb"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab98cad76b29efffe92c6c88af8947873"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#ab98cad76b29efffe92c6c88af8947873">arrow::DoubleBuilder</a> = NumericBuilder&lt; DoubleType &gt;</td></tr>
+<tr class="separator:ab98cad76b29efffe92c6c88af8947873"><td class="memSeparator" colspan="2">&#160;</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:affc0190b62200efbb45ec033438194d1"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html#affc0190b62200efbb45ec033438194d1">arrow::MakeBuilder</a> (MemoryPool *pool, const std::shared_ptr&lt; DataType &gt; &amp;type, std::shared_ptr&lt; ArrayBuilder &gt; *out)</td></tr>
+<tr class="separator:affc0190b62200efbb45ec033438194d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.6
+</small></address>
+</body>
+</html>