infrastructure-upgrade/coverage/v2/libraries/FixedPoint.sol.gcov.html
AlienTornadosaurusHex 1a6a4ebfbb mostly testing finalized design
Signed-off-by: AlienTornadosaurusHex <>
2023-06-20 21:04:29 +00:00

149 lines
9.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LCOV - lcov.info - v2/libraries/FixedPoint.sol</title>
<link rel="stylesheet" type="text/css" href="../../gcov.css">
</head>
<body>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="title">LCOV - code coverage report</td></tr>
<tr><td class="ruler"><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
<tr>
<td width="100%">
<table cellpadding=1 border=0 width="100%">
<tr>
<td width="10%" class="headerItem">Current view:</td>
<td width="35%" class="headerValue"><a href="../../index.html">top level</a> - <a href="index.html">v2/libraries</a> - FixedPoint.sol<span style="font-size: 80%;"> (source / <a href="FixedPoint.sol.func-sort-c.html">functions</a>)</span></td>
<td width="5%"></td>
<td width="15%"></td>
<td width="10%" class="headerCovTableHead">Hit</td>
<td width="10%" class="headerCovTableHead">Total</td>
<td width="15%" class="headerCovTableHead">Coverage</td>
</tr>
<tr>
<td class="headerItem">Test:</td>
<td class="headerValue">lcov.info</td>
<td></td>
<td class="headerItem">Lines:</td>
<td class="headerCovTableEntry">0</td>
<td class="headerCovTableEntry">11</td>
<td class="headerCovTableEntryLo">0.0 %</td>
</tr>
<tr>
<td class="headerItem">Date:</td>
<td class="headerValue">2023-06-20 21:04:08</td>
<td></td>
<td class="headerItem">Functions:</td>
<td class="headerCovTableEntry">0</td>
<td class="headerCovTableEntry">7</td>
<td class="headerCovTableEntryLo">0.0 %</td>
</tr>
<tr>
<td class="headerItem">Legend:</td>
<td class="headerValueLeg"> Lines:
<span class="coverLegendCov">hit</span>
<span class="coverLegendNoCov">not hit</span>
</td>
<td></td>
</tr>
<tr><td><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
</table>
</td>
</tr>
<tr><td class="ruler"><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
</table>
<table cellpadding=0 cellspacing=0 border=0>
<tr>
<td><br></td>
</tr>
<tr>
<td>
<pre class="sourceHeading"> Line data Source code</pre>
<pre class="source">
<a name="1"><span class="lineNum"> 1 </span> : // SPDX-License-Identifier: MIT</a>
<a name="2"><span class="lineNum"> 2 </span> : </a>
<a name="3"><span class="lineNum"> 3 </span> : pragma solidity ^0.6.12;</a>
<a name="4"><span class="lineNum"> 4 </span> : pragma experimental ABIEncoderV2;</a>
<a name="5"><span class="lineNum"> 5 </span> : </a>
<a name="6"><span class="lineNum"> 6 </span> : library FixedPoint {</a>
<a name="7"><span class="lineNum"> 7 </span> : // range: [0, 2**112 - 1]</a>
<a name="8"><span class="lineNum"> 8 </span> : // resolution: 1 / 2**112</a>
<a name="9"><span class="lineNum"> 9 </span> : struct uq112x112 {</a>
<a name="10"><span class="lineNum"> 10 </span> : uint224 _x;</a>
<a name="11"><span class="lineNum"> 11 </span> : }</a>
<a name="12"><span class="lineNum"> 12 </span> : </a>
<a name="13"><span class="lineNum"> 13 </span> : // range: [0, 2**144 - 1]</a>
<a name="14"><span class="lineNum"> 14 </span> : // resolution: 1 / 2**112</a>
<a name="15"><span class="lineNum"> 15 </span> : struct uq144x112 {</a>
<a name="16"><span class="lineNum"> 16 </span> : uint256 _x;</a>
<a name="17"><span class="lineNum"> 17 </span> : }</a>
<a name="18"><span class="lineNum"> 18 </span> : </a>
<a name="19"><span class="lineNum"> 19 </span> : uint8 private constant RESOLUTION = 112;</a>
<a name="20"><span class="lineNum"> 20 </span> : </a>
<a name="21"><span class="lineNum"> 21 </span> : // encode a uint112 as a UQ112x112</a>
<a name="22"><span class="lineNum"> 22 </span> : function encode(uint112 x) internal pure returns (uq112x112 memory) {</a>
<a name="23"><span class="lineNum"> 23 </span><span class="lineNoCov"> 0 : return uq112x112(uint224(x) &lt;&lt; RESOLUTION);</span></a>
<a name="24"><span class="lineNum"> 24 </span> : }</a>
<a name="25"><span class="lineNum"> 25 </span> : </a>
<a name="26"><span class="lineNum"> 26 </span> : // encodes a uint144 as a UQ144x112</a>
<a name="27"><span class="lineNum"> 27 </span> : function encode144(uint144 x) internal pure returns (uq144x112 memory) {</a>
<a name="28"><span class="lineNum"> 28 </span><span class="lineNoCov"> 0 : return uq144x112(uint256(x) &lt;&lt; RESOLUTION);</span></a>
<a name="29"><span class="lineNum"> 29 </span> : }</a>
<a name="30"><span class="lineNum"> 30 </span> : </a>
<a name="31"><span class="lineNum"> 31 </span> : // divide a UQ112x112 by a uint112, returning a UQ112x112</a>
<a name="32"><span class="lineNum"> 32 </span> : function div(uq112x112 memory self, uint112 x) internal pure returns (uq112x112 memory) {</a>
<a name="33"><span class="lineNum"> 33 </span><span class="lineNoCov"> 0 : require(x != 0, &quot;FixedPoint: DIV_BY_ZERO&quot;);</span></a>
<a name="34"><span class="lineNum"> 34 </span><span class="lineNoCov"> 0 : return uq112x112(self._x / uint224(x));</span></a>
<a name="35"><span class="lineNum"> 35 </span> : }</a>
<a name="36"><span class="lineNum"> 36 </span> : </a>
<a name="37"><span class="lineNum"> 37 </span> : // multiply a UQ112x112 by a uint, returning a UQ144x112</a>
<a name="38"><span class="lineNum"> 38 </span> : // reverts on overflow</a>
<a name="39"><span class="lineNum"> 39 </span> : function mul(uq112x112 memory self, uint256 y) internal pure returns (uq144x112 memory) {</a>
<a name="40"><span class="lineNum"> 40 </span><span class="lineNoCov"> 0 : uint256 z;</span></a>
<a name="41"><span class="lineNum"> 41 </span><span class="lineNoCov"> 0 : require(</span></a>
<a name="42"><span class="lineNum"> 42 </span> : y == 0 || (z = uint256(self._x) * y) / y == uint256(self._x),</a>
<a name="43"><span class="lineNum"> 43 </span> : &quot;FixedPoint: MULTIPLICATION_OVERFLOW&quot;</a>
<a name="44"><span class="lineNum"> 44 </span> : );</a>
<a name="45"><span class="lineNum"> 45 </span><span class="lineNoCov"> 0 : return uq144x112(z);</span></a>
<a name="46"><span class="lineNum"> 46 </span> : }</a>
<a name="47"><span class="lineNum"> 47 </span> : </a>
<a name="48"><span class="lineNum"> 48 </span> : // returns a UQ112x112 which represents the ratio of the numerator to the denominator</a>
<a name="49"><span class="lineNum"> 49 </span> : // equivalent to encode(numerator).div(denominator)</a>
<a name="50"><span class="lineNum"> 50 </span> : function fraction(uint112 numerator, uint112 denominator) internal pure returns (uq112x112 memory) {</a>
<a name="51"><span class="lineNum"> 51 </span><span class="lineNoCov"> 0 : require(denominator &gt; 0, &quot;FixedPoint: DIV_BY_ZERO&quot;);</span></a>
<a name="52"><span class="lineNum"> 52 </span><span class="lineNoCov"> 0 : return uq112x112((uint224(numerator) &lt;&lt; RESOLUTION) / denominator);</span></a>
<a name="53"><span class="lineNum"> 53 </span> : }</a>
<a name="54"><span class="lineNum"> 54 </span> : </a>
<a name="55"><span class="lineNum"> 55 </span> : // decode a UQ112x112 into a uint112 by truncating after the radix point</a>
<a name="56"><span class="lineNum"> 56 </span> : function decode(uq112x112 memory self) internal pure returns (uint112) {</a>
<a name="57"><span class="lineNum"> 57 </span><span class="lineNoCov"> 0 : return uint112(self._x &gt;&gt; RESOLUTION);</span></a>
<a name="58"><span class="lineNum"> 58 </span> : }</a>
<a name="59"><span class="lineNum"> 59 </span> : </a>
<a name="60"><span class="lineNum"> 60 </span> : // decode a UQ144x112 into a uint144 by truncating after the radix point</a>
<a name="61"><span class="lineNum"> 61 </span> : function decode144(uq144x112 memory self) internal pure returns (uint144) {</a>
<a name="62"><span class="lineNum"> 62 </span><span class="lineNoCov"> 0 : return uint144(self._x &gt;&gt; RESOLUTION);</span></a>
<a name="63"><span class="lineNum"> 63 </span> : }</a>
<a name="64"><span class="lineNum"> 64 </span> : }</a>
</pre>
</td>
</tr>
</table>
<br>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="ruler"><img src="../../glass.png" width=3 height=3 alt=""></td></tr>
<tr><td class="versionInfo">Generated by: <a href="https://github.com/linux-test-project/lcov" target="_parent">LCOV version 1.16</a></td></tr>
</table>
<br>
</body>
</html>