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 2018/01/17 04:45:11 UTC
[30/51] [partial] arrow-site git commit: Add updated API docs for
0.8.0
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/cpp/arrow__to__python_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/arrow__to__python_8h_source.html b/docs/cpp/arrow__to__python_8h_source.html
index 9f8d92b..810c2e9 100644
--- a/docs/cpp/arrow__to__python_8h_source.html
+++ b/docs/cpp/arrow__to__python_8h_source.html
@@ -3,7 +3,7 @@
<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.13"/>
+<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/arrow_to_python.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -30,18 +30,21 @@
</table>
</div>
<!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
+<!-- Generated by Doxygen 1.8.14 -->
<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(); });
});
-</script>
+/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -67,19 +70,20 @@ $(function() {
<div class="title">arrow_to_python.h</div> </div>
</div><!--header-->
<div class="contents">
-<a href="arrow__to__python_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">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><
span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software dis
tributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</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">#ifndef ARROW_PYTHON_ARROW_TO_PYTHON_H</span></div><div class="line"><a name="l00019"></a>
<span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_PYTHON_ARROW_TO_PYTHON_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="preprocessor">#include "<a class="code" href="platform_8h.html">arrow/python/platform.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"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </di
v><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="python__to__arrow_8h.html">arrow/python/python_to_arrow.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name
="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>RecordBatch;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>RandomAccessFile;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042">
</a><span class="lineno"> 42</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> ARROW_EXPORT</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> Status <a class="code" href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">ReadSerializedObject</a>(io::RandomAccessFile* src, SerializedPyObject* out);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> ARROW_EXPORT</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> Status <a class="code" href="namespacearrow_1_1py.html#a9ba31943394b96b470e7ae0536fa50d1">DeserializeObject</a>(PyObject* context, <span class="keyword">const</span> SerializedPyObject& <span class="keywordtype">
object</span>,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  PyObject* base, PyObject** out);</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> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#endif // ARROW_PYTHON_ARROW_TO_PYTHON_H</span></div><div class="ttc" id="namespacearrow_1_1py_html_a825cf78161c4a5a166aaa5345a2e869c"><div class="ttname"><a href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">arrow::py::ReadSerializedObject</a></div><div class="ttdeci">Status Read
SerializedObject(io::RandomAccessFile *src, SerializedPyObject *out)</div><div class="ttdoc">Read serialized Python sequence from file interface using Arrow IPC. </div></div>
+<a href="arrow__to__python_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">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><
span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software dis
tributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</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">#ifndef ARROW_PYTHON_ARROW_TO_PYTHON_H</span></div><div class="line"><a name="l00019"></a>
<span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_PYTHON_ARROW_TO_PYTHON_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="preprocessor">#include "<a class="code" href="platform_8h.html">arrow/python/platform.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"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </di
v><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="python__to__arrow_8h.html">arrow/python/python_to_arrow.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name
="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>RecordBatch;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>RandomAccessFile;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042">
</a><span class="lineno"> 42</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> ARROW_EXPORT</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> Status <a class="code" href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">ReadSerializedObject</a>(io::RandomAccessFile* src, SerializedPyObject* out);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> ARROW_EXPORT</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> Status <a class="code" href="namespacearrow_1_1py.html#aadc6fffa6dfa1fe0574967956a62a519">GetSerializedFromComponents</a>(<span class="keywordtype">int</span> num_tensors, <span class="keywordtype">int</span> num_buf
fers, PyObject* data,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  SerializedPyObject* out);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> ARROW_EXPORT</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> Status <a class="code" href="namespacearrow_1_1py.html#a9ba31943394b96b470e7ae0536fa50d1">DeserializeObject</a>(PyObject* context, <span class="keyword">const</span> SerializedPyObject& <span class="keywordtype">object</span>,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  PyObject* base, PyObject** out);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> } <span class="comment">// n
amespace py</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif // ARROW_PYTHON_ARROW_TO_PYTHON_H</span></div><div class="ttc" id="namespacearrow_1_1py_html_a825cf78161c4a5a166aaa5345a2e869c"><div class="ttname"><a href="namespacearrow_1_1py.html#a825cf78161c4a5a166aaa5345a2e869c">arrow::py::ReadSerializedObject</a></div><div class="ttdeci">Status ReadSerializedObject(io::RandomAccessFile *src, SerializedPyObject *out)</div><div class="ttdoc">Read serialized Python sequence from file interface using Arrow IPC. </div></div>
<div class="ttc" id="platform_8h_html"><div class="ttname"><a href="platform_8h.html">platform.h</a></div></div>
<div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div>
<div class="ttc" id="python__to__arrow_8h_html"><div class="ttname"><a href="python__to__arrow_8h.html">python_to_arrow.h</a></div></div>
-<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> allocator.h:29</div></div>
+<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div>
<div class="ttc" id="status_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div>
<div class="ttc" id="namespacearrow_1_1py_html_a9ba31943394b96b470e7ae0536fa50d1"><div class="ttname"><a href="namespacearrow_1_1py.html#a9ba31943394b96b470e7ae0536fa50d1">arrow::py::DeserializeObject</a></div><div class="ttdeci">Status DeserializeObject(PyObject *context, const SerializedPyObject &object, PyObject *base, PyObject **out)</div><div class="ttdoc">Reconstruct Python object from Arrow-serialized representation. </div></div>
+<div class="ttc" id="namespacearrow_1_1py_html_aadc6fffa6dfa1fe0574967956a62a519"><div class="ttname"><a href="namespacearrow_1_1py.html#aadc6fffa6dfa1fe0574967956a62a519">arrow::py::GetSerializedFromComponents</a></div><div class="ttdeci">Status GetSerializedFromComponents(int num_tensors, int num_buffers, PyObject *data, SerializedPyObject *out)</div><div class="ttdoc">Reconstruct SerializedPyObject from representation produced by SerializedPyObject::GetComponents. </div></div>
</div><!-- fragment --></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.13
+</a> 1.8.14
</small></address>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/cpp/bit-stream-utils_8h.html
----------------------------------------------------------------------
diff --git a/docs/cpp/bit-stream-utils_8h.html b/docs/cpp/bit-stream-utils_8h.html
index 8f8e9c0..c912c4b 100644
--- a/docs/cpp/bit-stream-utils_8h.html
+++ b/docs/cpp/bit-stream-utils_8h.html
@@ -3,7 +3,7 @@
<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.13"/>
+<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/util/bit-stream-utils.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -30,18 +30,21 @@
</table>
</div>
<!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
+<!-- Generated by Doxygen 1.8.14 -->
<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(); });
});
-</script>
+/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -100,7 +103,7 @@ Namespaces</h2></td></tr>
<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.13
+</a> 1.8.14
</small></address>
</body>
</html>