arrow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From w...@apache.org
Subject [08/51] [partial] arrow-site git commit: Update C++ and Python API documentation for 0.7.0
Date Mon, 18 Sep 2017 20:42:07 GMT
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1py_1_1_scoped_ref-members.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1py_1_1_scoped_ref-members.html b/docs/cpp/classarrow_1_1py_1_1_scoped_ref-members.html
new file mode 100644
index 0000000..0df045b
--- /dev/null
+++ b/docs/cpp/classarrow_1_1py_1_1_scoped_ref-members.html
@@ -0,0 +1,88 @@
+<!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.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Apache Arrow (C++): Member List</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>
+<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 id="projectalign" 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.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<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()"
+     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 id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li
class="navelem"><a class="el" href="namespacearrow_1_1py.html">py</a></li><li
class="navelem"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">ScopedRef</a></li>
 </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="headertitle">
+<div class="title">arrow::py::ScopedRef Member List</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a>,
including all inherited members.</p>
+<table class="directory">
+  <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a9fc1bbe1e110d349bc40d489c5e7e191">get</a>()
const</td><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a></td><td
class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a433336b353a3129bdd89b248db63fec3">ref</a>()</td><td
class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a></td><td
class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a5a20812323d56a3b9859fa2f0d018005">release</a>()</td><td
class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a></td><td
class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a1cadd64358ad29278b4d6f9ee1344078">reset</a>(PyObject
*obj)</td><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a></td><td
class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html#aff57aeaa246dbde9c1fade965f08e36f">ScopedRef</a>()</td><td
class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a></td><td
class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a10b5972ad27bf47fc2b5414d27310b69">ScopedRef</a>(PyObject
*obj)</td><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a></td><td
class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html#aea96d358836d5e3b56a9695bde378b2a">~ScopedRef</a>()</td><td
class="entry"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">arrow::py::ScopedRef</a></td><td
class="entry"><span class="mlabel">inline</span></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.13
+</small></address>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a4dfae21/docs/cpp/classarrow_1_1py_1_1_scoped_ref.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1py_1_1_scoped_ref.html b/docs/cpp/classarrow_1_1py_1_1_scoped_ref.html
new file mode 100644
index 0000000..aa612c1
--- /dev/null
+++ b/docs/cpp/classarrow_1_1py_1_1_scoped_ref.html
@@ -0,0 +1,283 @@
+<!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.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Apache Arrow (C++): arrow::py::ScopedRef 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="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" />
+</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="projectalign" 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.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<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()"
+     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 id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li
class="navelem"><a class="el" href="namespacearrow_1_1py.html">py</a></li><li
class="navelem"><a class="el" href="classarrow_1_1py_1_1_scoped_ref.html">ScopedRef</a></li>
 </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="classarrow_1_1py_1_1_scoped_ref-members.html">List of all members</a>
 </div>
+  <div class="headertitle">
+<div class="title">arrow::py::ScopedRef Class Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="arrow_2python_2common_8h_source.html">common.h</a>&gt;</code></p>
+<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:aff57aeaa246dbde9c1fade965f08e36f"><td class="memItemLeft" align="right"
valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a
class="el" href="classarrow_1_1py_1_1_scoped_ref.html#aff57aeaa246dbde9c1fade965f08e36f">ScopedRef</a>
()</td></tr>
+<tr class="separator:aff57aeaa246dbde9c1fade965f08e36f"><td class="memSeparator"
colspan="2">&#160;</td></tr>
+<tr class="memitem:a10b5972ad27bf47fc2b5414d27310b69"><td class="memItemLeft" align="right"
valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a
class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a10b5972ad27bf47fc2b5414d27310b69">ScopedRef</a>
(PyObject *obj)</td></tr>
+<tr class="separator:a10b5972ad27bf47fc2b5414d27310b69"><td class="memSeparator"
colspan="2">&#160;</td></tr>
+<tr class="memitem:aea96d358836d5e3b56a9695bde378b2a"><td class="memItemLeft" align="right"
valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a
class="el" href="classarrow_1_1py_1_1_scoped_ref.html#aea96d358836d5e3b56a9695bde378b2a">~ScopedRef</a>
()</td></tr>
+<tr class="separator:aea96d358836d5e3b56a9695bde378b2a"><td class="memSeparator"
colspan="2">&#160;</td></tr>
+<tr class="memitem:a1cadd64358ad29278b4d6f9ee1344078"><td class="memItemLeft" align="right"
valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a
class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a1cadd64358ad29278b4d6f9ee1344078">reset</a>
(PyObject *obj)</td></tr>
+<tr class="separator:a1cadd64358ad29278b4d6f9ee1344078"><td class="memSeparator"
colspan="2">&#160;</td></tr>
+<tr class="memitem:a5a20812323d56a3b9859fa2f0d018005"><td class="memItemLeft" align="right"
valign="top">PyObject *&#160;</td><td class="memItemRight" valign="bottom"><a
class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a5a20812323d56a3b9859fa2f0d018005">release</a>
()</td></tr>
+<tr class="separator:a5a20812323d56a3b9859fa2f0d018005"><td class="memSeparator"
colspan="2">&#160;</td></tr>
+<tr class="memitem:a9fc1bbe1e110d349bc40d489c5e7e191"><td class="memItemLeft" align="right"
valign="top">PyObject *&#160;</td><td class="memItemRight" valign="bottom"><a
class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a9fc1bbe1e110d349bc40d489c5e7e191">get</a>
() const</td></tr>
+<tr class="separator:a9fc1bbe1e110d349bc40d489c5e7e191"><td class="memSeparator"
colspan="2">&#160;</td></tr>
+<tr class="memitem:a433336b353a3129bdd89b248db63fec3"><td class="memItemLeft" align="right"
valign="top">PyObject **&#160;</td><td class="memItemRight" valign="bottom"><a
class="el" href="classarrow_1_1py_1_1_scoped_ref.html#a433336b353a3129bdd89b248db63fec3">ref</a>
()</td></tr>
+<tr class="separator:a433336b353a3129bdd89b248db63fec3"><td class="memSeparator"
colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="aff57aeaa246dbde9c1fade965f08e36f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aff57aeaa246dbde9c1fade965f08e36f">&#9670;&nbsp;</a></span>ScopedRef()
<span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">arrow::py::ScopedRef::ScopedRef </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">
+
+</div>
+</div>
+<a id="a10b5972ad27bf47fc2b5414d27310b69"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a10b5972ad27bf47fc2b5414d27310b69">&#9670;&nbsp;</a></span>ScopedRef()
<span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">arrow::py::ScopedRef::ScopedRef </td>
+          <td>(</td>
+          <td class="paramtype">PyObject *&#160;</td>
+          <td class="paramname"><em>obj</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>
 </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="aea96d358836d5e3b56a9695bde378b2a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aea96d358836d5e3b56a9695bde378b2a">&#9670;&nbsp;</a></span>~ScopedRef()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">arrow::py::ScopedRef::~ScopedRef </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">
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="a9fc1bbe1e110d349bc40d489c5e7e191"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9fc1bbe1e110d349bc40d489c5e7e191">&#9670;&nbsp;</a></span>get()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">PyObject* arrow::py::ScopedRef::get </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">
+
+</div>
+</div>
+<a id="a433336b353a3129bdd89b248db63fec3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a433336b353a3129bdd89b248db63fec3">&#9670;&nbsp;</a></span>ref()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">PyObject** arrow::py::ScopedRef::ref </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">
+
+</div>
+</div>
+<a id="a5a20812323d56a3b9859fa2f0d018005"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5a20812323d56a3b9859fa2f0d018005">&#9670;&nbsp;</a></span>release()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">PyObject* arrow::py::ScopedRef::release </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">
+
+</div>
+</div>
+<a id="a1cadd64358ad29278b4d6f9ee1344078"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1cadd64358ad29278b4d6f9ee1344078">&#9670;&nbsp;</a></span>reset()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">void arrow::py::ScopedRef::reset </td>
+          <td>(</td>
+          <td class="paramtype">PyObject *&#160;</td>
+          <td class="paramname"><em>obj</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">
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>/home/wesm/code/arrow/cpp/src/arrow/python/<a class="el" href="arrow_2python_2common_8h_source.html">common.h</a></li>
+</ul>
+</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.13
+</small></address>
+</body>
+</html>


Mime
View raw message