| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>iceberg-cpp: iceberg::BucketTransform Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1BucketTransform.html">BucketTransform</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classiceberg_1_1BucketTransform-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::BucketTransform Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Bucket transform that hashes input values into N buckets. |
| <a href="classiceberg_1_1BucketTransform.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="transform__function_8h_source.html">transform_function.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::BucketTransform:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1BucketTransform.png" usemap="#iceberg::BucketTransform_map" alt=""/> |
| <map id="iceberg::BucketTransform_map" name="iceberg::BucketTransform_map"> |
| <area href="classiceberg_1_1TransformFunction.html" title="A transform function used for partitioning." alt="iceberg::TransformFunction" shape="rect" coords="0,0,167,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a125bf86e3a179ecec02cfc183bf922d9" id="r_a125bf86e3a179ecec02cfc183bf922d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BucketTransform.html#a125bf86e3a179ecec02cfc183bf922d9">BucketTransform</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const &<a class="el" href="classiceberg_1_1TransformFunction.html#a5fb6043200973c2a68f1b59b52f3dc91">source_type</a>, int32_t <a class="el" href="classiceberg_1_1BucketTransform.html#a8487e6484edd8373653bb193bc8191bb">num_buckets</a>)</td></tr> |
| <tr class="separator:a125bf86e3a179ecec02cfc183bf922d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ade142bc532fe7e108bc317f7e52f1853" id="r_ade142bc532fe7e108bc317f7e52f1853"><td class="memItemLeft" align="right" valign="top">Result< <a class="el" href="classiceberg_1_1Literal.html">Literal</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BucketTransform.html#ade142bc532fe7e108bc317f7e52f1853">Transform</a> (const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &literal) override</td></tr> |
| <tr class="memdesc:ade142bc532fe7e108bc317f7e52f1853"><td class="mdescLeft"> </td><td class="mdescRight">Applies the bucket hash function to the input <a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a>. <br /></td></tr> |
| <tr class="separator:ade142bc532fe7e108bc317f7e52f1853"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a527f3ecbca2ca01185495a3f85e18115" id="r_a527f3ecbca2ca01185495a3f85e18115"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BucketTransform.html#a527f3ecbca2ca01185495a3f85e18115">ResultType</a> () const override</td></tr> |
| <tr class="memdesc:a527f3ecbca2ca01185495a3f85e18115"><td class="mdescLeft"> </td><td class="mdescRight">Returns INT32 as the output type. <br /></td></tr> |
| <tr class="separator:a527f3ecbca2ca01185495a3f85e18115"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8487e6484edd8373653bb193bc8191bb" id="r_a8487e6484edd8373653bb193bc8191bb"><td class="memItemLeft" align="right" valign="top"><a id="a8487e6484edd8373653bb193bc8191bb" name="a8487e6484edd8373653bb193bc8191bb"></a> |
| int32_t </td><td class="memItemRight" valign="bottom"><b>num_buckets</b> () const</td></tr> |
| <tr class="memdesc:a8487e6484edd8373653bb193bc8191bb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of buckets. <br /></td></tr> |
| <tr class="separator:a8487e6484edd8373653bb193bc8191bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classiceberg_1_1TransformFunction"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1TransformFunction')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1TransformFunction.html">iceberg::TransformFunction</a></td></tr> |
| <tr class="memitem:a3e97589741424abf0fb1c0c01117bb5e inherit pub_methods_classiceberg_1_1TransformFunction" id="r_a3e97589741424abf0fb1c0c01117bb5e"><td class="memItemLeft" align="right" valign="top"> |
|  </td><td class="memItemRight" valign="bottom"><b>TransformFunction</b> (<a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a> <a class="el" href="classiceberg_1_1TransformFunction.html#abf4c9031fa1b0de214e6aa7ffc717c56">transform_type</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > <a class="el" href="classiceberg_1_1TransformFunction.html#a5fb6043200973c2a68f1b59b52f3dc91">source_type</a>)</td></tr> |
| <tr class="separator:a3e97589741424abf0fb1c0c01117bb5e inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction" id="r_abf4c9031fa1b0de214e6aa7ffc717c56"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a> </td><td class="memItemRight" valign="bottom"><b>transform_type</b> () const</td></tr> |
| <tr class="memdesc:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="mdescLeft"> </td><td class="mdescRight">Get the transform type. <br /></td></tr> |
| <tr class="separator:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5fb6043200973c2a68f1b59b52f3dc91 inherit pub_methods_classiceberg_1_1TransformFunction" id="r_a5fb6043200973c2a68f1b59b52f3dc91"><td class="memItemLeft" align="right" valign="top"> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > & </td><td class="memItemRight" valign="bottom"><b>source_type</b> () const</td></tr> |
| <tr class="memdesc:a5fb6043200973c2a68f1b59b52f3dc91 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="mdescLeft"> </td><td class="mdescRight">Get the source type of transform function. <br /></td></tr> |
| <tr class="separator:a5fb6043200973c2a68f1b59b52f3dc91 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a53f80963a6b47eb54b7af1bad419b4c6" id="r_a53f80963a6b47eb54b7af1bad419b4c6"><td class="memItemLeft" align="right" valign="top">static Result< std::unique_ptr< <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1BucketTransform.html#a53f80963a6b47eb54b7af1bad419b4c6">Make</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const &<a class="el" href="classiceberg_1_1TransformFunction.html#a5fb6043200973c2a68f1b59b52f3dc91">source_type</a>, int32_t <a class="el" href="classiceberg_1_1BucketTransform.html#a8487e6484edd8373653bb193bc8191bb">num_buckets</a>)</td></tr> |
| <tr class="memdesc:a53f80963a6b47eb54b7af1bad419b4c6"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1BucketTransform.html" title="Bucket transform that hashes input values into N buckets.">BucketTransform</a>. <br /></td></tr> |
| <tr class="separator:a53f80963a6b47eb54b7af1bad419b4c6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Bucket transform that hashes input values into N buckets. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a125bf86e3a179ecec02cfc183bf922d9" name="a125bf86e3a179ecec02cfc183bf922d9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a125bf86e3a179ecec02cfc183bf922d9">◆ </a></span>BucketTransform()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">iceberg::BucketTransform::BucketTransform </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const & </td> |
| <td class="paramname"><em>source_type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>num_buckets</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">source_type</td><td><a class="el" href="classiceberg_1_1Type.html" title="Interface for a data type for a field.">Type</a> of the input data. </td></tr> |
| <tr><td class="paramname">num_buckets</td><td>Number of buckets to hash into. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a53f80963a6b47eb54b7af1bad419b4c6" name="a53f80963a6b47eb54b7af1bad419b4c6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a53f80963a6b47eb54b7af1bad419b4c6">◆ </a></span>Make()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> > > iceberg::BucketTransform::Make </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const & </td> |
| <td class="paramname"><em>source_type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>num_buckets</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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a <a class="el" href="classiceberg_1_1BucketTransform.html" title="Bucket transform that hashes input values into N buckets.">BucketTransform</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">source_type</td><td><a class="el" href="classiceberg_1_1Type.html" title="Interface for a data type for a field.">Type</a> of the input data. </td></tr> |
| <tr><td class="paramname">num_buckets</td><td>Number of buckets to hash into. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing the <a class="el" href="classiceberg_1_1BucketTransform.html" title="Bucket transform that hashes input values into N buckets.">BucketTransform</a> or an error. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a527f3ecbca2ca01185495a3f85e18115" name="a527f3ecbca2ca01185495a3f85e18115"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a527f3ecbca2ca01185495a3f85e18115">◆ </a></span>ResultType()</h2> |
| |
| <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="classiceberg_1_1Type.html">Type</a> > iceberg::BucketTransform::ResultType </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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns INT32 as the output type. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1TransformFunction.html#a82841b58ce6380a7467bccf57e18e0d5">iceberg::TransformFunction</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ade142bc532fe7e108bc317f7e52f1853" name="ade142bc532fe7e108bc317f7e52f1853"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ade142bc532fe7e108bc317f7e52f1853">◆ </a></span>Transform()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< <a class="el" href="classiceberg_1_1Literal.html">Literal</a> > iceberg::BucketTransform::Transform </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> & </td> |
| <td class="paramname"><em>literal</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Applies the bucket hash function to the input <a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a>. </p> |
| <p><a class="el" href="classiceberg_1_1Reference.html" title="A reference represents a named field in an expression.">Reference</a>:</p><ul> |
| <li><a href="https://iceberg.apache.org/spec/#appendix-b-32-bit-hash-requirements">https://iceberg.apache.org/spec/#appendix-b-32-bit-hash-requirements</a> </li> |
| </ul> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1TransformFunction.html#afb1c573d9bd098c76d858f476ef16f3f">iceberg::TransformFunction</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="transform__function_8h_source.html">transform_function.h</a></li> |
| <li>iceberg/<b>transform_function.cc</b></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
