You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by uw...@apache.org on 2018/05/18 07:47:24 UTC
[23/51] [partial] arrow-site git commit: Update API docs
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/c77df435/docs/cpp/helpers_8h_source.html
----------------------------------------------------------------------
diff --git a/docs/cpp/helpers_8h_source.html b/docs/cpp/helpers_8h_source.html
index 97a45e7..2b9f209 100644
--- a/docs/cpp/helpers_8h_source.html
+++ b/docs/cpp/helpers_8h_source.html
@@ -70,13 +70,16 @@ $(function() {
<div class="title">helpers.h</div> </div>
</div><!--header-->
<div class="contents">
-<a href="helpers_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 distributed u
nder 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 PYARROW_HELPERS_H</span></div><div class="line"><a name="l00019"></a><span class="lineno">
19</span> <span class="preprocessor">#define PYARROW_HELPERS_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 <memory></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"
></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="type_8h.html">arrow/type.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="macros_8h.html">arrow/util/macros.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 cla
ss="keyword">class </span>Decimal128;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>py {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>OwnedRef;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// \brief Get an arrow DataType instance from Arrow's Type::type enum</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// \param[in] type One of the values of Arrow's Type::type enum</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <sp
an class="comment">// \return A shared pointer to DataType</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> ARROW_EXPORT std::shared_ptr<DataType> <a class="code" href="namespacearrow_1_1py.html#a8949b2e5469221ad1b1eaf8665b9610b">GetPrimitiveType</a>(<a class="code" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> type);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// \brief Import a Python module</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// \param[in] module_name The name of the m
odule</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// \param[out] ref The OwnedRef containing the module PyObject*</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> Status ImportModule(<span class="keyword">const</span> std::string& module_name, OwnedRef* ref);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// \brief Import an object from a Python module</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// \param[in] module A Python module</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// \param[in] name The name of the object to import</span></div><div class="line"><a name="l00054"></a><span class="lineno">
54</span> <span class="comment">// \param[out] ref The OwnedRef containing the \c name attribute of the Python module \c</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// module</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> Status ImportFromModule(<span class="keyword">const</span> OwnedRef& module, <span class="keyword">const</span> std::string& name, OwnedRef* ref);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// \brief Import</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> Status ImportDecimalType(OwnedRef* <a class="code" href="namespacearrow.html#aecb3c7b3d0ee16a7761adcfdbe56c113">decimal_type</a>);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span
> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// \brief Convert a Python Decimal object to a C++ string</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// \param[in] python_decimal A Python decimal.Decimal instance</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// \param[out] The string representation of the Python Decimal instance</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// \return The status of the operation</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> Status PythonDecimalToString(PyObject* python_decimal, std::string* 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">// \brief Convert a C++ std::string to a Python Decimal instance</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// \param[in] decimal_constructor The decimal type object</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// \param[in] decimal_string A decimal string</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// \return An instance of decimal.Decimal</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> PyObject* DecimalFromString(PyObject* decimal_constructor,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> std::string& decimal_string);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <
/div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// \brief Convert a Python decimal to an Arrow Decimal128 object</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// \param[in] python_decimal A Python decimal.Decimal instance</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// \param[in] arrow_type An instance of arrow::DecimalType</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// \param[out] out A pointer to a Decimal128</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// \return The status of the operation</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> Status DecimalFromPythonDecimal(PyObject* python_decimal, <span class="keyword">con
st</span> DecimalType& arrow_type,</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  Decimal128* out);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// \brief Check whether obj is an integer, independent of Python versions.</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">bool</span> IsPyInteger(PyObject* obj);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// \brief Use pandas missing value semantics to check if a value is null</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">bool</span> PandasObjectIsN
ull(PyObject* obj);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// \brief Check whether obj is nan</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">bool</span> PyFloat_IsNaN(PyObject* obj);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// \brief Check whether obj is an instance of Decimal</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">bool</span> PyDecimal_Check(PyObject* obj);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">//
\brief Check whether obj is nan. This function will abort the program if the argument</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// is not a Decimal instance</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">bool</span> PyDecimal_ISNAN(PyObject* obj);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">// \brief Convert a Python integer into an unsigned 64-bit integer</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// \param[in] obj A Python integer</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// \param[out] out A pointer to a C uint64_t to hold the result of the conversion</span></div><
div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// \return The status of the operation</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> Status UInt64FromPythonInt(PyObject* obj, uint64_t* out);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">// \brief Helper class to track and update the precision and scale of a decimal</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">class </span>DecimalMetadata {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  DecimalMetadata();</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</sp
an>  DecimalMetadata(int32_t precision, int32_t scale);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// \brief Adjust the precision and scale of a decimal type given a new precision and a</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">// new scale \param[in] suggested_precision A candidate precision \param[in]</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// suggested_scale A candidate scale \return The status of the operation</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  Status Update(int32_t suggested_precision, int32_t suggested_scale);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l0
0115"></a><span class="lineno"> 115</span>  <span class="comment">// \brief A convenient interface for updating the precision and scale based on a Python</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// Decimal object \param object A Python Decimal object \return The status of the</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// operation</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  Status Update(PyObject* <span class="keywordtype">object</span>);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  int32_t precision()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> precision_; }</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</spa
n>  int32_t scale()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> scale_; }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  int32_t precision_;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  int32_t scale_;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> };</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l0
0130"></a><span class="lineno"> 130</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#endif // PYARROW_HELPERS_H</span></div><div class="ttc" id="structarrow_1_1_type_html_a00a041cb19a3be373da8eec7d4bf1f44"><div class="ttname"><a href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">arrow::Type::type</a></div><div class="ttdeci">type</div><div class="ttdef"><b>Definition:</b> type.h:45</div></div>
+<a href="helpers_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 distributed u
nder 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_HELPERS_H</span></div><div class="line"><a name="l00019"></a><span class="linen
o"> 19</span> <span class="preprocessor">#define ARROW_PYTHON_HELPERS_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 <limits></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 <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#inc
lude <utility></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <numpy/halffloat.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="type_8h.html">arrow/type.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="macros_8h.html">arrow/util/macros.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00033"></a><span
class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</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>py {</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>OwnedRef;</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">// \brief Get an arrow DataType instance from Arrow's Type::type enum</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span clas
s="comment">// \param[in] type One of the values of Arrow's Type::type enum</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// \return A shared pointer to DataType</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> ARROW_EXPORT std::shared_ptr<DataType> <a class="code" href="namespacearrow_1_1py.html#a8949b2e5469221ad1b1eaf8665b9610b">GetPrimitiveType</a>(<a class="code" href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">Type::type</a> type);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// \brief Construct a np.float16 object from a npy_half value.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> ARROW_EXPORT PyObject* <a class="code" href="namespacearrow_1_1py.html#a60d1f75
2dfe2f3bbfa942c834ee607e0">PyHalf_FromHalf</a>(npy_half value);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// \brief Convert a Python object to a npy_half value.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> ARROW_EXPORT Status <a class="code" href="namespacearrow_1_1py.html#a52122657a994c78624f7e83ccaae30af">PyFloat_AsHalf</a>(PyObject* obj, npy_half* out);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// \brief Import a Python module</span><
/div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// \param[in] module_name The name of the module</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// \param[out] ref The OwnedRef containing the module PyObject*</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> Status ImportModule(<span class="keyword">const</span> std::string& module_name, OwnedRef* ref);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// \brief Import an object from a Python module</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// \param[in] module A Python module</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> 
<span class="comment">// \param[in] name The name of the object to import</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// \param[out] ref The OwnedRef containing the \c name attribute of the Python module \c</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// module</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> Status ImportFromModule(<span class="keyword">const</span> OwnedRef& module, <span class="keyword">const</span> std::string& name, OwnedRef* ref);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// \brief Check whether obj is an integer, independent of Python versions.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <
span class="keyword">inline</span> <span class="keywordtype">bool</span> IsPyInteger(PyObject* obj) {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#if PYARROW_IS_PY2</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> PyLong_Check(obj) || PyInt_Check(obj);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> PyLong_Check(obj);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00
074"></a><span class="lineno"> 74</span> <span class="comment">// \brief Use pandas missing value semantics to check if a value is null</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">bool</span> PandasObjectIsNull(PyObject* obj);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// \brief Check whether obj is nan</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">bool</span> PyFloat_IsNaN(PyObject* obj);</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="keyword">inline</span> <span class="keywordtype">bool</span> IsPyBinary(PyObject* obj) {</div><div class="line"><a name="l00081">
</a><span class="lineno"> 81</span>  <span class="keywordflow">return</span> PyBytes_Check(obj) || PyByteArray_Check(obj);</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> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// \brief Convert a Python integer into a C integer</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// \param[in] obj A Python integer</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// \param[out] out A pointer to a C integer to hold the result of the conversion</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// \return The status of the operation</span></div><div class="line"><a name="l00088"></
a><span class="lineno"> 88</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Int></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> Status CIntFromPython(PyObject* obj, Int* out, <span class="keyword">const</span> std::string& overflow_message = <span class="stringliteral">""</span>);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// \brief Convert a Python unicode string to a std::string</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> Status PyUnicode_AsStdString(PyObject* obj, std::string* out);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// \brief Convert a Python
bytes object to a std::string</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> std::string PyBytes_AsStdString(PyObject* obj);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">// \brief Call str() on the given object and return the result as a std::string</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> Status PyObject_StdStringStr(PyObject* obj, std::string* out);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// \brief Return the repr() of the given object (always succeeds)</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> std::string PyObject_StdStringRepr(PyObject* obj);</div><div c
lass="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">// \brief Cast the given size to int32_t, with error checking</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">inline</span> Status CastSize(Py_ssize_t size, int32_t* out,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* error_msg = <span class="stringliteral">"Maximum size exceeded (2GB)"</span>) {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="comment">// size is assumed to be positive</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">if</span> (size > std::numeric_limits<int32_t>
::max()) {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#aaaa6c0ddc3021415c238ab07353f3195">Status::Invalid</a>(error_msg);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  }</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  *out = <span class="keyword">static_cast<</span>int32_t<span class="keyword">></span>(size);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">return</span> <a class="code" href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">Status::OK</a>();</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span
> Status BuilderAppend(StringBuilder* builder, PyObject* obj, <span class="keywordtype">bool</span> check_valid = <span class="keyword">false</span>,</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">bool</span>* is_full = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> Status BuilderAppend(BinaryBuilder* builder, PyObject* obj, <span class="keywordtype">bool</span>* is_full = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> Status BuilderAppend(FixedSizeBinaryBuilder* builder, PyObject* obj,</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">bool</span>* is_full = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</spa
n> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> } <span class="comment">// namespace py</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif // ARROW_PYTHON_HELPERS_H</span></div><div class="ttc" id="structarrow_1_1_type_html_a00a041cb19a3be373da8eec7d4bf1f44"><div class="ttname"><a href="structarrow_1_1_type.html#a00a041cb19a3be373da8eec7d4bf1f44">arrow::Type::type</a></div><div class="ttdeci">type</div><div class="ttdef"><b>Definition:</b> type.h:46</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="namespacearrow_html_aecb3c7b3d0ee16a7761adcfdbe56c113"><div class="ttname"><a href="namespacearrow.html#aecb3c7b3d0ee16a7761adcfdbe56c113">arrow::decimal_type</a></div><div class="ttdeci">std::shared_ptr< DataType > decimal_type(int precision, int scale)</div></div>
+<div class="ttc" id="namespacearrow_1_1py_html_a60d1f752dfe2f3bbfa942c834ee607e0"><div class="ttname"><a href="namespacearrow_1_1py.html#a60d1f752dfe2f3bbfa942c834ee607e0">arrow::py::PyHalf_FromHalf</a></div><div class="ttdeci">PyObject * PyHalf_FromHalf(npy_half value)</div></div>
<div class="ttc" id="namespacearrow_1_1py_html_a8949b2e5469221ad1b1eaf8665b9610b"><div class="ttname"><a href="namespacearrow_1_1py.html#a8949b2e5469221ad1b1eaf8665b9610b">arrow::py::GetPrimitiveType</a></div><div class="ttdeci">std::shared_ptr< DataType > GetPrimitiveType(Type::type type)</div></div>
<div class="ttc" id="macros_8h_html"><div class="ttname"><a href="macros_8h.html">macros.h</a></div></div>
+<div class="ttc" id="classarrow_1_1_status_html_a5c0b0031db6eeec3dcc70485d24cfe03"><div class="ttname"><a href="classarrow_1_1_status.html#a5c0b0031db6eeec3dcc70485d24cfe03">arrow::Status::OK</a></div><div class="ttdeci">static Status OK()</div><div class="ttdef"><b>Definition:</b> status.h:106</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="classarrow_1_1_status_html_aaaa6c0ddc3021415c238ab07353f3195"><div class="ttname"><a href="classarrow_1_1_status.html#aaaa6c0ddc3021415c238ab07353f3195">arrow::Status::Invalid</a></div><div class="ttdeci">static Status Invalid(const std::string &msg)</div><div class="ttdef"><b>Definition:</b> status.h:129</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="namespacearrow_1_1py_html_a52122657a994c78624f7e83ccaae30af"><div class="ttname"><a href="namespacearrow_1_1py.html#a52122657a994c78624f7e83ccaae30af">arrow::py::PyFloat_AsHalf</a></div><div class="ttdeci">Status PyFloat_AsHalf(PyObject *obj, npy_half *out)</div></div>
<div class="ttc" id="type_8h_html"><div class="ttname"><a href="type_8h.html">type.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->