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

YulUtilFuncs: Add missing/adjust existing documentation

Browse Source
This commit is contained in:
Mathias Baumann 2019-06-13 17:31:38 +02:00
parent 910cb8d329
commit b03cb2bce6
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
libsolidity/codegen/YulUtilFunctions.h
View File

@ -78,9 +78,10 @@ public:
std::string shiftRightFunction(size_t _numBits); std::string shiftRightFunction(size_t _numBits);
std::string shiftRightFunctionDynamic(); std::string shiftRightFunctionDynamic();
/// @returns the name of a function f(value, toInsert) -> newValue which replaces the /// @returns the name of a function which replaces the
/// _numBytes bytes starting at byte position _shiftBytes (counted from the least significant /// _numBytes bytes starting at byte position _shiftBytes (counted from the least significant
/// byte) by the _numBytes least significant bytes of `toInsert`. /// byte) by the _numBytes least significant bytes of `toInsert`.
/// signature: (value, toInsert) -> result
std::string updateByteSliceFunction(size_t _numBytes, size_t _shiftBytes); std::string updateByteSliceFunction(size_t _numBytes, size_t _shiftBytes);
/// signature: (value, shiftBytes, toInsert) -> result /// signature: (value, shiftBytes, toInsert) -> result
@ -88,10 +89,13 @@ public:
/// @returns the name of a function that rounds its input to the next multiple /// @returns the name of a function that rounds its input to the next multiple
/// of 32 or the input if it is a multiple of 32. /// of 32 or the input if it is a multiple of 32.
/// signature: (value) -> result
std::string roundUpFunction(); std::string roundUpFunction();
/// signature: (x, y) -> sum
std::string overflowCheckedUIntAddFunction(size_t _bits); std::string overflowCheckedUIntAddFunction(size_t _bits);
/// signature: (x, y) -> product
std::string overflowCheckedUIntMulFunction(size_t _bits); std::string overflowCheckedUIntMulFunction(size_t _bits);
/// @returns name of function to perform division on integers. /// @returns name of function to perform division on integers.
@ -101,8 +105,12 @@ public:
/// @returns computes the difference between two values. /// @returns computes the difference between two values.
/// Assumes the input to be in range for the type. /// Assumes the input to be in range for the type.
/// signature: (x, y) -> diff
std::string overflowCheckedUIntSubFunction(); std::string overflowCheckedUIntSubFunction();
/// @returns the name of a function that fetches the length of the given
/// array
/// signature: (array) -> length
std::string arrayLengthFunction(ArrayType const& _type); std::string arrayLengthFunction(ArrayType const& _type);
/// @returns the name of a function that resizes a storage array /// @returns the name of a function that resizes a storage array