Files
rippled/tests_2libxrpl_2basics_2mulDiv_8cpp_source.html
2025-11-04 00:36:48 -08:00

143 lines
13 KiB
HTML

<!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>rippled: mulDiv.cpp 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">rippled
</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_d93a1d4020dea85bb71b237545b5e722.html">tests</a></li><li class="navelem"><a class="el" href="dir_0a321ebb528212eb1dfd6a585a956ad6.html">libxrpl</a></li><li class="navelem"><a class="el" href="dir_4d01398aeab125acfdb0b597d5e56fe9.html">basics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">tests/libxrpl/basics/mulDiv.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;xrpl/basics/mulDiv.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;doctest/doctest.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/limits.html">limits</a>&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">using namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a>;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span>TEST_CASE(<span class="stringliteral">&quot;mulDiv&quot;</span>)</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">auto</span> <span class="keyword">const</span> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/algorithm/max.html">max</a> = <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits/max.html">std::numeric_limits&lt;std::uint64_t&gt;::max</a>();</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> <span class="keyword">const</span> max32 = <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits/max.html">std::numeric_limits&lt;std::uint32_t&gt;::max</a>();</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">auto</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(85, 20, 5);</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> REQUIRE(result);</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 340);</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(20, 85, 5);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> REQUIRE(result);</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 340);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(0, max - 1, max - 3);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> REQUIRE(result);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 0);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(max - 1, 0, max - 3);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> REQUIRE(result);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 0);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(max, 2, max / 2);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> REQUIRE(result);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 4);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(max, 1000, max / 1000);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> REQUIRE(result);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 1000000);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(max, 1000, max / 1001);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> REQUIRE(result);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 1001000);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(max32 + 1, max32 + 1, 5);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> REQUIRE(result);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(*result == 3689348814741910323);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// Overflow</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> result = <a class="code hl_function" href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">mulDiv</a>(max - 1, max - 2, 5);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_enumvalue" href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">CHECK</a>(!result);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>}</div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a></div></div>
<div class="ttc" id="alimits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/limits.html">limits</a></div></div>
<div class="ttc" id="amax_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/max.html">std::max</a></div><div class="ttdeci">T max(T... args)</div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089"><div class="ttname"><a href="namespaceripple.html#a22768e0a41b646442c98d38f2f2a307ba8c46d8d9d3402788403e2f6911153089">ripple::LedgerNameSpace::CHECK</a></div><div class="ttdeci">@ CHECK</div></div>
<div class="ttc" id="anamespaceripple_html_ad012d6a36cd38b19ab4d8b47521fbd5f"><div class="ttname"><a href="namespaceripple.html#ad012d6a36cd38b19ab4d8b47521fbd5f">ripple::mulDiv</a></div><div class="ttdeci">std::optional&lt; std::uint64_t &gt; mulDiv(std::uint64_t value, std::uint64_t mul, std::uint64_t div)</div><div class="ttdoc">Return value*mul/div accurately.</div><div class="ttdef"><b>Definition</b> <a href="libxrpl_2basics_2mulDiv_8cpp_source.html#l00013">libxrpl/basics/mulDiv.cpp:13</a></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>