blob: 6b254e9b34c8477f4b45f517860c47d63476f8ae [file] [log] [blame]
<!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/util/decimal.h Source File</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_7a408d6a2d81183c3eacfe2576f2a2aa.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">decimal.h</div></div>
</div><!--header-->
<div class="contents">
<a href="decimal_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;array&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;compare&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;iosfwd&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include &lt;string_view&gt;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#include &quot;iceberg/iceberg_export.h&quot;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#include &quot;iceberg/result.h&quot;</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#include &quot;<a class="code" href="formattable_8h.html">iceberg/util/formattable.h</a>&quot;</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#include &quot;<a class="code" href="int128_8h.html">iceberg/util/int128.h</a>&quot;</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">namespace </span>iceberg {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="foldopen" id="foldopen00046" data-start="{" data-end="};">
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html"> 46</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1util_1_1Formattable.html">util::Formattable</a> {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kBitWidth = 128;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kByteWidth = kBitWidth / 8;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kMaxPrecision = 38;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kMaxScale = 38;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#ae63e1b780e6ac1b118179901a0b2412a"> 54</a></span> <span class="keyword">constexpr</span> <a class="code hl_function" href="classiceberg_1_1Decimal.html#ae63e1b780e6ac1b118179901a0b2412a">Decimal</a>() noexcept = default;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="}">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#a75a669d0c23dc618d6ea77bfb66f4078"> 57</a></span> constexpr <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>(int128_t value) noexcept <span class="comment">// NOLINT implicit conversion</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> : data_(value) {}</div>
</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">requires</span>(std::is_integral_v&lt;T&gt; &amp;&amp; (<span class="keyword">sizeof</span>(T) &lt;= <span class="keyword">sizeof</span>(uint64_t)))</div>
<div class="foldopen" id="foldopen00063" data-start="{" data-end="}">
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#a5e57a9033dc325933919ecf53bd60cbb"> 63</a></span> <span class="keyword">constexpr</span> <a class="code hl_function" href="classiceberg_1_1Decimal.html#a5e57a9033dc325933919ecf53bd60cbb">Decimal</a>(T value) <span class="keyword">noexcept</span> <span class="comment">// NOLINT implicit conversion</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> : data_(<span class="keyword">static_cast&lt;</span>int128_t<span class="keyword">&gt;</span>(value)) {}</div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>(std::string_view str);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="foldopen" id="foldopen00072" data-start="{" data-end="}">
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#ac6f8d5cc9231f35361dbf25003847c9a"> 72</a></span> <span class="keyword">constexpr</span> <a class="code hl_function" href="classiceberg_1_1Decimal.html#ac6f8d5cc9231f35361dbf25003847c9a">Decimal</a>(int64_t high, uint64_t low) <span class="keyword">noexcept</span> {</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> data_ = (<span class="keyword">static_cast&lt;</span>int128_t<span class="keyword">&gt;</span>(high) &lt;&lt; 64) | low;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> }</div>
</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; Negate();</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; Abs();</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a> Abs(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; value);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator+=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; other);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator-=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; other);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator*=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; other);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> Result&lt;std::pair&lt;Decimal, Decimal&gt;&gt; Divide(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; divisor) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator/=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; other);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator|=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; other);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator&amp;=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; other);</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator&lt;&lt;=(uint32_t shift);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="foldopen" id="foldopen00119" data-start="{" data-end="}">
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#ad9a1babe945e8492c74448578af36225"> 119</a></span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a> <a class="code hl_function" href="classiceberg_1_1Decimal.html#ad9a1babe945e8492c74448578af36225">operator&lt;&lt;</a>(uint32_t shift)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a> result(*<span class="keyword">this</span>);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> result &lt;&lt;= shift;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keywordflow">return</span> result;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> }</div>
</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; operator&gt;&gt;=(uint32_t shift);</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="foldopen" id="foldopen00129" data-start="{" data-end="}">
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#a204b44d47eaf08b857ce0b134d6218e9"> 129</a></span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a> <a class="code hl_function" href="classiceberg_1_1Decimal.html#a204b44d47eaf08b857ce0b134d6218e9">operator&gt;&gt;</a>(uint32_t shift)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a> result(*<span class="keyword">this</span>);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> result &gt;&gt;= shift;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordflow">return</span> result;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> }</div>
</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#a875c00e32647b8d39e2a9bb77b3ae5d1"> 136</a></span> <span class="keyword">constexpr</span> int128_t <a class="code hl_function" href="classiceberg_1_1Decimal.html#a875c00e32647b8d39e2a9bb77b3ae5d1">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> data_; }</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#ab025a97f157ee7ea1a2135ad34dbb2d2"> 139</a></span> <span class="keyword">constexpr</span> int64_t <a class="code hl_function" href="classiceberg_1_1Decimal.html#ab025a97f157ee7ea1a2135ad34dbb2d2">high</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>int64_t<span class="keyword">&gt;</span>(data_ &gt;&gt; 64); }</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#a26a32345b2111f0e4be1ec85bfd5da46"> 142</a></span> <span class="keyword">constexpr</span> uint64_t <a class="code hl_function" href="classiceberg_1_1Decimal.html#a26a32345b2111f0e4be1ec85bfd5da46">low</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>uint64_t<span class="keyword">&gt;</span>(data_); }</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> Result&lt;std::string&gt; ToString(int32_t scale) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> std::string ToIntegerString() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#ab78520099cf3c8365b5621c159fc2ff5"> 153</a></span> std::string <a class="code hl_function" href="classiceberg_1_1Decimal.html#ab78520099cf3c8365b5621c159fc2ff5">ToString</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> ToIntegerString(); }</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> <span class="keyword">static</span> Result&lt;Decimal&gt; FromString(std::string_view str, int32_t* precision = <span class="keyword">nullptr</span>,</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> int32_t* scale = <span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <span class="keyword">static</span> Result&lt;Decimal&gt; <a class="code hl_function" href="endian_8h.html#ad32cff8f6ada2e4ab2e0701f0a043f28">FromBigEndian</a>(<span class="keyword">const</span> uint8_t* data, int32_t length);</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> std::vector&lt;uint8_t&gt; <a class="code hl_function" href="endian_8h.html#aa051ea16b5c1c3d2c4b5c04db46ffa43">ToBigEndian</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> Result&lt;Decimal&gt; Rescale(int32_t orig_scale, int32_t new_scale) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> <span class="keywordtype">bool</span> FitsInPrecision(int32_t precision) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="foldopen" id="foldopen00183" data-start="{" data-end="}">
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#a224e99c351e9183fe83cb132a01cbfb1"> 183</a></span> std::strong_ordering <a class="code hl_function" href="classiceberg_1_1Decimal.html#a224e99c351e9183fe83cb132a01cbfb1">operator&lt;=&gt;</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; other)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="keywordflow">if</span> (high() != other.<a class="code hl_function" href="classiceberg_1_1Decimal.html#ab025a97f157ee7ea1a2135ad34dbb2d2">high</a>()) {</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <span class="keywordflow">return</span> high() &lt;=&gt; other.<a class="code hl_function" href="classiceberg_1_1Decimal.html#ab025a97f157ee7ea1a2135ad34dbb2d2">high</a>();</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> }</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keywordflow">return</span> low() &lt;=&gt; other.<a class="code hl_function" href="classiceberg_1_1Decimal.html#a26a32345b2111f0e4be1ec85bfd5da46">low</a>();</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> }</div>
</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> <span class="keyword">static</span> std::partial_ordering Compare(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; lhs, <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Decimal.html">Decimal</a>&amp; rhs,</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> int32_t lhs_scale, int32_t rhs_scale);</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> </div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> <span class="keyword">const</span> uint8_t* native_endian_bytes()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>uint8_t*<span class="keyword">&gt;</span>(&amp;data_);</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> }</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> std::array&lt;uint8_t, kByteWidth&gt; ToBytes() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#af06c220ced2f385e745e9e37ccfe38f1"> 202</a></span> int64_t <a class="code hl_function" href="classiceberg_1_1Decimal.html#af06c220ced2f385e745e9e37ccfe38f1">Sign</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1 | (high() &gt;&gt; 63); }</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> </div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"><a class="line" href="classiceberg_1_1Decimal.html#a39e113937ee4f3d9075904ca4c9b8cd5"> 205</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1Decimal.html#a39e113937ee4f3d9075904ca4c9b8cd5">IsNegative</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (high() &gt;&gt; 63) &lt; 0; }</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> data_ != 0; }</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> </div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> Decimal&amp; lhs, <span class="keyword">const</span> Decimal&amp; rhs) {</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> <span class="keywordflow">return</span> lhs.data_ == rhs.data_;</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> }</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> </div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> Decimal&amp; lhs, <span class="keyword">const</span> Decimal&amp; rhs) {</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> <span class="keywordflow">return</span> lhs.data_ != rhs.data_;</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> }</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> ICEBERG_EXPORT <span class="keyword">friend</span> Decimal operator-(<span class="keyword">const</span> Decimal&amp; operand);</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> ICEBERG_EXPORT <span class="keyword">friend</span> Decimal operator~(<span class="keyword">const</span> Decimal&amp; operand);</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> </div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> ICEBERG_EXPORT <span class="keyword">friend</span> Decimal operator+(<span class="keyword">const</span> Decimal&amp; lhs, <span class="keyword">const</span> Decimal&amp; rhs);</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> ICEBERG_EXPORT <span class="keyword">friend</span> Decimal operator-(<span class="keyword">const</span> Decimal&amp; lhs, <span class="keyword">const</span> Decimal&amp; rhs);</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> ICEBERG_EXPORT <span class="keyword">friend</span> Decimal operator*(<span class="keyword">const</span> Decimal&amp; lhs, <span class="keyword">const</span> Decimal&amp; rhs);</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> ICEBERG_EXPORT <span class="keyword">friend</span> Decimal operator/(<span class="keyword">const</span> Decimal&amp; lhs, <span class="keyword">const</span> Decimal&amp; rhs);</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> ICEBERG_EXPORT <span class="keyword">friend</span> Decimal operator%(<span class="keyword">const</span> Decimal&amp; lhs, <span class="keyword">const</span> Decimal&amp; rhs);</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> int128_t data_{0};</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span>};</div>
</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> </div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span>ICEBERG_EXPORT std::ostream&amp; operator&lt;&lt;(std::ostream&amp; os, <span class="keyword">const</span> Decimal&amp; <a class="code hl_function" href="group__type-factories.html#gaf9e64fe9d9556ef90130264f95b4d9f2">decimal</a>);</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span>} <span class="comment">// namespace iceberg</span></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html"><div class="ttname"><a href="classiceberg_1_1Decimal.html">iceberg::Decimal</a></div><div class="ttdoc">Represents 128-bit fixed-point decimal numbers. The max decimal precision that can be safely represen...</div><div class="ttdef"><b>Definition</b> decimal.h:46</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_a204b44d47eaf08b857ce0b134d6218e9"><div class="ttname"><a href="classiceberg_1_1Decimal.html#a204b44d47eaf08b857ce0b134d6218e9">iceberg::Decimal::operator&gt;&gt;</a></div><div class="ttdeci">Decimal operator&gt;&gt;(uint32_t shift) const</div><div class="ttdoc">Shift right by the given number of bits.</div><div class="ttdef"><b>Definition</b> decimal.h:129</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_a224e99c351e9183fe83cb132a01cbfb1"><div class="ttname"><a href="classiceberg_1_1Decimal.html#a224e99c351e9183fe83cb132a01cbfb1">iceberg::Decimal::operator&lt;=&gt;</a></div><div class="ttdeci">std::strong_ordering operator&lt;=&gt;(const Decimal &amp;other) const</div><div class="ttdoc">Spaceship operator for three-way comparison.</div><div class="ttdef"><b>Definition</b> decimal.h:183</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_a26a32345b2111f0e4be1ec85bfd5da46"><div class="ttname"><a href="classiceberg_1_1Decimal.html#a26a32345b2111f0e4be1ec85bfd5da46">iceberg::Decimal::low</a></div><div class="ttdeci">constexpr uint64_t low() const</div><div class="ttdoc">Get the low bits of the two's complement representation of the number.</div><div class="ttdef"><b>Definition</b> decimal.h:142</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_a39e113937ee4f3d9075904ca4c9b8cd5"><div class="ttname"><a href="classiceberg_1_1Decimal.html#a39e113937ee4f3d9075904ca4c9b8cd5">iceberg::Decimal::IsNegative</a></div><div class="ttdeci">bool IsNegative() const</div><div class="ttdoc">Check if the Decimal value is negative.</div><div class="ttdef"><b>Definition</b> decimal.h:205</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_a5e57a9033dc325933919ecf53bd60cbb"><div class="ttname"><a href="classiceberg_1_1Decimal.html#a5e57a9033dc325933919ecf53bd60cbb">iceberg::Decimal::Decimal</a></div><div class="ttdeci">constexpr Decimal(T value) noexcept</div><div class="ttdoc">Create a Decimal from any integer not wider than 64 bits.</div><div class="ttdef"><b>Definition</b> decimal.h:63</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_a875c00e32647b8d39e2a9bb77b3ae5d1"><div class="ttname"><a href="classiceberg_1_1Decimal.html#a875c00e32647b8d39e2a9bb77b3ae5d1">iceberg::Decimal::value</a></div><div class="ttdeci">constexpr int128_t value() const</div><div class="ttdoc">Get the underlying 128-bit integer representation of the number.</div><div class="ttdef"><b>Definition</b> decimal.h:136</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_ab025a97f157ee7ea1a2135ad34dbb2d2"><div class="ttname"><a href="classiceberg_1_1Decimal.html#ab025a97f157ee7ea1a2135ad34dbb2d2">iceberg::Decimal::high</a></div><div class="ttdeci">constexpr int64_t high() const</div><div class="ttdoc">Get the high bits of the two's complement representation of the number.</div><div class="ttdef"><b>Definition</b> decimal.h:139</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_ab78520099cf3c8365b5621c159fc2ff5"><div class="ttname"><a href="classiceberg_1_1Decimal.html#ab78520099cf3c8365b5621c159fc2ff5">iceberg::Decimal::ToString</a></div><div class="ttdeci">std::string ToString() const override</div><div class="ttdoc">Returns an integer string representation of the decimal value.</div><div class="ttdef"><b>Definition</b> decimal.h:153</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_ac6f8d5cc9231f35361dbf25003847c9a"><div class="ttname"><a href="classiceberg_1_1Decimal.html#ac6f8d5cc9231f35361dbf25003847c9a">iceberg::Decimal::Decimal</a></div><div class="ttdeci">constexpr Decimal(int64_t high, uint64_t low) noexcept</div><div class="ttdoc">Create a Decimal from two 64-bit integers.</div><div class="ttdef"><b>Definition</b> decimal.h:72</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_ad9a1babe945e8492c74448578af36225"><div class="ttname"><a href="classiceberg_1_1Decimal.html#ad9a1babe945e8492c74448578af36225">iceberg::Decimal::operator&lt;&lt;</a></div><div class="ttdeci">Decimal operator&lt;&lt;(uint32_t shift) const</div><div class="ttdoc">Shift left by the given number of bits.</div><div class="ttdef"><b>Definition</b> decimal.h:119</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_ae63e1b780e6ac1b118179901a0b2412a"><div class="ttname"><a href="classiceberg_1_1Decimal.html#ae63e1b780e6ac1b118179901a0b2412a">iceberg::Decimal::Decimal</a></div><div class="ttdeci">constexpr Decimal() noexcept=default</div><div class="ttdoc">Default constructor initializes to zero.</div></div>
<div class="ttc" id="aclassiceberg_1_1Decimal_html_af06c220ced2f385e745e9e37ccfe38f1"><div class="ttname"><a href="classiceberg_1_1Decimal.html#af06c220ced2f385e745e9e37ccfe38f1">iceberg::Decimal::Sign</a></div><div class="ttdeci">int64_t Sign() const</div><div class="ttdoc">Returns 1 if positive or zero, -1 if strictly negative.</div><div class="ttdef"><b>Definition</b> decimal.h:202</div></div>
<div class="ttc" id="aclassiceberg_1_1util_1_1Formattable_html"><div class="ttname"><a href="classiceberg_1_1util_1_1Formattable.html">iceberg::util::Formattable</a></div><div class="ttdoc">Interface for objects that can be formatted via std::format.</div><div class="ttdef"><b>Definition</b> formattable.h:36</div></div>
<div class="ttc" id="aendian_8h_html_aa051ea16b5c1c3d2c4b5c04db46ffa43"><div class="ttname"><a href="endian_8h.html#aa051ea16b5c1c3d2c4b5c04db46ffa43">iceberg::ToBigEndian</a></div><div class="ttdeci">constexpr T ToBigEndian(T value)</div><div class="ttdoc">Convert a value to big-endian format.</div><div class="ttdef"><b>Definition</b> endian.h:79</div></div>
<div class="ttc" id="aendian_8h_html_ad32cff8f6ada2e4ab2e0701f0a043f28"><div class="ttname"><a href="endian_8h.html#ad32cff8f6ada2e4ab2e0701f0a043f28">iceberg::FromBigEndian</a></div><div class="ttdeci">constexpr T FromBigEndian(T value)</div><div class="ttdoc">Convert a value from big-endian format.</div><div class="ttdef"><b>Definition</b> endian.h:89</div></div>
<div class="ttc" id="aformattable_8h_html"><div class="ttname"><a href="formattable_8h.html">formattable.h</a></div></div>
<div class="ttc" id="agroup__type-factories_html_gaf9e64fe9d9556ef90130264f95b4d9f2"><div class="ttname"><a href="group__type-factories.html#gaf9e64fe9d9556ef90130264f95b4d9f2">iceberg::decimal</a></div><div class="ttdeci">std::shared_ptr&lt; DecimalType &gt; decimal(int32_t precision, int32_t scale)</div><div class="ttdoc">Create a DecimalType with the given precision and scale.</div><div class="ttdef"><b>Definition</b> type.cc:380</div></div>
<div class="ttc" id="aint128_8h_html"><div class="ttname"><a href="int128_8h.html">int128.h</a></div><div class="ttdoc">128-bit integer type</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>