http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_buffer-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer-members.html b/docs/cpp/classarrow_1_1_buffer-members.html new file mode 100644 index 0000000..63582c3 --- /dev/null +++ b/docs/cpp/classarrow_1_1_buffer-members.html @@ -0,0 +1,124 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>Apache Arrow (C++): 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="classarrow_1_1_buffer.html">Buffer</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::Buffer Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a801078c559b0c351f1ca5a6b6a04488f">Buffer</a>(const uint8_t *data, int64_t size)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#af4fd71c2df93484b86a3ab1924193b05">Buffer</a>(const std::shared_ptr< Buffer > &parent, int64_t offset, int64_t size)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#aa31506ee38b2ae2a4d71f48a285d745d">capacity</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a45ee7f1e21f9f3f4cb8233be8d64731e">capacity_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a6616468bf89b5196ba53db2853246b6d">Copy</a>(int64_t start, int64_t nbytes, MemoryPool *pool, std::shared_ptr< Buffer > *out) const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#afa5b95c5e965d6c8bf1b86a34d2c8122">Copy</a>(int64_t start, int64_t nbytes, std::shared_ptr< Buffer > *out) const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a17211fa086c7f2bb6495295ddb593ad5">data</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#af468a7a1f346f9a6a29738bf585a3548">data_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a18d975e33ed702be3bf27f7b98123aaf">Equals</a>(const Buffer &other, int64_t nbytes) const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#aece0229498df83926ce8d1f4223b722b">Equals</a>(const Buffer &other) const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a15aa192631fbdad93a1939d3a0b193c7">is_mutable</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#acfefa777b4d7d6a2f7a8ea23549dac46">is_mutable_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a5a9cb9324d3f7e323eb070b553c925aa">mutable_data</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#ad36e306b99bc8427865bcac9b2d4f7e5">mutable_data_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a8c4faa36b9e310c99346425575014bde">parent</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a3feb5a490cbd9699837067931476c65b">parent_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a5620fd061758d0467d06b0edb783df73">size</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#a3500e42217635843b3b34bfe92b2f73a">size_</a></td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer.html#ac7bff4fbcc256c5abfe31df9e54853ec">~Buffer</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_buffer.html">arrow::Buffer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_buffer.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer.html b/docs/cpp/classarrow_1_1_buffer.html new file mode 100644 index 0000000..368b2f7 --- /dev/null +++ b/docs/cpp/classarrow_1_1_buffer.html @@ -0,0 +1,661 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>Apache Arrow (C++): arrow::Buffer 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="classarrow_1_1_buffer.html">Buffer</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classarrow_1_1_buffer-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::Buffer Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Immutable API for a chunk of bytes which may or may not be owned by the class instance. + <a href="classarrow_1_1_buffer.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="buffer_8h_source.html">buffer.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for arrow::Buffer:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarrow_1_1_buffer.png" usemap="#arrow::Buffer_map" alt=""/> + <map id="arrow::Buffer_map" name="arrow::Buffer_map"> +<area href="classarrow_1_1_mutable_buffer.html" title="A Buffer whose contents can be mutated. May or may not own its data. " alt="arrow::MutableBuffer" shape="rect" coords="133,56,390,80"/> +<area href="classarrow_1_1py_1_1_num_py_buffer.html" alt="arrow::py::NumPyBuffer" shape="rect" coords="400,56,657,80"/> +<area href="classarrow_1_1py_1_1_py_buffer.html" alt="arrow::py::PyBuffer" shape="rect" coords="667,56,924,80"/> +<area href="classarrow_1_1io_1_1_memory_mapped_file_1_1_memory_map.html" alt="arrow::io::MemoryMappedFile::MemoryMap" shape="rect" coords="0,112,257,136"/> +<area href="classarrow_1_1_resizable_buffer.html" alt="arrow::ResizableBuffer" shape="rect" coords="267,112,524,136"/> +<area href="classarrow_1_1_pool_buffer.html" title="A Buffer whose lifetime is tied to a particular MemoryPool. " alt="arrow::PoolBuffer" shape="rect" coords="267,168,524,192"/> +</map> + </div></div> +<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:a801078c559b0c351f1ca5a6b6a04488f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a801078c559b0c351f1ca5a6b6a04488f">Buffer</a> (const uint8_t *<a class="el" href="classarrow_1_1_buffer.html#a17211fa086c7f2bb6495295ddb593ad5">data</a>, int64_t <a class="el" href="classarrow_1_1_buffer.html#a5620fd061758d0467d06b0edb783df73">size</a>)</td></tr> +<tr class="separator:a801078c559b0c351f1ca5a6b6a04488f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac7bff4fbcc256c5abfe31df9e54853ec"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#ac7bff4fbcc256c5abfe31df9e54853ec">~Buffer</a> ()</td></tr> +<tr class="separator:ac7bff4fbcc256c5abfe31df9e54853ec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af4fd71c2df93484b86a3ab1924193b05"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#af4fd71c2df93484b86a3ab1924193b05">Buffer</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > &<a class="el" href="classarrow_1_1_buffer.html#a8c4faa36b9e310c99346425575014bde">parent</a>, int64_t offset, int64_t <a class="el" href="classarrow_1_1_buffer.html#a5620fd061758d0467d06b0edb783df73">size</a>)</td></tr> +<tr class="memdesc:af4fd71c2df93484b86a3ab1924193b05"><td class="mdescLeft"> </td><td class="mdescRight">An offset into data that is owned by another buffer, but we want to be able to retain a valid pointer to it even after other shared_ptr's to the parent buffer have been destroyed. <a href="#af4fd71c2df93484b86a3ab1924193b05">More...</a><br/></td></tr> +<tr class="separator:af4fd71c2df93484b86a3ab1924193b05"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a15aa192631fbdad93a1939d3a0b193c7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a15aa192631fbdad93a1939d3a0b193c7">is_mutable</a> () const </td></tr> +<tr class="separator:a15aa192631fbdad93a1939d3a0b193c7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a18d975e33ed702be3bf27f7b98123aaf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a18d975e33ed702be3bf27f7b98123aaf">Equals</a> (const <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> &other, int64_t nbytes) const </td></tr> +<tr class="memdesc:a18d975e33ed702be3bf27f7b98123aaf"><td class="mdescLeft"> </td><td class="mdescRight">Return true if both buffers are the same size and contain the same bytes up to the number of compared bytes. <a href="#a18d975e33ed702be3bf27f7b98123aaf">More...</a><br/></td></tr> +<tr class="separator:a18d975e33ed702be3bf27f7b98123aaf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aece0229498df83926ce8d1f4223b722b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#aece0229498df83926ce8d1f4223b722b">Equals</a> (const <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> &other) const </td></tr> +<tr class="separator:aece0229498df83926ce8d1f4223b722b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6616468bf89b5196ba53db2853246b6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a6616468bf89b5196ba53db2853246b6d">Copy</a> (int64_t start, int64_t nbytes, <a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool, std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > *out) const </td></tr> +<tr class="memdesc:a6616468bf89b5196ba53db2853246b6d"><td class="mdescLeft"> </td><td class="mdescRight">Copy a section of the buffer into a new <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a>. <a href="#a6616468bf89b5196ba53db2853246b6d">More...</a><br/></td></tr> +<tr class="separator:a6616468bf89b5196ba53db2853246b6d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afa5b95c5e965d6c8bf1b86a34d2c8122"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#afa5b95c5e965d6c8bf1b86a34d2c8122">Copy</a> (int64_t start, int64_t nbytes, std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > *out) const </td></tr> +<tr class="memdesc:afa5b95c5e965d6c8bf1b86a34d2c8122"><td class="mdescLeft"> </td><td class="mdescRight">Copy a section of the buffer using the default memory pool into a new <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a>. <a href="#afa5b95c5e965d6c8bf1b86a34d2c8122">More...</a><br/></td></tr> +<tr class="separator:afa5b95c5e965d6c8bf1b86a34d2c8122"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa31506ee38b2ae2a4d71f48a285d745d"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#aa31506ee38b2ae2a4d71f48a285d745d">capacity</a> () const </td></tr> +<tr class="separator:aa31506ee38b2ae2a4d71f48a285d745d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a17211fa086c7f2bb6495295ddb593ad5"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a17211fa086c7f2bb6495295ddb593ad5">data</a> () const </td></tr> +<tr class="separator:a17211fa086c7f2bb6495295ddb593ad5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5a9cb9324d3f7e323eb070b553c925aa"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a5a9cb9324d3f7e323eb070b553c925aa">mutable_data</a> ()</td></tr> +<tr class="separator:a5a9cb9324d3f7e323eb070b553c925aa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5620fd061758d0467d06b0edb783df73"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a5620fd061758d0467d06b0edb783df73">size</a> () const </td></tr> +<tr class="separator:a5620fd061758d0467d06b0edb783df73"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8c4faa36b9e310c99346425575014bde"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a8c4faa36b9e310c99346425575014bde">parent</a> () const </td></tr> +<tr class="separator:a8c4faa36b9e310c99346425575014bde"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:acfefa777b4d7d6a2f7a8ea23549dac46"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#acfefa777b4d7d6a2f7a8ea23549dac46">is_mutable_</a></td></tr> +<tr class="separator:acfefa777b4d7d6a2f7a8ea23549dac46"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af468a7a1f346f9a6a29738bf585a3548"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#af468a7a1f346f9a6a29738bf585a3548">data_</a></td></tr> +<tr class="separator:af468a7a1f346f9a6a29738bf585a3548"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad36e306b99bc8427865bcac9b2d4f7e5"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#ad36e306b99bc8427865bcac9b2d4f7e5">mutable_data_</a></td></tr> +<tr class="separator:ad36e306b99bc8427865bcac9b2d4f7e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3500e42217635843b3b34bfe92b2f73a"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a3500e42217635843b3b34bfe92b2f73a">size_</a></td></tr> +<tr class="separator:a3500e42217635843b3b34bfe92b2f73a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a45ee7f1e21f9f3f4cb8233be8d64731e"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a45ee7f1e21f9f3f4cb8233be8d64731e">capacity_</a></td></tr> +<tr class="separator:a45ee7f1e21f9f3f4cb8233be8d64731e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3feb5a490cbd9699837067931476c65b"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer.html#a3feb5a490cbd9699837067931476c65b">parent_</a></td></tr> +<tr class="separator:a3feb5a490cbd9699837067931476c65b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Immutable API for a chunk of bytes which may or may not be owned by the class instance. </p> +<p>Buffers have two related notions of length: size and capacity. Size is the number of bytes that might have valid data. Capacity is the number of bytes that where allocated for the buffer in total.</p> +<p>The following invariant is always true: Size < Capacity </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a801078c559b0c351f1ca5a6b6a04488f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">arrow::Buffer::Buffer </td> + <td>(</td> + <td class="paramtype">const uint8_t * </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</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 class="anchor" id="ac7bff4fbcc256c5abfe31df9e54853ec"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">arrow::Buffer::~Buffer </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="af4fd71c2df93484b86a3ab1924193b05"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">arrow::Buffer::Buffer </td> + <td>(</td> + <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > & </td> + <td class="paramname"><em>parent</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>offset</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> + +<p>An offset into data that is owned by another buffer, but we want to be able to retain a valid pointer to it even after other shared_ptr's to the parent buffer have been destroyed. </p> +<p>This method makes no assertions about alignment or padding of the buffer but in general we expected buffers to be aligned and padded to 64 bytes. In the future we might add utility methods to help determine if a buffer satisfies this contract. </p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="aa31506ee38b2ae2a4d71f48a285d745d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Buffer::capacity </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 class="anchor" id="a6616468bf89b5196ba53db2853246b6d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::Buffer::Copy </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>nbytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> * </td> + <td class="paramname"><em>pool</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Copy a section of the buffer into a new <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a>. </p> + +</div> +</div> +<a class="anchor" id="afa5b95c5e965d6c8bf1b86a34d2c8122"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::Buffer::Copy </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>nbytes</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > * </td> + <td class="paramname"><em>out</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Copy a section of the buffer using the default memory pool into a new <a class="el" href="classarrow_1_1_buffer.html" title="Immutable API for a chunk of bytes which may or may not be owned by the class instance. ">Buffer</a>. </p> + +</div> +</div> +<a class="anchor" id="a17211fa086c7f2bb6495295ddb593ad5"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const uint8_t* arrow::Buffer::data </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 class="anchor" id="a18d975e33ed702be3bf27f7b98123aaf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Buffer::Equals </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> & </td> + <td class="paramname"><em>other</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>nbytes</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return true if both buffers are the same size and contain the same bytes up to the number of compared bytes. </p> + +</div> +</div> +<a class="anchor" id="aece0229498df83926ce8d1f4223b722b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Buffer::Equals </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> & </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a15aa192631fbdad93a1939d3a0b193c7"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Buffer::is_mutable </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 class="anchor" id="a5a9cb9324d3f7e323eb070b553c925aa"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">uint8_t* arrow::Buffer::mutable_data </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 class="anchor" id="a8c4faa36b9e310c99346425575014bde"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_buffer.html">Buffer</a>> arrow::Buffer::parent </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 class="anchor" id="a5620fd061758d0467d06b0edb783df73"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Buffer::size </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> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a45ee7f1e21f9f3f4cb8233be8d64731e"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Buffer::capacity_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="af468a7a1f346f9a6a29738bf585a3548"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const uint8_t* arrow::Buffer::data_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="acfefa777b4d7d6a2f7a8ea23549dac46"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool arrow::Buffer::is_mutable_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ad36e306b99bc8427865bcac9b2d4f7e5"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">uint8_t* arrow::Buffer::mutable_data_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a3feb5a490cbd9699837067931476c65b"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_buffer.html">Buffer</a>> arrow::Buffer::parent_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a3500e42217635843b3b34bfe92b2f73a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::Buffer::size_</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>/home/wesm/code/arrow/cpp/src/arrow/<a class="el" href="buffer_8h_source.html">buffer.h</a></li> +<li>/home/wesm/code/arrow/cpp/src/arrow/<a class="el" href="buffer_8cc.html">buffer.cc</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_buffer.png ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer.png b/docs/cpp/classarrow_1_1_buffer.png new file mode 100644 index 0000000..41733e3 Binary files /dev/null and b/docs/cpp/classarrow_1_1_buffer.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_buffer_builder-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer_builder-members.html b/docs/cpp/classarrow_1_1_buffer_builder-members.html new file mode 100644 index 0000000..6dc2ed0 --- /dev/null +++ b/docs/cpp/classarrow_1_1_buffer_builder-members.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>Apache Arrow (C++): 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="classarrow_1_1_buffer_builder.html">BufferBuilder</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::BufferBuilder Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#aeb244237aa429582fbe9812e261eced0">Advance</a>(int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a861a36589ea59cee1125d3251bfae30c">Append</a>(const uint8_t *data, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#af6701776830a9f1663383d21da945fb4">Append</a>(T arithmetic_value)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a409caa84f0c679ce92305956b65f39e5">Append</a>(const T *arithmetic_values, int64_t num_elements)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ac574703fa5c840f84056200bc553365a">BufferBuilder</a>(MemoryPool *pool)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#afa82200b93003b20848029d8f98026b6">capacity</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ab1c0d5021270dd50cafbded84899655b">Finish</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#abd87c9b423a1662ba9f0a6c53fb32381">length</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ae5513e6855e7a49170fd2b9178fa2bc2">Resize</a>(int64_t elements)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#acb2881c13261f9755518d76ed5c4b9b6">UnsafeAppend</a>(const uint8_t *data, int64_t length)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#a39c2421e82515b15f62966e776bfc10c">UnsafeAppend</a>(T arithmetic_value)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html#ab0cb2ec41eb413fa531d2a7f7e777ebb">UnsafeAppend</a>(const T *arithmetic_values, int64_t num_elements)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_builder.html">arrow::BufferBuilder</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  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_buffer_builder.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer_builder.html b/docs/cpp/classarrow_1_1_buffer_builder.html new file mode 100644 index 0000000..ad6a43f --- /dev/null +++ b/docs/cpp/classarrow_1_1_buffer_builder.html @@ -0,0 +1,480 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>Apache Arrow (C++): arrow::BufferBuilder 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="classarrow_1_1_buffer_builder.html">BufferBuilder</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarrow_1_1_buffer_builder-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">arrow::BufferBuilder Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="buffer_8h_source.html">buffer.h</a>></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:ac574703fa5c840f84056200bc553365a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#ac574703fa5c840f84056200bc553365a">BufferBuilder</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool)</td></tr> +<tr class="separator:ac574703fa5c840f84056200bc553365a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae5513e6855e7a49170fd2b9178fa2bc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#ae5513e6855e7a49170fd2b9178fa2bc2">Resize</a> (int64_t elements)</td></tr> +<tr class="memdesc:ae5513e6855e7a49170fd2b9178fa2bc2"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the buffer to the nearest multiple of 64 bytes per Layout.md. <a href="#ae5513e6855e7a49170fd2b9178fa2bc2">More...</a><br/></td></tr> +<tr class="separator:ae5513e6855e7a49170fd2b9178fa2bc2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a861a36589ea59cee1125d3251bfae30c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#a861a36589ea59cee1125d3251bfae30c">Append</a> (const uint8_t *data, int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#abd87c9b423a1662ba9f0a6c53fb32381">length</a>)</td></tr> +<tr class="separator:a861a36589ea59cee1125d3251bfae30c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeb244237aa429582fbe9812e261eced0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#aeb244237aa429582fbe9812e261eced0">Advance</a> (int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#abd87c9b423a1662ba9f0a6c53fb32381">length</a>)</td></tr> +<tr class="separator:aeb244237aa429582fbe9812e261eced0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af6701776830a9f1663383d21da945fb4"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:af6701776830a9f1663383d21da945fb4"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#af6701776830a9f1663383d21da945fb4">Append</a> (T arithmetic_value)</td></tr> +<tr class="separator:af6701776830a9f1663383d21da945fb4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a409caa84f0c679ce92305956b65f39e5"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:a409caa84f0c679ce92305956b65f39e5"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#a409caa84f0c679ce92305956b65f39e5">Append</a> (const T *arithmetic_values, int64_t num_elements)</td></tr> +<tr class="separator:a409caa84f0c679ce92305956b65f39e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acb2881c13261f9755518d76ed5c4b9b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#acb2881c13261f9755518d76ed5c4b9b6">UnsafeAppend</a> (const uint8_t *data, int64_t <a class="el" href="classarrow_1_1_buffer_builder.html#abd87c9b423a1662ba9f0a6c53fb32381">length</a>)</td></tr> +<tr class="separator:acb2881c13261f9755518d76ed5c4b9b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a39c2421e82515b15f62966e776bfc10c"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:a39c2421e82515b15f62966e776bfc10c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#a39c2421e82515b15f62966e776bfc10c">UnsafeAppend</a> (T arithmetic_value)</td></tr> +<tr class="separator:a39c2421e82515b15f62966e776bfc10c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab0cb2ec41eb413fa531d2a7f7e777ebb"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> +<tr class="memitem:ab0cb2ec41eb413fa531d2a7f7e777ebb"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#ab0cb2ec41eb413fa531d2a7f7e777ebb">UnsafeAppend</a> (const T *arithmetic_values, int64_t num_elements)</td></tr> +<tr class="separator:ab0cb2ec41eb413fa531d2a7f7e777ebb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab1c0d5021270dd50cafbded84899655b"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#ab1c0d5021270dd50cafbded84899655b">Finish</a> ()</td></tr> +<tr class="separator:ab1c0d5021270dd50cafbded84899655b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afa82200b93003b20848029d8f98026b6"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#afa82200b93003b20848029d8f98026b6">capacity</a> ()</td></tr> +<tr class="separator:afa82200b93003b20848029d8f98026b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abd87c9b423a1662ba9f0a6c53fb32381"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_buffer_builder.html#abd87c9b423a1662ba9f0a6c53fb32381">length</a> ()</td></tr> +<tr class="separator:abd87c9b423a1662ba9f0a6c53fb32381"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="ac574703fa5c840f84056200bc553365a"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">arrow::BufferBuilder::BufferBuilder </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> * </td> + <td class="paramname"><em>pool</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> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="aeb244237aa429582fbe9812e261eced0"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::BufferBuilder::Advance </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>length</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> +<a class="anchor" id="a861a36589ea59cee1125d3251bfae30c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::BufferBuilder::Append </td> + <td>(</td> + <td class="paramtype">const uint8_t * </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>length</em> </td> + </tr> + <tr> + <td></td> + <td>)</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 class="anchor" id="af6701776830a9f1663383d21da945fb4"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::BufferBuilder::Append </td> + <td>(</td> + <td class="paramtype">T </td> + <td class="paramname"><em>arithmetic_value</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> +<a class="anchor" id="a409caa84f0c679ce92305956b65f39e5"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::BufferBuilder::Append </td> + <td>(</td> + <td class="paramtype">const T * </td> + <td class="paramname"><em>arithmetic_values</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>num_elements</em> </td> + </tr> + <tr> + <td></td> + <td>)</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 class="anchor" id="afa82200b93003b20848029d8f98026b6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::BufferBuilder::capacity </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 class="anchor" id="ab1c0d5021270dd50cafbded84899655b"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarrow_1_1_buffer.html">Buffer</a>> arrow::BufferBuilder::Finish </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 class="anchor" id="abd87c9b423a1662ba9f0a6c53fb32381"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">int64_t arrow::BufferBuilder::length </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 class="anchor" id="ae5513e6855e7a49170fd2b9178fa2bc2"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> arrow::BufferBuilder::Resize </td> + <td>(</td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>elements</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"> + +<p>Resizes the buffer to the nearest multiple of 64 bytes per Layout.md. </p> + +</div> +</div> +<a class="anchor" id="acb2881c13261f9755518d76ed5c4b9b6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void arrow::BufferBuilder::UnsafeAppend </td> + <td>(</td> + <td class="paramtype">const uint8_t * </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>length</em> </td> + </tr> + <tr> + <td></td> + <td>)</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 class="anchor" id="a39c2421e82515b15f62966e776bfc10c"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void arrow::BufferBuilder::UnsafeAppend </td> + <td>(</td> + <td class="paramtype">T </td> + <td class="paramname"><em>arithmetic_value</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> +<a class="anchor" id="ab0cb2ec41eb413fa531d2a7f7e777ebb"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void arrow::BufferBuilder::UnsafeAppend </td> + <td>(</td> + <td class="paramtype">const T * </td> + <td class="paramname"><em>arithmetic_values</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int64_t </td> + <td class="paramname"><em>num_elements</em> </td> + </tr> + <tr> + <td></td> + <td>)</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/<a class="el" href="buffer_8h_source.html">buffer.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/31f0e1f7/docs/cpp/classarrow_1_1_buffer_descr-members.html ---------------------------------------------------------------------- diff --git a/docs/cpp/classarrow_1_1_buffer_descr-members.html b/docs/cpp/classarrow_1_1_buffer_descr-members.html new file mode 100644 index 0000000..50128e5 --- /dev/null +++ b/docs/cpp/classarrow_1_1_buffer_descr-members.html @@ -0,0 +1,108 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>Apache Arrow (C++): 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacearrow.html">arrow</a></li><li class="navelem"><a class="el" href="classarrow_1_1_buffer_descr.html">BufferDescr</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">arrow::BufferDescr Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classarrow_1_1_buffer_descr.html">arrow::BufferDescr</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_descr.html#acd391f5392333a0a08b4d14a6d8ce9be">bit_width</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer_descr.html">arrow::BufferDescr</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classarrow_1_1_buffer_descr.html#aaf63f66e459f799365e5d3b18caa3cda">BufferDescr</a>(BufferType type, int bit_width)</td><td class="entry"><a class="el" href="classarrow_1_1_buffer_descr.html">arrow::BufferDescr</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_buffer_descr.html#a5663b9008c58130a99be09bd18ce8c35">type</a>() const </td><td class="entry"><a class="el" href="classarrow_1_1_buffer_descr.html">arrow::BufferDescr</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  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html>
