cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

User defined value type: changes in documentation and test case

Browse Source 
Changed the name of a function from `truncate` to `floor`, since that is more appropriate; updated
the inaccurate description on the rounding behaviour. Also modified the respective semantic test.
This commit is contained in:
hrkrshnn 2021-09-09 16:11:59 +02:00
parent 3e2e3d1baa
commit 952540c3b5
2 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/types/value-types.rst
View File

@ -676,8 +676,9 @@ type with 18 decimals and a minimal library to do arithmetic operations on the t
function mul(UFixed256x18 a, uint256 b) internal pure returns (UFixed256x18) { function mul(UFixed256x18 a, uint256 b) internal pure returns (UFixed256x18) {
return UFixed256x18.wrap(UFixed256x18.unwrap(a) * b); return UFixed256x18.wrap(UFixed256x18.unwrap(a) * b);
} }
/// Truncates UFixed256x18 to the nearest uint256 number. /// Take the floor of a UFixed256x18 number.
function truncate(UFixed256x18 a) internal pure returns (uint256) { /// @return the largest integer that does not exceed `a`.
function floor(UFixed256x18 a) internal pure returns (uint256) {
return UFixed256x18.unwrap(a) / multiplier; return UFixed256x18.unwrap(a) / multiplier;
} }
/// Turns a uint256 into a UFixed256x18 of the same value. /// Turns a uint256 into a UFixed256x18 of the same value.

28
test/libsolidity/semanticTests/userDefinedValueType/fixedpoint.sol
View File

@ -3,6 +3,7 @@ type UFixed256x18 is uint256;
/// A minimal library to do fixed point operations on UFixed256x18. /// A minimal library to do fixed point operations on UFixed256x18.
library FixedMath { library FixedMath {
uint constant multiplier = 10**18;
/// Adds two UFixed256x18 numbers. Reverts on overflow, relying on checked arithmetic on /// Adds two UFixed256x18 numbers. Reverts on overflow, relying on checked arithmetic on
/// uint256. /// uint256.
function add(UFixed256x18 a, UFixed256x18 b) internal returns (UFixed256x18) { function add(UFixed256x18 a, UFixed256x18 b) internal returns (UFixed256x18) {
@ -13,9 +14,15 @@ library FixedMath {
function mul(UFixed256x18 a, uint256 b) internal returns (UFixed256x18) { function mul(UFixed256x18 a, uint256 b) internal returns (UFixed256x18) {
return UFixed256x18.wrap(UFixed256x18.unwrap(a) * b); return UFixed256x18.wrap(UFixed256x18.unwrap(a) * b);
} }
/// Truncates UFixed256x18 to the nearest uint256 number. /// Take the floor of a UFixed256x18 number.
function truncate(UFixed256x18 a) internal returns (uint256) { /// @return the largest integer that does not exceed `a`.
return UFixed256x18.unwrap(a) / 10**18; function floor(UFixed256x18 a) internal returns (uint256) {
return UFixed256x18.unwrap(a) / multiplier;
}
/// Turns a uint256 into a UFixed256x18 of the same value.
/// Reverts if the integer is too large.
function toUFixed256x18(uint256 a) internal pure returns (UFixed256x18) {
return UFixed256x18.wrap(a * multiplier);
} }
} }
@ -26,8 +33,11 @@ contract TestFixedMath {
function mul(UFixed256x18 a, uint256 b) external returns (UFixed256x18) { function mul(UFixed256x18 a, uint256 b) external returns (UFixed256x18) {
return FixedMath.mul(a, b); return FixedMath.mul(a, b);
} }
function truncate(UFixed256x18 a) external returns (uint256) { function floor(UFixed256x18 a) external returns (uint256) {
return FixedMath.truncate(a); return FixedMath.floor(a);
}
function toUFixed256x18(uint256 a) external returns (UFixed256x18) {
return FixedMath.toUFixed256x18(a);
} }
} }
// ==== // ====
@ -38,5 +48,9 @@ contract TestFixedMath {
// add(uint256,uint256): 115792089237316195423570985008687907853269984665640564039457584007913129639935, 10 -> FAILURE, hex"4e487b71", 0x11 // add(uint256,uint256): 115792089237316195423570985008687907853269984665640564039457584007913129639935, 10 -> FAILURE, hex"4e487b71", 0x11
// mul(uint256,uint256): 340282366920938463463374607431768211456, 45671926166590716193865151022383844364247891968 -> FAILURE, hex"4e487b71", 0x11 // mul(uint256,uint256): 340282366920938463463374607431768211456, 45671926166590716193865151022383844364247891968 -> FAILURE, hex"4e487b71", 0x11
// mul(uint256,uint256): 340282366920938463463374607431768211456, 20 -> 6805647338418769269267492148635364229120 // mul(uint256,uint256): 340282366920938463463374607431768211456, 20 -> 6805647338418769269267492148635364229120
// truncate(uint256): 11579208923731619542357098500868790785326998665640564039457584007913129639930 -> 11579208923731619542357098500868790785326998665640564039457 // floor(uint256): 11579208923731619542357098500868790785326998665640564039457584007913129639930 -> 11579208923731619542357098500868790785326998665640564039457
// truncate(uint256): 115792089237316195423570985008687907853269984665640564039457584007913129639935 -> 115792089237316195423570985008687907853269984665640564039457 // floor(uint256): 115792089237316195423570985008687907853269984665640564039457584007913129639935 -> 115792089237316195423570985008687907853269984665640564039457
// toUFixed256x18(uint256): 0 -> 0
// toUFixed256x18(uint256): 5 -> 5000000000000000000
// toUFixed256x18(uint256): 115792089237316195423570985008687907853269984665640564039457 -> 115792089237316195423570985008687907853269984665640564039457000000000000000000
// toUFixed256x18(uint256): 115792089237316195423570985008687907853269984665640564039458 -> FAILURE, hex"4e487b71", 0x11