http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/cuda__arrow__ipc_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/cuda__arrow__ipc_8h_source.html b/docs/cpp/cuda__arrow__ipc_8h_source.html index 4b17f49..0d545fa 100644 --- a/docs/cpp/cuda__arrow__ipc_8h_source.html +++ b/docs/cpp/cuda__arrow__ipc_8h_source.html @@ -67,20 +67,20 @@ $(function() { <div class="title">cuda_arrow_ipc.h</div> </div> </div><!--header--> <div class="contents"> -<a href="cuda__arrow__ipc_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><s pan 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 dist ributed 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_GPU_CUDA_ARROW_IPC_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_GPU_CUDA_ARROW_IPC_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 <cstdint></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">arrow/buffer.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00026"></a><span cla ss="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</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 "<a class="code" href="cuda__memory_8h.html">arrow/gpu/cuda_memory.h</a>"</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="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</s pan> <span class="keyword">class </span>RecordBatch;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacearrow_1_1ipc.html"> 36</a></span> <span class="keyword">namespace </span>ipc {</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><a class="code" href="classarrow_1_1ipc_1_1_message.html">Message</a>;</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 ipc</span></div><div class="line"><a name="l00041"></a><span class="l ineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacearrow_1_1gpu.html"> 42</a></span> <span class="keyword">namespace </span>gpu {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> ARROW_EXPORT</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="code" href="classarrow_1_1gpu_1_1_cuda_context.html">CudaContext</a>* ctx,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::shared_ptr<CudaBuffer>* out);< /div><div class="line"><a name="l00052"></a><span class="lineno"> 52</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> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a8a5b0c3b2731ba0e86a3f091765287ff">ReadMessage</a>(<a class="code" href="classarrow_1_1gpu_1_1_cuda_buffer_reader.html">CudaBufferReader</a>* reader, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::unique_ptr<ipc::Message>* message);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> ARROW_EXPORT</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> std::shared_ptr<CudaBuffer>& buffer, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::shared_ptr<RecordBatch>* out);</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">// namespace gpu</span></div><div class="line"><a nam e="l00075"></a><span class="lineno"> 75</span> } <span class="comment">// namespace arrow</span></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="preprocessor">#endif // ARROW_GPU_CUDA_ARROW_IPC_H</span></div><div class="ttc" id="namespacearrow_1_1ipc_html_a1c6195b676cf99ddde5c1e1a6e5abdec"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">arrow::ipc::SerializeRecordBatch</a></div><div class="ttdeci">Status SerializeRecordBatch(const RecordBatch &batch, MemoryPool *pool, std::shared_ptr< Buffer > *out)</div><div class="ttdoc">Serialize record batch as encapsulated IPC message in a new buffer. </div></div> -<div class="ttc" id="classarrow_1_1ipc_1_1_message_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_message.html">arrow::ipc::Message</a></div><div class="ttdoc">An IPC message including metadata and body. </div><div class="ttdef"><b>Definition:</b> message.h:57</div></div> -<div class="ttc" id="namespacearrow_html_ae1692c648f5447a7f95ddbe2c4e9a5fc"><div class="ttname"><a href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">arrow::schema</a></div><div class="ttdeci">std::shared_ptr< Schema > schema(const std::vector< std::shared_ptr< Field >> &fields, const std::shared_ptr< const KeyValueMetadata > &metadata=nullptr)</div><div class="ttdoc">Create a Schema instance. </div></div> -<div class="ttc" id="classarrow_1_1_record_batch_html"><div class="ttname"><a href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></div><div class="ttdoc">Collection of equal-length arrays matching a particular Schema. </div><div class="ttdef"><b>Definition:</b> table.h:114</div></div> +<a href="cuda__arrow__ipc_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><s pan 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 dist ributed 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_GPU_CUDA_ARROW_IPC_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define ARROW_GPU_CUDA_ARROW_IPC_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 <cstdint></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">arrow/buffer.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00026"></a><span cla ss="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</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 "<a class="code" href="cuda__memory_8h.html">arrow/gpu/cuda_memory.h</a>"</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="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>MemoryPool;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</s pan> <span class="keyword">class </span>RecordBatch;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacearrow_1_1ipc.html"> 36</a></span> <span class="keyword">namespace </span>ipc {</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><a class="code" href="classarrow_1_1ipc_1_1_message.html">Message</a>;</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 ipc</span></div><div class="line"><a name="l00041"></a><span class="l ineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacearrow_1_1gpu.html"> 42</a></span> <span class="keyword">namespace </span>gpu {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> ARROW_EXPORT</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="code" href="classarrow_1_1gpu_1_1_cuda_context.html">CudaContext</a>* ctx,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::shared_ptr<CudaBuffer>* out);< /div><div class="line"><a name="l00052"></a><span class="lineno"> 52</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> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a8a5b0c3b2731ba0e86a3f091765287ff">ReadMessage</a>(<a class="code" href="classarrow_1_1gpu_1_1_cuda_buffer_reader.html">CudaBufferReader</a>* reader, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::unique_ptr<ipc::Message>* message);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> ARROW_EXPORT</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> std::shared_ptr<CudaBuffer>& buffer, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::shared_ptr<RecordBatch>* out);</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">// namespace gpu</span></div><div class="line"><a nam e="l00075"></a><span class="lineno"> 75</span> } <span class="comment">// namespace arrow</span></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="preprocessor">#endif // ARROW_GPU_CUDA_ARROW_IPC_H</span></div><div class="ttc" id="namespacearrow_1_1ipc_html_a1c6195b676cf99ddde5c1e1a6e5abdec"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">arrow::ipc::SerializeRecordBatch</a></div><div class="ttdeci">Status SerializeRecordBatch(const RecordBatch &batch, MemoryPool *pool, std::shared_ptr< Buffer > *out)</div><div class="ttdoc">Serialize record batch as encapsulated IPC message in a new buffer. </div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_message_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_message.html">arrow::ipc::Message</a></div><div class="ttdoc">An IPC message including metadata and body. </div><div class="ttdef"><b>Definition:</b> message.h:58</div></div> +<div class="ttc" id="classarrow_1_1_record_batch_html"><div class="ttname"><a href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></div><div class="ttdoc">Collection of equal-length arrays matching a particular Schema. </div><div class="ttdef"><b>Definition:</b> table.h:118</div></div> <div class="ttc" id="classarrow_1_1gpu_1_1_cuda_context_html"><div class="ttname"><a href="classarrow_1_1gpu_1_1_cuda_context.html">arrow::gpu::CudaContext</a></div><div class="ttdoc">Friendlier interface to the CUDA driver API. </div><div class="ttdef"><b>Definition:</b> cuda_context.h:67</div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_a62aea9cdc78753fed7578ec36a85ab44"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">arrow::ipc::ReadRecordBatch</a></div><div class="ttdeci">Status ReadRecordBatch(const std::shared_ptr< Schema > &schema, io::InputStream *stream, std::shared_ptr< RecordBatch > *out)</div><div class="ttdoc">Read record batch as encapsulated IPC message with metadata size prefix and header. </div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_a8a5b0c3b2731ba0e86a3f091765287ff"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a8a5b0c3b2731ba0e86a3f091765287ff">arrow::ipc::ReadMessage</a></div><div class="ttdeci">Status ReadMessage(const int64_t offset, const int32_t metadata_length, io::RandomAccessFile *file, std::unique_ptr< Message > *message)</div><div class="ttdoc">Read encapulated RPC message from position in file. </div></div> <div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></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_1gpu_1_1_cuda_buffer_reader_html"><div class="ttname"><a href="classarrow_1_1gpu_1_1_cuda_buffer_reader.html">arrow::gpu::CudaBufferReader</a></div><div class="ttdoc">File interface for zero-copy read from CUDA buffers. </div><div class="ttdef"><b>Definition:</b> cuda_memory.h:124</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:28</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="status_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div> <div class="ttc" id="buffer_8h_html"><div class="ttname"><a href="buffer_8h.html">buffer.h</a></div></div> -<div class="ttc" id="classarrow_1_1_memory_pool_html"><div class="ttname"><a href="classarrow_1_1_memory_pool.html">arrow::MemoryPool</a></div><div class="ttdoc">Base class for memory allocation. </div><div class="ttdef"><b>Definition:</b> memory_pool.h:35</div></div> +<div class="ttc" id="namespacearrow_html_a97ac72c2a07228577c1d38b7747941a9"><div class="ttname"><a href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">arrow::schema</a></div><div class="ttdeci">std::shared_ptr< Schema > schema(const std::vector< std::shared_ptr< Field >> &fields, const std::shared_ptr< const KeyValueMetadata > &metadata=NULLPTR)</div><div class="ttdoc">Create a Schema instance. </div></div> +<div class="ttc" id="classarrow_1_1_memory_pool_html"><div class="ttname"><a href="classarrow_1_1_memory_pool.html">arrow::MemoryPool</a></div><div class="ttdoc">Base class for memory allocation. </div><div class="ttdef"><b>Definition:</b> memory_pool.h:34</div></div> <div class="ttc" id="cuda__memory_8h_html"><div class="ttname"><a href="cuda__memory_8h.html">cuda_memory.h</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part -->
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/cuda__common_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/cuda__common_8h_source.html b/docs/cpp/cuda__common_8h_source.html index 7e9effa..a88dc84 100644 --- a/docs/cpp/cuda__common_8h_source.html +++ b/docs/cpp/cuda__common_8h_source.html @@ -67,7 +67,7 @@ $(function() { <div class="title">cuda_common.h</div> </div> </div><!--header--> <div class="contents"> -<a href="cuda__common_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 distribu ted 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="comment">// Non-public header</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</ span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_GPU_CUDA_COMMON_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_GPU_CUDA_COMMON_H</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 <sstream></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <cuda.h></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="keyword">namespace </span><a class="code" href="namespac earrow.html">arrow</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>gpu {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="cuda__common_8h.html#abff70d9d97dcde912b190b6fa47a6cac"> 30</a></span> <span class="preprocessor">#define CUDA_DCHECK(STMT) \</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"> do { \</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"> int ret = (STMT); \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"> DCHECK_EQ(0, ret); \</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="pr eprocessor"> (void)ret; \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"> } while (0)</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="cuda__common_8h.html#a9f17382796b0e14bd6a628ad5373841b"> 37</a></span> <span class="preprocessor">#define CU_RETURN_NOT_OK(STMT) \</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"> do { \</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"> CUresult ret = (STMT); \</span></div><div class="line"><a name="l00040"></a><span class="linen o"> 40</span> <span class="preprocessor"> if (ret != CUDA_SUCCESS) { \</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"> std::stringstream ss; \</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"> ss << "Cuda Driver API call in " << __FILE__ << " at line " << __LINE__ \</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"> << " failed with code " << ret << ": " << #STMT; \</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"> return Status::IOError(ss.str()); \</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"> } \</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"> } while (0)</span></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">// namespace gpu</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> } <span class="comment">// namespace arrow</span></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="preprocessor">#endif // ARROW_GPU_CUDA_COMMON_H</span></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:28</div></div> +<a href="cuda__common_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 distribu ted 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="comment">// Non-public header</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</ span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_GPU_CUDA_COMMON_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_GPU_CUDA_COMMON_H</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 <sstream></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <cuda.h></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="keyword">namespace </span><a class="code" href="namespac earrow.html">arrow</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>gpu {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="cuda__common_8h.html#abff70d9d97dcde912b190b6fa47a6cac"> 30</a></span> <span class="preprocessor">#define CUDA_DCHECK(STMT) \</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"> do { \</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"> int ret = (STMT); \</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"> DCHECK_EQ(0, ret); \</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="pr eprocessor"> (void)ret; \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"> } while (0)</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="cuda__common_8h.html#a9f17382796b0e14bd6a628ad5373841b"> 37</a></span> <span class="preprocessor">#define CU_RETURN_NOT_OK(STMT) \</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"> do { \</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"> CUresult ret = (STMT); \</span></div><div class="line"><a name="l00040"></a><span class="linen o"> 40</span> <span class="preprocessor"> if (ret != CUDA_SUCCESS) { \</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"> std::stringstream ss; \</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"> ss << "Cuda Driver API call in " << __FILE__ << " at line " << __LINE__ \</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"> << " failed with code " << ret << ": " << #STMT; \</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"> return Status::IOError(ss.str()); \</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"> } \</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"> } while (0)</span></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">// namespace gpu</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> } <span class="comment">// namespace arrow</span></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="preprocessor">#endif // ARROW_GPU_CUDA_COMMON_H</span></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><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/cuda__context_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/cuda__context_8h_source.html b/docs/cpp/cuda__context_8h_source.html index e82a8af..5d0c2ac 100644 --- a/docs/cpp/cuda__context_8h_source.html +++ b/docs/cpp/cuda__context_8h_source.html @@ -76,7 +76,7 @@ $(function() { <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_1gpu_1_1_cuda_buffer_html"><div class="ttname"><a href="classarrow_1_1gpu_1_1_cuda_buffer.html">arrow::gpu::CudaBuffer</a></div><div class="ttdoc">An Arrow buffer located on a GPU device. </div><div class="ttdef"><b>Definition:</b> cuda_memory.h:39</div></div> <div class="ttc" id="classarrow_1_1gpu_1_1_cuda_buffer_reader_html"><div class="ttname"><a href="classarrow_1_1gpu_1_1_cuda_buffer_reader.html">arrow::gpu::CudaBufferReader</a></div><div class="ttdoc">File interface for zero-copy read from CUDA buffers. </div><div class="ttdef"><b>Definition:</b> cuda_memory.h:124</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:28</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="status_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div> <div class="ttc" id="cuda__memory_8h_html"><div class="ttname"><a href="cuda__memory_8h.html">cuda_memory.h</a></div></div> </div><!-- fragment --></div><!-- contents -->
